创建终端5G适配情况查询任务(异步)。
接口说明
调用 CreateRCSMobileCapableTask 接口创建终端 5G 适配情况查询任务。
使用说明
任务提交接口最高 QPS 为 5,单次最多提交 10 万个手机号。
提交后需通过 QueryRCSMobileCapableTaskResult 接口异步轮询结果。
任务在至多 1 小时内完成查询。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| PhoneNumbersFile |
string |
是 |
需要查询的手机号 txt 文件。使用 txt 文件的 base64 编码提交,仅支持 11 位手机号,不带区号,文件无表头,每一行一个手机号,单文件最多支持 10 万个手机号。 |
MTg4********************DIKMTg4NjgxMDAwMDM= |
| SignName |
string |
是 |
短信签名名称。 |
阿里云5G消息 |
| TemplateCode |
string |
是 |
模板 Code。 |
RCS_SMS_100***52 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| AccessDeniedDetail |
string |
访问被拒绝详细信息。 |
None |
| RequestId |
string |
请求 ID。 |
A90E4451-FED7-49D2-87C8-00700A8C4D0D |
| Message |
string |
状态码的描述。 |
OK |
| Data |
object |
返回数据,具体请参见下方 Data 返回数据结构说明。 |
{ "TaskID": "RCS_MOBILE_123***123" } |
| Code |
string |
请求状态码。OK 代表请求成功。 |
OK |
| Success |
boolean |
请求是否成功。 |
true |
Data 返回数据结构说明
Data 为任务创建结果,包含以下字段:
| 字段 | 类型 | 描述 | 示例 |
| TaskID | String | 任务 ID。任务提交后异步执行,通过 QueryRCSMobileCapableTaskResult 接口传入该 ID 查询任务结果 | RCS_MOBILE_123410123 |
返回示例
{
"Code": "OK",
"RequestId": "A90E4451-FED7-49D2-87C8-00700A8C4D0D",
"Success": true,
"Data": {
"TaskID": "RCS_MOBILE_123410123"
}
}
示例
正常返回示例
JSON格式
{
"AccessDeniedDetail": "None",
"RequestId": "A90E4451-FED7-49D2-87C8-00700A8C4D0D",
"Message": "OK",
"Data": {
"TaskID": "RCS_MOBILE_123***123"
},
"Code": "OK",
"Success": true
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。