QueryRCSMobileCapable - 批量查询终端5G适配情况-短信服务(SMS)-阿里云帮助中心

接口说明

前提条件

已通过 UpgradeToRCSSignature 接口将文本短信签名升级为 5G 消息签名。
已通过 CreateRCSTemplate 接口创建 5G 消息模板。

使用说明

查询结果在接口中同步返回。
单次最多查询 100 个手机号，多个手机号用英文逗号分隔。
返回结果包含支持、不支持、未知、无效四类手机号列表。

QPS 限制

本接口的单用户 QPS 限制为 5 次/秒。超过限制，API 调用将会被限流，这可能会影响您的业务，请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
SignName	string	是	短信签名名称。	阿里云5G消息
TemplateCode	string	是	模板 Code。	RCS_SMS_10001052
PhoneNumbers	string	是	需要查询的手机号列表。仅支持 11 位手机号，不带区号。多个手机号用英文逗号分隔，最多支持 100 个手机号。	18868100001,18868100002,18868100003

返回参数

名称	类型	描述	示例值
	object
AccessDeniedDetail	string	访问被拒绝时返回的详细信息。	None
RequestId	string	本次请求的 ID。	A90E4451-FED7-49D2-87C8-00700A8C4D0D
Message	string	状态码的描述。	OK
Data	object	返回数据，具体请参见下方 Data 返回数据结构说明。
Code	string	请求状态码。返回 OK 代表请求成功。	OK
Success	boolean	是否调用成功。 true：调用成功。 false：调用失败。	true

Data 返回数据结构说明

Data 为终端 5G 适配情况查询结果，四个列表互斥，每个手机号只会出现在其中一个列表中：

字段	类型	描述	示例
Supported	Array	支持发送 5G 消息的手机号列表	["18868100001","18868100002"]
NotSupported	Array	不支持发送 5G 消息的手机号列表	["18868100003"]
Unknown	Array	无法确认是否支持 5G 消息的手机号列表	["18868100004"]
Invalid	Array	无效的手机号列表	["188681000"]

返回示例

{
  "Code": "OK",
  "RequestId": "A90E4451-FED7-49D2-87C8-00700A8C4D0D",
  "Success": true,
  "Data": {
    "Supported": ["18868100001", "18868100002"],
    "NotSupported": ["18868100003"],
    "Unknown": ["18868100004"],
    "Invalid": ["188681000"]
  }
}

示例

正常返回示例

JSON格式

{
  "AccessDeniedDetail": "None",
  "RequestId": "A90E4451-FED7-49D2-87C8-00700A8C4D0D",
  "Message": "OK",
  "Data": {
    "test": "test",
    "test2": 1
  },
  "Code": "OK",
  "Success": true
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。