渠道方GET
列出渠道区域
返回某个 provider 已开通的区域。supported 表示 provider 是否在该区域可用;allocatable 表示当前是否可在该区域绑定新账号。
https://api.unifyport.ai/v1/providers/{provider}/regions请求头
X-Api-Keystring必填
工作区 API Key,工作区由该请求头解析得到。
路径参数
providerstring必填
用于该 providers 路由的标识符。
enum: telegram, whatsapp, line, twitter, zalo, tiktok, whatsapp_protocol, x, x_client, twitter_client
请求体
该接口无需 JSON 请求体。
响应体
providerstring
本次返回区域可用性的渠道。
enum: telegram, whatsapp, line, twitter, zalo, tiktok, whatsapp_protocol
regions[]object[]区域列表,每项包含 supported 与 allocatable 标志。
regions[]object[]
区域列表,每项包含 supported 与 allocatable 标志。
regionstring
渠道部署区域标识。
supportedboolean
该渠道是否已在此区域运行。
allocatableboolean
当前是否可以在此区域分配新账号。
响应
200200 OK
请求成功,响应体示例如上。
400请求错误
请求体、路径或参数不合法。
401未授权
X-Api-Key 请求头缺失或无效。
500服务端错误
服务端遇到了未预期的错误。
请求
curl -X GET https://api.unifyport.ai/v1/providers/{provider}/regions \
-H "X-Api-Key: <YOUR_API_KEY>"响应
{
"data": {
"provider": "telegram",
"regions": [
{
"region": "global",
"supported": true,
"allocatable": true
}
]
}
}