获取国际区号 - ListCountryCodes

功能介绍

获取支持的国际区号。

URI

GET /api/v2/sdk/country-codes

请求参数

表1 请求Header参数
参数	是否必选	参数类型	描述
X-operating-sys-version	是	String	调用方操作系统版本，例如：Android 10。
X-device-fingerprint	是	String	调用方设备指纹，例如：156aysdna213sc50。
X-device-ip	否	String	调用方IP，例如：10.10.10.1。
X-agent	是	String	用户Agent信息，例如：Mozilla/5.0 (Linux; Android 10; Redmi K30 Build/QKQ1.190825.002; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/80.0.3987.99 Mobile Safari/537.36。
X-L	否	String	用于国际化语言设置，例如：zh。
X-client-id	是	String	应用标识，注册应用后分配的ClientId。
X-tenant-id	否	String	租户id，ISV应用调用则为必填，需要将{domain_name}换成ISV通用域名{common_domain}，请求Header参数中需要指定对应租户的tenant_id，并将X-client-id换成ISV应用模板的client_id。

响应参数

状态码：200

表2 响应Body参数
参数	参数类型	描述
phoneAreaCodeDefinitions	Array of PhoneAreaCodeDefinitionsResult objects	支持的区号详情。
preferredAreaCode	String	当前管理门户配置的首选国际区号。

表3 PhoneAreaCodeDefinitionsResult
参数	参数类型	描述
areaCode	String	国际电话区号。
displayMapping	DisplayMapping object	多语言显示名映射。
countryCode	String	国家地区代码。
mobileRegex	String	手机号格式正则。
areaCodeSuffixes	String	国际电话区号后缀。

表4 DisplayMapping
参数	参数类型	描述
zh-TW	String	中文繁体描述。
en	String	英文描述。
zh-CN	String	中文简体描述。

状态码：400

表5 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误详情。

请求示例

获取支持的国际区号。

GET https://{domain_name}/api/v2/sdk/country-codes

X-operating-sys-version: Android 10
X-device-fingerprint: 156aysdna213sac
X-device-ip: 10.10.10.1
X-agent: Mozilla/5.0 (Linux; Android 10; Redmi K30 Build/QKQ1.190825.002; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/80.0.3987.99 Mobile Safari/537.36
X-L: zh
X-client-id: DRrYIqauawN0I8myTMoDTPys6ezGZxnm
X-tenant-id: 08f770f51f80d2f40f38c00cb199fd21

响应示例

状态码：200

请求成功。

{
  "phoneAreaCodeDefinitions" : [ {
    "areaCode" : "86",
    "displayMapping" : {
      "zh-TW" : "中國大陸",
      "en" : "China",
      "zh-CN" : "中国大陆"
    },
    "countryCode" : "CN",
    "mobileRegex" : "^(\\+86){0,1}\\-?1\\d{10}$",
    "areaCodeSuffixes" : [ ]
  }, {
    "areaCode" : "852",
    "displayMapping" : {
      "zh-TW" : "中國香港",
      "en" : "Hong Kong",
      "zh-CN" : "中国香港"
    },
    "countryCode" : "HK",
    "mobileRegex" : "^(\\+852){1}\\-?0{0,1}[1,4,5,6,7,8,9](?:\\d{7}|\\d{8}|\\d{12})$",
    "areaCodeSuffixes" : [ ]
  }, {
    "areaCode" : "886",
    "displayMapping" : {
      "zh-TW" : "中國臺灣",
      "en" : "Taiwan",
      "zh-CN" : "中国台湾"
    },
    "countryCode" : "TW",
    "mobileRegex" : "^(\\+886){1}\\-?[6,7,9](?:\\d{7}|\\d{8})$",
    "areaCodeSuffixes" : [ ]
  }, {
    "areaCode" : "853",
    "displayMapping" : {
      "zh-TW" : "中國澳門",
      "en" : "Macau",
      "zh-CN" : "中国澳门"
    },
    "countryCode" : "MO",
    "mobileRegex" : "^(\\+853){1}\\-?0{0,1}[1,4,5,6,7,8,9](?:\\d{7}|\\d{8}|\\d{12})$",
    "areaCodeSuffixes" : [ ]
  }, {
    "areaCode" : "93",
    "displayMapping" : {
      "zh-TW" : "阿富汗",
      "en" : "Afghanistan",
      "zh-CN" : "阿富汗"
    },
    "countryCode" : "AF",
    "mobileRegex" : "^(\\+93){1}\\-\\d{6,11}",
    "areaCodeSuffixes" : [ ]
  } ],
  "preferredAreaCode" : "CN"
}