文档首页/ 云消息服务 KooMessage/ API参考/ API/ 智能信息基础版发送/ 注册智能信息基础版回执URL
更新时间：2025-01-06 GMT+08:00
查看PDF
分享

注册智能信息基础版回执URL

功能介绍

用户根据要求创建智能信息基础版回执接口后，可以调用此接口进行注册。

URI

POST /v1/aim-basic/callbacks

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

最小长度：0

最大长度：2000

Content-Type

是

String

请求体参数类型，该字段必须设置为：application/json。
表2 请求Body参数

参数

是否必选

参数类型

描述

url_type

是

Integer

回调类型。

  • 0：发送状态回执

  • 1：上行消息回执

callback_url

是

String

回调地址，必须是http或https开头的字符串，不能为空。

说明：

建议使用https。

最小长度：1

最大长度：1000

remark

否

String

备注。

最小长度：0

最大长度：1000

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

status

String

请求状态，固定200。

message

String

状态描述。

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

结果状态码。

error_msg

String

结果详情。

状态码： 500

表5 响应Body参数

参数

参数类型

描述

error_code

String

结果状态码。

error_msg

String

结果详情。

请求示例

注册智能信息基础版发送状态回执接口

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

{
  "url_type" : 0,
  "callback_url" : "https://www.example.com/vms/send-callback",
  "remark" : "发送状态回执"
}

响应示例

状态码： 200

返回信息。

{
  "status" : "200",
  "message" : "success"
}

状态码

状态码

描述

200

返回信息。

400

非法参数。

500

内部错误。

错误码

请参见错误码。

相关文档