25_api_intro_sms_internationalphone
国际手机号码检查纠正 API 接口
有效性检查及智能纠正,遵循 E.164 标准,智能统一格式。
1. 产品功能
- 智能检测国际手机号码有效性;
- 可根据提供的国家编码参数,判断提供的手机号码是否为该国家有效手机号码;
- 智能纠正提供的手机号码格式为统一的国际编码格式,供后续如发送短信等场景统一使用;
- 全接口支持 HTTPS(TLS v1.0 / v1.1 / v1.2 / v1.3);
- 全面兼容 Apple ATS;
- 全国多节点 CDN 部署;
- 接口极速响应,多台服务器构建 API 接口负载均衡。
2. API 文档
API 详情地址: https://www.gugudata.com/api/details/internationalphone
接口请求地址: https://api.gugudata.com/sms/internationalphone
返回格式: application/json; charset=utf-8
请求方式: GET
请求协议: HTTPS
数据预览: https://www.gugudata.com/preview/internationalphone
接口测试: https://api.gugudata.com/sms/internationalphone/demo
3. 请求参数
参数名 | 参数类型 | 是否必须 | 默认值 | 备注 |
---|---|---|---|---|
appkey | string | 是 | YOUR_APPKEY | 付费后获取的 APPKEY |
phone | string | 是 | YOUR_VALUE | 查询的手机号码,如 +1(817) 569-8900 |
countrycode | string | 否 | YOUR_VALUE | ISO-3166 标准的两位或三位国家代码,用于校验号码在提供的归属国家是否为有效号码,如 US, USA |
4. 返回参数
参数名 | 参数类型 | 备注 |
---|---|---|
DataStatus.StatusCode | int | 接口返回状态码 |
DataStatus.StatusDescription | string | 接口返回状态说明 |
DataStatus.ResponseDateTime | string | 接口数据返回时间 |
DataStatus.DataTotalCount | int | 此条件下的总数据量,一般用于分页计算 |
Data.IsValid | boolean | 手机号码是否有效,如提供了 countrycode 参数,此参数表示号码是否在指定国家有效 |
Data.SourceMobileNumber | string | 请求的原始手机号码 |
Data.CorrectedMobileNumber | string | 纠正后的手机号码 |
Data.CountryCode | string | 国家电话前缀,如 +1 |
Data.CountryCode2 | string | ISO-3166 标准两位国家代码 |
Data.CountryCode3 | string | ISO-3166 标准三位国家代码 |