短信号码信息查询-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： sms.tencentcloudapi.com 。

本接口 (DescribePhoneNumberInfo) 用于提供电话号码的信息查询，包括国家（或地区）码、规范的 E.164 格式号码等。

例如：查询号码 +86018501234444，可以得到国家码 86、规范的 E.164 号码 +8618501234444 等信息。

默认接口请求频率限制：1000次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribePhoneNumberInfo。
Version	是	String	公共参数，本接口取值：2021-01-11。
Region	是	String	公共参数，详见产品支持的地域列表。
PhoneNumberSet.N	是	Array of String	查询手机号码，采用 E.164 标准，格式为+[国家或地区码][手机号]，单次请求最多支持200个手机号。例如：+8618501234444，其中前面有一个+号，86为国家码，18501234444为手机号。示例值：["+8618501234444"]

3. 输出参数

参数名称	类型	描述
PhoneNumberInfoSet	Array of PhoneNumberInfo	获取号码信息。示例值：[{"SubscriberNumber":"18501234444", "Message":"Describe success", "Code":"Ok", "PhoneNumber":"+8618501234444", "IsoCode":"CN", "IsoName":"China", "NationCode":"86"}]
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

输入示例

POST / HTTP/1.1
Host: sms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePhoneNumberInfo
<公共请求参数>

{
    "PhoneNumberSet": [
        "+8618501234444",
        "+8618501234445"
    ]
}

输出示例

{
    "Response": {
        "PhoneNumberInfoSet": [
            {
                "SubscriberNumber": "18501234444",
                "Message": "Describe success",
                "Code": "Ok",
                "PhoneNumber": "+8618501234444",
                "IsoCode": "CN",
                "IsoName": "China",
                "NationCode": "86"
            },
            {
                "SubscriberNumber": "18501234445",
                "Message": "Describe success",
                "Code": "Ok",
                "PhoneNumber": "+8618501234445",
                "IsoCode": "CN",
                "IsoName": "China",
                "NationCode": "86"
            }
        ],
        "RequestId": "a0aabda6-cf91-4f3e-a81f-9198114a2279"
    }
}

5. 开发者资源

腾讯云 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: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

签名demo

下面提供了各个语言生成签名的过程，demo 只是起到演示的作用，不具备通用性，在实际的开发中还是推荐使用 SDK。

Signature V1:

Signature V3

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation.JsonParseFail	解析请求包体时候失败。
FailedOperation.PhoneNumberParseFail	号码解析失败，请检查号码是否符合 E.164 标准。
InvalidParameterValue.IncorrectPhoneNumber	手机号格式错误。
LimitExceeded.PhoneNumberCountLimit	调用接口单次提交的手机号个数超过200个，请遵守 API 接口输入参数 PhoneNumberSet 描述。

号码信息查询

本页目录：