查询终端5G适配情况任务结果。
接口说明
调用 QueryRCSMobileCapableTaskResult 接口查询异步任务的执行结果。
使用说明
通过 CreateRCSMobileCapableTask 创建任务后,使用此接口轮询结果。
当 Finished=true 时,表示任务执行完毕,结果以 base64 编码的 txt 文件返回。
任务在至多 1 小时内完成。
QPS 限制
本接口的单用户 QPS 限制为 50 次/秒。超过限制,API 调用将会被限流,请合理使用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| TaskId |
string |
是 |
任务 ID。通过 CreateRCSMobileCapableTask 接口创建任务时返回。 |
RCS_MOBILE_123***123 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| AccessDeniedDetail |
string |
访问被拒绝时返回的详细信息。 |
None |
| RequestId |
string |
请求 ID。 |
A90E4451-FED7-49D2-87C8-00700A8C4D0D |
| Message |
string |
状态码的描述。 |
OK |
| Data |
object |
返回数据,具体请参见下方 Data 返回数据结构说明。 |
{ "Finished": true, "Supported": "MTg4Njg**************jgxMDAwMDM=", "NotSupported": "", "Unknown": "", "Invalid": "" } |
| Code |
string |
请求状态码。OK 代表请求成功。 |
OK |
| Success |
boolean |
请求是否成功。 |
true |
Data 返回数据结构说明
Data 为任务执行结果,包含以下字段。四个手机号文件字段仅当 Finished 为 true 时有值,内容为 txt 文件的 base64 编码,文件无表头,每一行一个手机号,若无手机号则文件内容为空:
| 字段 | 类型 | 描述 | 示例 |
| Finished | Boolean | 任务是否执行完毕。取值: - true:执行完毕。 - false:执行中。 | true |
| Supported | String | 支持发送 5G 消息的手机号文件 | 见下方返回示例 |
| NotSupported | String | 不支持发送 5G 消息的手机号文件 | 见下方返回示例 |
| Unknown | String | 无法确认是否支持 5G 消息的手机号文件 | 见下方返回示例 |
| Invalid | String | 无效的手机号文件 | 见下方返回示例 |
返回示例
示例中的 base64 编码解码后为三行手机号,即 18868100001、18868100002、18868100003 各占一行:
{
"Code": "OK",
"RequestId": "A90E4451-FED7-49D2-87C8-00700A8C4D0D",
"Success": true,
"Data": {
"Finished": true,
"Supported": "MTg4NjgxMDAwMDEKMTg4NjgxMDAwMDIKMTg4NjgxMDAwMDM=",
"NotSupported": "",
"Unknown": "",
"Invalid": ""
}
}
示例
正常返回示例
JSON格式
{
"AccessDeniedDetail": "None",
"RequestId": "A90E4451-FED7-49D2-87C8-00700A8C4D0D",
"Message": "OK",
"Data": {
"Finished": true,
"Supported": "MTg4Njg**************jgxMDAwMDM=",
"NotSupported": "",
"Unknown": "",
"Invalid": ""
},
"Code": "OK",
"Success": true
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。