プロバイダGET
プロバイダのリージョン一覧
プロバイダが展開されているリージョンを返します。supported はそのリージョンでプロバイダが稼働するかどうかを示し、allocatable は現在そのリージョンで新規アカウントを bind できるかどうかを示します。
https://api.unifyport.ai/v1/providers/{provider}/regionsヘッダー
X-Api-Keystring必須
ワークスペース API キー。このヘッダーからワークスペースを特定します。
パスパラメータ
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
リクエスト成功。レスポンスボディの例を参照してください。
400Bad Request
リクエストボディ、パス、またはパラメータが不正です。
401Unauthorized
X-Api-Key ヘッダが欠落しているか無効です。
500Internal Server Error
サービスで予期しないエラーが発生しました。
リクエスト
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
}
]
}
}