开发者

GET/v3/numberinfo/{number}

读取一个已购买的号码

读取已购买电话号码的已存储配置、功能标志和旧版引用字段。

本页
  1. 请求
  2. 响应
  3. 没有匹配的号码
  4. 使用结果

读取一条已购买号码的记录及其已存储配置。此操作返回一个对象,而非 inventory 端点返回的数组。

请求

通过 HTTPS 使用服务端 API 凭据。示例从环境变量中读取凭据,不包含任何可用的凭据。除了检查 HTTP 状态,还应检查 JSON 响应体中的 status.code。这些旧版处理程序在发生应用层错误时,并不总会设置 HTTP 错误状态。

curl --user "$MULTITEL_API_USER:$MULTITEL_API_PASSWORD" \
  "https://api.multitel.net/v3/numberinfo/12025550100"

必需的路径段是已存储的国际电话号码,而非其 UUID 或 PBX 分机号。此处理程序不使用查询参数或请求体。

响应

以下仅为响应结构示例,并非账户数据或当前报价。

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "number": "12025550100",
    "uuid": "NUMBER_UUID",
    "description": "Main reception",
    "isocode": "US",
    "config": {
      "uri": "sip:reception@example.com",
      "uri2": "",
      "uri3": "",
      "forward_destination": "",
      "sms_uri": "",
      "sms_forward_destination": ""
    },
    "features": {
      "voice": "1",
      "sms": "1",
      "mms": "0"
    },
    "status": {
      "capacity": {
        "assigned_channels": "2",
        "used_channels": "0",
        "overflow": "0",
        "overage_charge": "0.01"
      },
      "origination": {
        "origination_trunk_id": "ORIGINATION_ID",
        "origination_trunk_name": "ORIGINATION_NAME",
        "origination_country_iso": "US",
        "origination_continent_iso": "NA",
        "origination_continent_name": "North America"
      },
      "service_active": "1",
      "force_codec": "",
      "force_dtmf": ""
    },
    "billing": {
      "cnam": "0",
      "overflow": "0",
      "autorenew": "1",
      "persistent": "0",
      "date_created": "2026-01-01 00:00:00"
    },
    "price": {
      "setup_price": "0.00",
      "monthly_price": "1.00",
      "per_minute": "0.01",
      "free_minutes": "0",
      "remaining_minutes": "0",
      "perminute_charges": "0"
    },
    "needs_registration": "0",
    "vrating": "",
    "country_id": "COUNTRY_REFERENCE",
    "area_id": "AREA_REFERENCE",
    "provider_id": "OPAQUE_LEGACY_REFERENCE"
  }
}
返回的号码字段
字段含义
number, uuid, description, isocode已存储的电话号码、不透明的号码标识符、描述和国家代码。
config已存储的语音目的地、外部转接、短信目的地和短信转发字段。此端点不会修改这些字段。
features已存储的语音、短信和彩信功能标志。旧版存储的标志不保证为 JSON 布尔值。
status.capacity已分配和已使用的通道数值、溢出设置以及已存储的超额费用。这些是已存储的元数据,并非最新的容量报价或实时通话测试结果。
status.origination已存储的呼入来源元数据。应将标识符视为不透明值;不要根据内部名称推导应用逻辑。
status.service_active, force_codec, force_dtmf已存储的启用状态和媒体配置字段。仅凭一个标志无法证明呼入能够成功送达。
billing已存储的 CNAM、溢出、续订、持久性和创建时间值。读取这些值不会更改续订或其他计费设置。
price已存储的开通费用、月费、每分钟价格和通话分钟额度。此处理程序不提供币种字段或最新报价。不要根据示例数值推断币种,也不要将其用作当前购买报价。

与 inventory 相比,此端点还返回 needs_registration、vrating、country_id、area_id、provider_id 和 price.perminute_charges。这些是旧版存储的值,并非单独的身份审核通过响应。应将引用标识符视为不透明值;在未获得相应的发现响应时,不要据此构造发现 URL 或推断服务提供商映射关系。

没有匹配的号码

如果在已通过身份验证的账户下未找到匹配且未作废的记录,JSON 响应体中的 status.code 为 404,且消息中包含 number not found。不要依赖该消息末尾的源代码行号。重试前,请检查已存储的号码和 inventory。

使用结果

此操作读取已保存的数据。它不会购买号码、批准身份证明文件或更改目的地,也不保证电话、传真或消息能够送达。配置号码时,请分别测试每项已启用的服务。