REST API 文档

账户与计费 REST API

读取您已获批准的集成可访问的余额和计费信息。

同时选择 API 和凭据

已获批准的开发者与自动化、企业和通信服务提供商账户可以集成已启用的服务。个人开发者无需假装成公司。应用程序 SMS/MMS 需要相应的发送审批和注册。个人与家庭服务没有面向客户开放的消息发起 API。

API 系列基础 URL身份验证与结果
通信 v3https://api.multitel.net/v3已获批准的 Basic 凭据;符合条件的已配置令牌仅适用于支持令牌的操作。JSON 包含 status 和 response。
紧急呼叫注册https://api.multi.tel/emergency已获批准的 Basic 凭据,或专门配置的 Bearer 访问权限。JSON 包含 code、message 和 data。
门户 REST 集成以您账户的开发者参考中显示的主机和操作为准请使用该操作文档中说明的凭据、权限范围和数据结构。浏览器会话请求属于另一类接口。

在使用示例之前,请通过服务器的密钥配置设置 MULTITEL_API_USERNAME 和 MULTITEL_API_PASSWORD。切勿将它们嵌入公开的浏览器 JavaScript、URL 或源代码管理中。专用凭据可在API 集成设置中管理。

第一个请求:读取您的余额

此读取操作不会购买服务,也不会发起通话或消息。

curl --fail-with-body \
  --user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
  --header "Accept: application/json" \
  "https://api.multitel.net/v3/getbalance"

通信 v3 API 会在 JSON 正文中返回应用层结果。读取 response 之前,请先检查 HTTP 状态和 status.code;被拒绝的请求可能没有 response 对象。代码值可能是字符串,也可能是数字。

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "balance": "25.0000",
    "currency": "USD",
    "terms": "Prepaid"
  }
}

这是虚构的示例,并非真实账户余额。请将金额数值按十进制数处理。诊断被拒绝的请求时,请保留服务器返回的响应消息,并去除其中的凭据。

正确使用计费数据

余额响应包含当前余额、货币和付款条款,但不提供未来通话的费用,也不是完整的账单。如需了解这些信息,请使用相应的费率和用量操作。现有号码的套餐可能与当前目录中的套餐不同。

处理错误与重试

身份验证或权限失败
请检查 API 凭据是否已启用、是否允许使用所需服务,以及源 IP 限制。门户的会话 Cookie 不是集成凭据。
余额不足或审批条件未满足
请先解决账户余额、发送审批或文件要求问题,然后再重复该操作。
无结果
请将库存为空或查不到主叫名称视为正常结果处理。不要假定一个语法有效的号码就具备所有服务。
网络超时或服务故障
读取操作请使用有上限的重试并采用退避策略。对于购买、发送或注册操作,请先检查操作状态;重试已被接受的请求可能造成重复的计费操作。

幂等性支持取决于各个 API 系列。紧急呼叫 API 支持重试密钥,但这并不意味着任意 v3 请求都是幂等的。请保留时间戳、返回的 ID 以及已脱敏的响应,以便提供给支持团队。

继续查看您账户的参考文档

登录后的参考文档会根据您的权限和已启用的服务筛选操作。请使用其中给出的确切主机、凭据类型、请求字段和响应结构。控制台可以执行实际操作,包括购买和发送消息。