开发者

GET/v3/getcountries

列出有现货号码的国家

返回当前至少有一个号码前缀有现货且可见的国家。每个条目均包含国家呼叫代码、ISO 代码、国家级移动号码和短信标志、坐标,以及指向该国覆盖区域的 next_function 链接。

本页
  1. 请求
  2. 响应
  3. 错误
  4. 可用性与副作用

从这里开始查找本地号码。列表仅包含当前有现货号码的国家。此操作不会预留任何号码或其他资源。

  • 将 isocode 传给 getareas、传给 getstates(仅限 US 和 CA),或传给 other。
  • next_function 始终指向 v3/getareas/{isocode}。对于美国和加拿大,您可以先调用 getstates,按州或省缩小范围。
  • is_mobile 和 sms_coverage 是国家级标志,并不保证每个号码都具备相应能力。对于美国,is_mobile 为 0,除非您的账户已开通美国移动号码权限。
  • 仅提供需订购号码、没有现货的国家不会列出。对于未列出的国家,您仍可直接调用 getareas 或 other 进行查询。
  • 如果需要特定顺序,请自行对列表排序。

如果没有符合条件的国家,response 为 null,且 status.code 为 200。

请求

必须使用 HTTP Basic 身份验证或 Bearer 令牌(参见“身份验证和 API 响应”)。如果身份验证失败,系统会在执行查询之前返回 HTTP 401。

使用 GET,无请求体。唯一的参数是可选的 pid,通过查询字符串传递。

curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/getcountries'
查询参数
名称类型是否必填说明
pidstring否此参数为可选的高级选项,用于将列表缩小至标记为属于某一库存来源的国家。只能使用 MultiTEL 提供的值,格式为数字或 32 个字符的十六进制值;常规使用时请省略此参数。pid 不会缩小响应部分所述的现货检查范围。无法识别的值、零以及此端点不接受的值都会被忽略,且不会报错;此时列表涵盖所有受支持的来源。

响应

采用标准响应封装。成功时,status.code 为 200,status.msg 为 'Results: N',status.results 为 N,response 为国家列表,顺序不作保证。字段:countrycode(不含 '+' 的国家呼叫代码);name(国家名称);description(与 name 的值相同);isocode(ISO 3166-1 alpha-2 代码);is_mobile(0 或 1,国家级目录标志;对于 US,其值始终为 0,除非您的账户已开通 US 移动号码权限);sms_coverage(0 或 1,国家级目录标志);latitude 和 longitude(国家坐标);next_function('v3/getareas/{isocode}')。只有当国家可见,且其至少一个号码前缀当前在任一库存来源中有现货时,才会列出该国家。所有覆盖范围内的号码均需订购、没有现货的国家不会列出。此现货检查的范围比 getareas 所应用的筛选条件更广,因此已列出的国家在该端点中偶尔仍可能返回 'No areas found'。如果没有符合条件的国家,status.code 为 200,status.msg 为 'Results: 0',不包含 status.results 字段,且 response 为 null。

此示例仅用于说明响应结构,并非实时账户数据或当前报价。

{
  "status": {
    "code": 200,
    "msg": "Results: 2",
    "results": 2
  },
  "response": [
    {
      "countrycode": "1",
      "name": "United States",
      "description": "United States",
      "isocode": "US",
      "is_mobile": 0,
      "sms_coverage": 1,
      "latitude": "38.0000",
      "longitude": "-97.0000",
      "next_function": "v3/getareas/US"
    },
    {
      "countrycode": "44",
      "name": "United Kingdom",
      "description": "United Kingdom",
      "isocode": "GB",
      "is_mobile": 1,
      "sms_coverage": 0,
      "latitude": "54.0000",
      "longitude": "-2.0000",
      "next_function": "v3/getareas/GB"
    }
  ]
}

错误

  • 401:未提供身份验证信息或身份验证失败。以 HTTP 状态码 401 返回(参见“身份验证和 API 响应”)。

可用性与副作用

  • 仅执行查询,不会预留、订购或更改任何内容。
  • 结果反映请求时的现货情况,不同调用之间可能发生变化。