选择国家和号码类型
选择注册国家,然后使用以下函数返回的名称:get_document_number_types。将该名称作为 number_type 发送,不要发送类型 ID 或用于查找号码的一般分类。
阅读返回的说明
保留要求 ID 和关系 ID,以便用于相关的身份/文档工作流程。此调用返回要求,不会验证或提交您的文件。请遵循返回的说明,以及所选号码的任何特定要求。
不要将错误理解为豁免
有关国家无效或无需国家注册文档的错误将两种情况合并在同一条消息中。这不能证明无需注册。查询失败或结果为空也不代表客户或号码已获批准。如果结果含义不明确,请联系支持团队。
请求
通过 HTTPS 使用已启用的 API 账户凭据。支持基本身份验证和已启用 API 账户的持有者令牌;账户限制仍然适用。
使用 application/json 或 application/x-www-form-urlencoded 发送 POST 请求。
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
--request POST \
--header "Content-Type: application/json" \
--data '{"country":"US","number_type":"Local"}' \
"https://api.multitel.net/v3/get_requirements"| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
country | 字符串 | 是 | 来自 get_document_countries 的国家 ISO 代码。 |
number_type | 字符串 | 是 | 来自 get_document_number_types 的类型名称,例如 Local;匹配时不区分大小写。请提供名称,而非其 ID。 |
响应
除了 HTTP 状态,还应检查 JSON 响应体中的 status.code。response 是单个要求资源,包含 id、type 和 attributes,以及在有返回时包含的 relationships。资源和关系数据中的 ID 均为不透明标识符,不应从中推断内部含义。可选的 restriction_message 文本已移除 HTML 标签;请将剩余内容作为文本处理,而不要视为可信的 HTML。处理程序返回第一个要求资源,因此不要据此认为该响应是完整列表。属性和关系是否可用取决于国家和类型;此示例并非完整、固定的结构定义。
仅用于说明响应结构;并非实时账户数据或当前报价。
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"id": "REQUIREMENT_ID_FROM_RESPONSE",
"type": "RESOURCE_TYPE_FROM_RESPONSE",
"attributes": {
"restriction_message": "Example country-specific instructions."
}
}
}错误
- 400: 国家和 number_type 验证失败:请提供这两个必填值。验证文本可能包含格式。
- 400: Invalid country ISO or No country registration documents required.: 这条含义不明确的消息本身不能证明可免于注册。
- 400: Invalid number type: 请使用返回的类型名称。旧版错误消息列出了 Global、Local、Mobile、National、Shared Cost 和 Toll Free。
- 500: Unable to load registration requirements for the specified country and number type.: 未能成功返回要求。请稍后重试或联系支持团队。
可用性及附带影响
- 此目录/要求查询不会创建身份记录、上传证明材料、注册号码或下单。
- 目录响应成功并不代表您的文档已获批准,也不能确认所选号码可以激活。