国际手机号码检查纠正

国际手机号码检查纠正
接口详情官网地址: https://www.gugudata.com/api/details/internationalphone

格式有效性检查及智能纠正

请求方法: GET
接口路径: /sms/internationalphone
调试地址: https://api.gugudata.com/sms/internationalphone/demo
OpenAPI: https://www.gugudata.com/openapi/gugudata.openapi.3.1.json

请求参数:

appkey (string, 必填): 付费后获取的 APPKEY

phone (string, 必填): 查询的手机号码，如 +1(817) 569-8900

countrycode (string, 可选): ISO-3166 标准的两位或三位国家代码，用于校验号码在提供的归属国家是否为有效号码，如 US, USA，不传递则智能纠错

返回字段:

DataStatus.StatusCode: 接口返回状态码

DataStatus.StatusDescription: 接口返回状态说明

DataStatus.ResponseDateTime: 接口数据返回时间

DataStatus.DataTotalCount: 此条件下的总数据量，一般用于分页计算

Data.IsValid: 手机号码是否有效，如提供了 countrycode 参数，此参数表示号码是否在指定国家有效

Data.SourceMobileNumber: 请求的原始手机号码

Data.CorrectedMobileNumber: 纠正后的手机号码

Data.CountryCode: 国家电话前缀，如 +1

Data.CountryCode2: ISO-3166 标准两位国家代码

Data.CountryCode3: ISO-3166 标准三位国家代码

HTTP 状态码:

200 接口正常响应: 业务状态码请结合响应体中的状态字段判断。

400 请求参数错误: 参数缺失、格式错误或非法组合。

401 鉴权失败: 缺少 APPKEY 或 APPKEY 无效。

403 无权限或额度不可用: 订单到期、权限不足或剩余额度不可用。

404 资源不存在: 请求路径不存在。

405 请求方法不允许: 请求方法与接口定义不匹配。

415 请求内容类型不支持: 文件上传或请求体格式不符合要求。

429 请求频率超限: 触发接口或网关限流策略。

500 服务内部异常: 服务执行异常，请联系技术支持。

502 上游依赖异常: 上游服务响应异常或暂不可用。

业务状态码:

100 正常返回: 暂无说明

101 参数错误: 暂无说明

102 请求频率受限: 每秒请求不能超过 100 次

103 账号欠费: 暂无说明

104 APPKEY 错误: 请检查传递的 APPKEY 是否为开发者中心获取到的值

110 接口响应错误: 暂无说明

接口特性:

智能检测国际手机号码格式有效性；

可根据提供的国家编码参数，判断提供的手机号码是否为该国家有效手机号码；

智能纠正提供的手机号码格式为统一的国际编码格式，供后续如发送短信等场景统一使用；

毫秒级响应性能；

全接口支持 HTTPS（TLS v1.0 / v1.1 / v1.2 / v1.3）；

全面兼容 Apple ATS；

全国多节点 CDN 部署；

接口极速响应，多台服务器构建 API 接口负载均衡；

返回响应

🟢200成功

application/json

Bodyapplication/json

示例

{
  "DataStatus": {
    "StatusCode": 0,
    "StatusDescription": "string",
    "ResponseDateTime": "string",
    "DataTotalCount": 0
  },
  "Data": {
    "IsValid": false,
    "SourceMobileNumber": "string",
    "CorrectedMobileNumber": "string",
    "CountryCode": "string",
    "CountryCode2": "string",
    "CountryCode3": "string"
  }
}

请求参数

请求示例代码

返回响应