MultiTEL
开发者

GET/tcr/v2/enum/{type}

加载消息注册选项目录

加载消息品牌和活动当前可用的选项，包括企业类型、行业和用途。这些目录提供表单所需的值；不会注册或批准活动。

本页
  1. 构建注册表单前先加载选项
  2. 选择目录
  3. 直接处理 TCR 响应
  4. 将目录选项与资格及定价区分开来
  5. 处理目录不可用的情况
  6. 请求
  7. 响应
  8. 错误
  9. 可用性与附带影响

构建注册表单前先加载选项

使用当前的消息注册目录填充选项，避免将注册机构的值硬编码。对于品牌表单，门户会加载企业类型、行业、替代企业标识符类型、品牌关系、国家、美国州和证券交易所目录。对于活动表单，门户会加载用途、有效的子用途和连接合作伙伴。将返回的每个机器值与其显示标签一起保留；构建后续请求时，应使用该值，而非翻译后的标签。

选择目录

门户使用的目录
名称作用
usecase活动用途的定义。加载子用途选项时，添加 validSubUsecase=true。
entityType品牌的企业或组织类型。
vertical品牌的行业选项。
altBusinessIdType替代企业标识符的类别。
brandRelationship注册表单使用的关系选项。
country注册机构的国家选项；这些选项与电话号码可用国家的选项相互独立。
usState注册地址的美国州选项。
stockExchange品牌的企业类型要求填写证券交易所时使用的交易所选项。
cnp连接合作伙伴的标识符。请选择您的账户活动流程支持的合作伙伴。

直接处理 TCR 响应

响应正文直接来自 TCR API。与许多旧版 /v3 端点不同，它没有额外的 status/response 包装层。解析前先检查 HTTP 状态。目录可能包含字符串标签或结构化定义，因此不要假设每个值都具有相同的字段。如果 HTTP 请求成功，但正文不是符合预期结构的有效 JSON，应报告查询失败，而不是悄悄将其替换为空列表。

将目录选项与资格及定价区分开来

通用用途目录不能说明某个品牌具备哪些用途的资格。当前门户会在创建活动前查询该品牌的专属资格，并检查所选运营商的要求。同样，供应商的费用元数据也不是账户的最终零售价格。请另行审查适用的账户价格和注册条款。加载目录并不意味着品牌、活动或消息号码获得批准。

处理目录不可用的情况

如果查询失败，请保留客户已填写的表单内容。显示错误，并遵循返回的 Retry-After 指示，同时逐步延长重试间隔。不要反复重新加载所有目录，也不要将限流或传输错误当作有效的空目录。此 GET 不需要幂等键，也不会从变更操作的幂等存储中重放。

请求

从允许的源 IP 地址，通过 HTTPS 使用已启用的 API 账户。当前路由支持账户身份验证策略，包括 Basic 身份验证及已启用的持有者令牌 API 账户。不要使用提供商凭据。

发送 GET 请求，并在路径中指定受支持的目录名称。在查询字符串中传入适用的目录筛选条件。无需请求正文。

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/enum/usecase?validSubUsecase=true"
路径参数
名称类型必填说明
type字符串是目录名称，保留原有大小写。门户使用 usecase、entityType、vertical、altBusinessIdType、brandRelationship、country、usState、stockExchange 和 cnp。这些是目录名称，而非品牌或活动标识符。
查询参数
名称类型必填说明
validSubUsecase布尔值否对于 usecase 目录，门户会在请求中传入 true，以加载有效的子用途选项。加载普通用途目录时，请省略此参数。可用性和定义由注册机构提供。

响应

此 TCR 路由直接返回注册机构的正文及其 HTTP 状态，不使用旧版 v3 的 status.code/status.msg/response 包装结构。目录的结构各不相同：有些将值映射到描述性对象，另一些则将值映射到字符串。提交后续表单时，请保留机器可读的键。精简的虚构 usecase 示例展示的是以对象为值的映射，并非实时目录，也不保证是完整的数据结构。请同时检查 HTTP 状态以及是否符合预期的 JSON 结构。

用于说明的响应结构；并非实时账户数据或当前报价。

{
  "2FA": {
    "displayName": "Authentication",
    "description": "Example authentication use case"
  }
}

错误

  • 401：账户身份验证失败。请检查 API 凭据、账户启用状态及适用的源 IP 限制。
  • 400/404 及其他注册机构错误：目录或筛选条件无效或不可用。当前路由保留上游的 HTTP 状态和响应正文；不存在通用的 v3 错误包装结构。
  • 429：已达到账户或共享提供商的请求限制。请遵循 Retry-After，并逐步延长重试间隔。
  • 502：无法连接注册机构。可用性未知；不要用空选项代替成功结果。
  • 503：请求限流器或上游服务不可用。重试前，请检查正文以及任何返回的 Retry-After 响应头。

可用性与附带影响

  • 在已审查的路径中，此目录 GET 不会创建品牌或活动、提交注册、预留资源或收取注册费。它会联系提供商并写入请求审计记录。
  • 目录定义及任何供应商费用元数据都不是面向客户的零售报价。当前门户会另行获取活动的零售价格；不得将旧版 getCampaignPrice 辅助函数和旧枚举中的价格注释视为此路由的定价约定。
  • 目录条目受支持，并不能证明某个品牌具备该用途的资格。在后续提交注册请求前，请完成该品牌的专属资格核实、声明、同意手续及账户定价审查。