开发者

GET/v3/get_supporting_document_templates/{iso}

列出证明文件模板

在准备证明文件之前,查找模板 ID、名称和国家提示信息。

本页
  1. 浏览模板目录
  2. 根据要求选择模板
  3. 未返回任何模板时
  4. 使用下载的副本前,请先审阅
  5. 请求
  6. 响应
  7. 错误
  8. 可用性与副作用

浏览模板目录

省略可选的 ISO 路径段,即可列出服务返回的模板。提供国家 ISO 代码即可筛选列表。筛选条件匹配的是模板的国家提示信息,该信息可能根据名称推断得出,也可能为空。

根据要求选择模板

某个模板出现在列表中,并不意味着该国家的每个号码都必须使用或接受该模板。请将模板 ID 与适用的证明文件要求对应起来。此列表不会生成、签署、上传或批准已填写完成的文件。

未返回任何模板时

筛选后的列表为空,可能表示未找到匹配的国家提示信息。未筛选的列表为空,也可能是由于上游数据不可用。请勿将这两种结果中的任何一种视为无需提供证明文件的依据。

使用下载的副本前,请先审阅

目录中的下载链接可能返回格式或品牌标识经过更改的副本。请勿假定它是未经修改的原始协议,也不要认为下载该文件就满足了某项注册要求。在填写或签署任何文件之前,请先审阅其内容。

如果门户文件向导提供协议准备功能,请使用其预览流程,并通过明确的提交操作完成提交。对于其他必需表格,请在填写前向 MultiTEL 确认当前应使用的表格。下载的模板并非已签署的附件或已上传的证明材料,也不代表号码已获批准。

请求

通过 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_supporting_document_templates/$COUNTRY_ISO"
路径参数
名称类型是否必填说明
isostring否可选的国家 ISO 筛选条件。省略整个路径段即可获取未筛选的列表。比较时不区分大小写。未知或不匹配的值会返回空列表,而不会返回明确的国家无效错误。

响应

请同时检查 JSON 正文中的 status.code 和 HTTP 状态。response 是一个数组,其中的对象包含 id、name、permanent、iso 和 url 字段。permanent 的类型为 boolean;iso 可能为空,也可能是根据模板名称推断得出的。国家信息仅供参考,不能据此判定是否符合资格。空目录属于成功的 200 响应,上游查询未返回数据时也可能出现这种结果。URL 由服务生成,其主机名可能与示例中的不同。

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

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "id": "TEMPLATE_ID_FROM_RESPONSE",
      "name": "Example supporting-document template",
      "permanent": false,
      "iso": "US",
      "url": "https://api.multitel.net/v3/supporting_document/TEMPLATE_ID_FROM_RESPONSE"
    }
  ]
}

错误

  • 请检查 status.code 和 status.msg,以了解身份验证或服务错误。成功返回空目录并不表示文件已获批准,也不表示可免除注册要求。

可用性与副作用

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