文档首页/ 云消息服务 KooMessage/ API参考/ API/ 智能信息解析/ 查询手机号智能信息解析能力
更新时间：2024-11-22 GMT+08:00
查看PDF
分享

查询手机号智能信息解析能力

功能介绍

用户在下发智能信息前，通过此接口批量查询对应手机的智能信息解析能力。

URI

POST /v1/aim/mobile-capabilities/check

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

Content-Type

是

String

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

参数

是否必选

参数类型

描述

mobiles

是

Array of strings

待查询的手机号码，一次最多请求100个。

说明：

不加密时，参数可传入纯手机号或国家码加手机号，国家码不带“+”号，例如国内手机号“1310000”，参数可传入“1310000”、“861310000”、“00861310000”。使用SHA1加密，mobiles传入号码国家码与手机号码的SHA1算法后的摘要，国家码格式为纯数字，不带“+”，去掉前面的0，例如国内手机号“1310000”，使用“861310000”进行SHA1加密。

最小长度：1

最大长度：40

数组长度：1 - 100

tpl_id

否

String

智能信息模板ID，由9位数字组成。

说明：

  • 填写时，根据该模板所支持的厂商返回手机终端展示智能信息的能力状态

  • 不填则返回手机终端在所有厂商展示智能信息的能力状态

最小长度：0

最大长度：32

encryption_alg

否

String

加密类型。

  • NONE：不加密

  • SHA1：使用SHA1加密算法加密

说明：

默认为NONE。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

supported_mobiles

Array of strings

支持智能信息手机号码列表。

unsupported_mobiles

Array of strings

不支持智能信息手机号码列表。

tpl_id

String

智能信息模板ID，由9位数字组成。

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

结果状态码。

error_msg

String

结果详情。

error_message

Object

结果详情。

说明：

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

状态码： 500

表5 响应Body参数

参数

参数类型

描述

error_code

String

结果状态码。

error_msg

String

结果详情。

error_message

Object

结果详情。

说明：

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

请求示例

  • 检查手机号智能信息解析能力-原始手机号。模板ID为"600000001"，手机号码不加密。

    https://koomessage.myhuaweicloud.cn/v1/aim/mobile-capabilities/check

{
  "mobiles" : [ "131****0000", "131****0001" ],
  "encryption_alg" : "NONE",
  "tpl_id" : "600000001"
}

  • 检查手机号智能信息解析能力-SHA1加密。模板ID为"600000001"，加密方式为"SHA1"。

    https://koomessage.myhuaweicloud.cn/v1/aim/mobile-capabilities/check

{
  "mobiles" : [ "de005a80a77f52080d7c67c65ba8663e5b0f0be1", "1837ec7308eb38494fda35da8a34038ab7533e6a" ],
  "encryption_alg" : "SHA1",
  "tpl_id" : "600000001"
}

响应示例

状态码： 200

返回信息。

{
  "supported_mobiles" : [ "131****0000" ],
  "unsupported_mobiles" : [ "131****0001" ],
  "tpl_id" : "600000001"
}

状态码

状态码

描述

200

返回信息。

400

非法参数。

500

内部错误。

错误码

请参见错误码。

父主题： 智能信息解析

相关文档