一、1. 接口描述
查询单状态
默认接口请求频率限制:20次/秒。
二、2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
| Action | 是 | String | 公共参数,本接口取值:DescribeCarrierPrivilegeNumberApplicants。 |
| Version | 是 | String | 公共参数,本接口取值:2020-02-10。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| SdkAppId | 是 | Integer | 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc示例值:1400000000 |
| PageNumber | 否 | Integer | 默认0,从0开始示例值:0 |
| PageSize | 否 | Integer | 默认10,最大100示例值:10 |
| Filters.N | 否 | Array of Filter | 筛选条件,Name支持ApplicantId,PhoneNumber(按号码模糊查找)示例值:[{"Name":"ApplicantId", "Values":"1"}] |
三、3. 输出参数
| 参数名称 | 类型 | 描述 |
| TotalCount | Integer | 筛选出的总申请单数量示例值:13 |
| Applicants | Array of CarrierPrivilegeNumberApplicant | 申请单列表示例值:[{"SdkAppId":1400000000,"ApplicantId":3,"Callers":["008601012345678"],"Callees":["008618612345678"],"State":1,"CreateTime":1623145120,"UpdateTime":1623145120}] |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
四、示例1 查询申请单
查询申请单
五、输入示例
POST / HTTP/1.1
Host: ccc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCarrierPrivilegeNumberApplicants
<公共请求参数>
{
"SdkAppId": 14000000
}
六、输出示例
{
"Response": {
"RequestId": "xnasdlgfas",
"TotalCount": 1,
"Applicants": [
{
"SdkAppId": 1400000000,
"ApplicantId": 3,
"Callers": [
"008601012345678"
],
"Callees": [
"008618612345678"
],
"State": 1,
"Description": "foobar",
"CreateTime": 1623145120,
"UpdateTime": 1623145120
}
]
}
}
七、腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便你从同一入口查询及使用腾讯云提供的所有 API 服务。
八、API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
九、SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
·Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
十、命令行工具
·Tencent Cloud CLI 3.0
十一、6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。