开发者

GET/v3/get_document_number_types/{country}

列出号码注册类型

查找某个国家的注册目录中当前收录的号码类型名称。

本页
  1. 根据返回的名称选择类型
  2. 分组数量不代表号码库存
  3. 请求
  4. 响应
  5. 错误
  6. 可用性与副作用

根据返回的名称选择类型

使用以下接口返回的国家:get_document_countries。将返回的类型名称传给 get_requirements。类型目录 ID 不是前缀 ID、号码 ID 或证明材料类别 ID。

分组数量不代表号码库存

available_groups 统计本次目录查询返回的分组记录数。它不统计可购买的电话号码数量,不会预留库存,也不保证目录已遍历上游的所有分页。请另行搜索相关号码库存并查看报价。

请求

通过 HTTPS 使用您已启用的 API 账户凭据。支持 Basic 身份验证和已启用的 API 账户的 bearer 令牌;账户限制仍然适用。

使用 GET 请求,并将文档中列出的任何参数放在 URL 路径中。

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_document_number_types/$COUNTRY_ISO"
路径参数
名称类型是否必填说明
countrystring是注册国家目录中的两字母国家 ISO 代码。其首尾空白字符会被去除,字母会转换为大写。

响应

请同时检查 JSON 正文中的 status.code 和 HTTP 状态。response 是一个数组,其中包含 id、name 和 available_groups。将 name 作为 number_type 的值用于调用 get_requirements;不要发送 id 来替代它。available_groups 是该类型返回的分组记录数,不是电话号码库存数量,也不是涵盖所有分页的完整总数。未返回任何分组的类型会被省略。优先排列顺序为 Local、Mobile、National、Toll Free、Shared Cost、Global,然后是其他目录名称。

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

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "id": "NUMBER_TYPE_ID_FROM_RESPONSE",
      "name": "Local",
      "available_groups": 3
    }
  ]
}

错误

  • 400: country is required: 请提供注册国家的 ISO 代码。
  • 400: Invalid country ISO or no available DID registration country found: 请从当前注册目录中选择一个国家;这并不能说明无需提供任何文件。

可用性与副作用

  • 此目录或要求查询不会创建身份记录、上传证明材料、注册号码或下单。
  • 目录响应成功并不表示您的文件已获批准,也不表示已确认所选号码可以激活。