开发者

GET/v3/getstates/{isocode}

列出有号码库存的美国州或加拿大省份

对于 US 或 CA,返回具有在库前缀的州或省份。每个条目包含库存总量、前缀数量、功能标志,以及指向该州或省份下属区域的 next_function 链接。

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

对于美国或加拿大,可使用此可选步骤按州或省份缩小查询范围。仅接受 US 和 CA。

  • 每个条目描述请求时该州或省份具有库存的前缀。
  • 使用 next_function 可列出该州或省份的区域。此链接已包含 state 筛选条件,但不包含 pid。
  • 区域查询匹配州或省份信息的方式略有不同。如果某个州或省份的 next_function 返回 No areas found,请改为调用 getareas,且不指定州或省份。
  • 请先检查 status.code,再读取 response。对于不受支持的国家,或没有匹配库存的国家,会返回代码 404,但不会返回与之对应的 HTTP 状态。
  • 空列表和代码 200 表示有库存,但库存没有州或省份信息。请调用 getareas,且不指定州或省份。

请求

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

使用 GET 请求,并在路径中指定 isocode。如果省略该路径段,则改为读取表单编码的 isocode 字段。可选的 pid 通过查询字符串发送。

curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/getstates/US'
路径参数
名称类型是否必需说明
isocode字符串是US 或 CA。不区分大小写;忽略首尾空白字符。
查询参数
名称类型是否必需说明
pid字符串否高级可选参数。将统计的前缀限制为来自同一个库存来源。仅使用 MultiTEL 提供的值,其形式为数字或 32 个字符的十六进制值;正常使用时请省略此参数。未提供 pid 时,会统计当前可供查询的所有来源。无法识别的值会被忽略,且不会报错。如果所选来源没有可供您的账户使用的在库前缀,结果为 'No states found'。

响应

采用标准响应封装。成功时,status.code 为 200,status.msg 为空,status.results 为条目数量。response 是一个列表,先按 name 排序(不区分大小写),再按 state 代码排序。字段:state(取自前缀的州或省份数据的代码,通常为两个字母;不常见的值会原样传递);name(目录中的名称;如果目录没有对应名称,则使用代码);country_iso;available(所有已统计前缀的库存总量,始终大于 0);prefix_count(已统计的在库前缀数量);is_mobile(如果任一已统计前缀支持移动通信,则为 1;对于 US,始终为 0,除非您的账户已启用美国移动号码);sms_coverage(如果任一已统计前缀具有短信覆盖,则为 1);returns_numbers(如果任一已统计前缀具有返回号码标志,或该标志未设置值,则为 1);next_function('v3/getareas/{isocode}?state={state}')。如果存在在库前缀,但均不含州或省份信息,则结果中 status.code 为 200,列表为空,status.results 为 0。

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

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 2
  },
  "response": [
    {
      "state": "NY",
      "name": "New York",
      "country_iso": "US",
      "available": 120,
      "prefix_count": 8,
      "is_mobile": 0,
      "sms_coverage": 1,
      "returns_numbers": 1,
      "next_function": "v3/getareas/US?state=NY"
    },
    {
      "state": "TX",
      "name": "Texas",
      "country_iso": "US",
      "available": 45,
      "prefix_count": 3,
      "is_mobile": 0,
      "sms_coverage": 0,
      "returns_numbers": 1,
      "next_function": "v3/getareas/US?state=TX"
    }
  ]
}

错误

  • 500: msg 'ISO Code parameter is required':isocode 缺失或为空。这是可以修正的请求错误。不会设置与之对应的 HTTP 状态;请读取 status.code。
  • 404: msg 'getstates is only available for US and CA':提供了其他国家代码。不会设置与之对应的 HTTP 状态。
  • 404: msg 'No states found':没有在库前缀符合国家和来源筛选条件。不会设置与之对应的 HTTP 状态。
  • 401: 缺少身份验证或身份验证失败。随 HTTP 状态 401 一同发送。

可用性与副作用

  • 仅执行查询,不会预留、订购或更改任何内容。available 仅供参考,不会锁定号码。