文档首页/ 云消息服务 KooMessage/ API参考/ API/ 智能信息基础版发送/ 查询用户已注册智能信息基础版回执接口
更新时间：2024-11-22 GMT+08:00
查看PDF
分享

查询用户已注册智能信息基础版回执接口

功能介绍

查询所有已注册的智能信息基础版回执接口。

URI

GET /v1/aim-basic/callbacks

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

最小长度：0

最大长度：2000

响应参数

状态码： 200

表2 响应Body参数

参数

参数类型

描述

status

String

请求状态，固定200。

message

String

状态描述。

data

VmsCallBackList object

响应数据。
表3 VmsCallBackList

参数

参数类型

描述

callbacks

Array of VmsCallBack objects

回执接口列表。
表4 VmsCallBack

参数

参数类型

描述

url_type

Integer

回调类型。

  • 0：发送状态回执

  • 1：上行消息回执

callback_url

String

回调地址。

remark

String

备注。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

结果状态码。

error_msg

String

结果详情。

状态码： 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

结果状态码。

error_msg

String

结果详情。

请求示例

查询已注册智能信息基础版回执接口

https://koomessage.myhuaweicloud.cn/v1/aim-basic/callbacks

响应示例

状态码： 200

返回信息。

{
  "status" : "200",
  "message" : "success",
  "data" : {
    "callbacks" : [ {
      "url_type" : 1,
      "callback_url" : " https://www.example.com/vms/reply-callback",
      "remark" : "上行消息回执"
    }, {
      "url_type" : 0,
      "callback_url" : " https://www.example.com/vms/send-callback",
      "remark" : "发送状态回执"
    } ]
  }
}

状态码

状态码

描述

200

返回信息。

400

非法参数。

500

内部错误。

错误码

请参见错误码。

相关文档