文档首页/ 云消息服务 KooMessage/ API参考/ API/ 智能信息回执/ 注册智能信息回执URL
更新时间：2024-11-22 GMT+08:00
查看PDF
分享

注册智能信息回执URL

功能介绍

用户根据要求创建回执接口后，可以调用此接口进行注册，注意：此接口仅允许te_admin角色用户调用。

URI

POST /v1/aim/callbacks

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

最小长度：0

最大长度：2000

Content-Type

是

String

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

参数

是否必选

参数类型

描述

callback_url

是

String

回调地址。

说明：

  • 必须http或https开头，建议使用https

  • 支持域名或公网IP回调地址，不支持私网IP回调地址

最小长度：1

最大长度：1000

url_type

否

Integer

回调类型。

  • 0：智能信息单条发送回调

  • 1：模板状态回调

  • 2：智能信息批量发送回调

缺省值：0

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

data

Callback object

注册详情。

status

String

请求状态，固定200。

message

String

状态描述。
表4 Callback

参数

参数类型

描述

callback_url

String

回调地址。

id

String

注册回调的唯一标识ID。

url_type

Integer

回调类型。

  • 0：智能信息单条发送回调

  • 1：模板状态回调

  • 2：智能信息批量发送回调

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

结果状态码。

error_msg

String

结果详情。

error_message

Object

结果详情。

说明：

该字段在以后可能会废弃，建议使用error_msg字段对接。

状态码： 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

结果状态码。

error_msg

String

结果详情。

error_message

Object

结果详情。

说明：

该字段在以后可能会废弃，建议使用error_msg字段对接。

请求示例

  • 注册回执-智能信息单条发送回执

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

{
  "callback_url" : "https://www.example.com/v1/send-resolve-status",
  "url_type" : 0
}

  • 注册回执-智能信息模板状态回执

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

{
  "callback_url" : "https://www.example.com/v1/template-status",
  "url_type" : 1
}

  • 注册回执-智能信息批量发送回执

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

{
  "callback_url" : "https://www.example.com/v1/send-resolve-status",
  "url_type" : 2
}

响应示例

状态码： 200

返回信息。

{
  "status" : "200",
  "message" : "success",
  "data" : {
    "id" : "18d1bcad-4d13-4db1-bcdd-32565457cccc",
    "callback_url" : "https://www.example.com/v1/send-resolve-status"
  }
}

状态码

状态码

描述

200

返回信息。

400

非法参数。

500

内部错误。

错误码

请参见错误码。

父主题： 智能信息回执

相关文档