API リファレンス

プロバイダ

プロバイダのリージョン一覧

プロバイダが展開されているリージョンを返します。supported はそのリージョンでプロバイダが稼働するかどうかを示し、allocatable は現在そのリージョンで新規アカウントを bind できるかどうかを示します。

GEThttps://api.unifyport.ai/v1/providers/{provider}/regions

対応チャネル

all

呼び出す前に

対象ワークスペースの X-Api-Key をサーバー側で使用します。実行前にすべてのプレースホルダーを置き換えます。

リクエストパラメータ

ヘッダー

X-Api-Key
string必須

ワークスペース API キー。このヘッダーからワークスペースを特定します。

パスパラメータ

provider
string必須

providers ルートで使用される識別子。

enum: telegram, whatsapp, line, twitter, zalo, tiktok, whatsapp-protocol, x, x_client, twitter_client

リクエストボディ

このエンドポイントは JSON ボディを必要としません。

結果の確認

この API に記載された応答項目と HTTP 状態で結果を判断し、関連操作から次の手順を選びます。

レスポンス 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "provider": "telegram",
    "regions": [
      {
        "region": "global",
        "supported": true,
        "allocatable": true
      }
    ]
  }
}

レスポンスボディ

provider
string

チャネルの識別子です。後続の呼び出しでは返された値をそのまま使ってください。この API の値は以下の enum を参照してください。

enum: telegram, whatsapp, line, twitter, zalo, tiktok, whatsapp-protocol

regions[]
object[]

リージョン一覧。各項目には supported と allocatable が含まれます。

region
string

プロバイダのデプロイ先リージョン識別子。

supported
boolean

このリージョンでプロバイダが稼働しているかどうか。

allocatable
boolean

現在このリージョンに新規アカウントを割り当てられるかどうか。

レスポンス

200

200 OK

リクエスト成功。レスポンスボディの例を参照してください。

400

Bad Request

リクエストボディ、パス、またはパラメータが不正です。

401

Unauthorized

X-Api-Key ヘッダが欠落しているか無効です。

500

Internal Server Error

サービスで予期しないエラーが発生しました。

失敗時の対応

HTTP 状態と error.code/numeric_code を確認し、request_id を保存します。原因に応じてパラメーター修正・認証・状態確認を行い、送信や書き込みの再試行前に前回の結果を確認します。 エラーリファレンス

invalid_request · 10000 · 400
必須項目、形式、チャネルの条件を確認して修正します。
missing_api_key · 11000 · 401
X-Api-Key とワークスペースの有効性を確認します。
invalid_api_key · 11001 · 401
X-Api-Key とワークスペースの有効性を確認します。