文档首页/云消息服务 KooMessage/API参考/API/智能信息服务号通道号/注册通道号
更新时间：2025-01-06 GMT+08:00
查看PDF
分享

注册通道号

功能介绍

注册通道号。

URI

POST /v1/aim-sa/ports

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

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

Content-Type

是

String

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

表2 请求Body参数

参数

是否必选

参数类型

描述

port

是

String

通道号。

  • port_type=5时 ，长度必须为5

  • port_type=1或3，长度在21位内

最小长度：0

最大长度：21

port_type

是

Integer

通道号类型。

  • 1：普通

  • 3：前缀号段

  • 5：后缀号段

最小值：1

最大值：5

sign

是

Array of strings

签名列表，最大长度为5。单个签名长度为2-18。

最小长度：2

最大长度：18

数组长度：0 - 5

sign_check

是

Integer

是否需要校验。

  • 0：不校验

  • 1：校验签名

说明：

当port_type为3或者5时，sign_check必须为1。

最小值：0

最大值：1

authorization_files

是

Array of strings

授权证明图片资源，支持jpg、bmp、png和jpeg格式，全部图片总大小不超过4M，最多支持5张。参数格式为：资源ID:资源URL，样例：3d214a61672846f88ad77597f935cccc:AimSauploadService/272957b708ac4891a6d5282ccd2175cccc.png。

说明：

资源ID与资源URL对应上传智能信息服务号图片资源API返回的resource_id和resource_url。

数组长度：0 - 5

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

data

PortRegisterResponse object

注册通道号响应体。

表4 PortRegisterResponse

参数

参数类型

描述

data

RegisterResult object

返回体。

表5 RegisterResult

参数

参数类型

描述

port

String

通道号。

port_type

Integer

通道号类型。

  • 1：普通

  • 3：前缀号段

  • 5：后缀号段

sign

Array of strings

签名列表，最大长度为5。

数组长度：0 - 5

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

结果详情。

状态码： 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

结果详情。

请求示例

注册智能信息服务号通道号。设置通道号为"8822053111111"，普通类型，不校验签名。

https://koomessage.myhuaweicloud.cn/v1/aim-sa/ports

{
  "port" : "8822053111111",
  "sign" : [ "华为云KooMessage" ],
  "port_type" : 1,
  "sign_check" : 0,
  "authorization_files" : [ "3d214a61672846f88ad77597f935cccc:AimSauploadService/272957b708ac4891a6d5282ccd2175cccc.png" ]
}

响应示例

状态码： 200

返回信息。

{
  "data" : {
    "data" : {
      "port" : "8822053111111",
      "port_type" : 1,
      "sign" : [ "华为云KooMessage" ]
    }
  }
}

状态码

状态码

描述

200

返回信息。

400

非法参数。

500

内部错误。

错误码

请参见错误码。

相关文档