アカウントPOST

アカウント作成

プロバイダアカウントを作成します。サポートする provider は telegram、whatsapp、twitter、line、zalo など。フローに応じて auth_mode = code、qrcode、session を指定します。選択した provider と auth_mode の組み合わせで電話番号が必要な場合（例: WhatsApp と auth_mode=code）、アカウント作成時に provider_data.phone で電話番号を渡してください。電話番号はアカウントに永続化され、以降の認証アクションで自動的に再利用されます。

https://api.unifyport.ai/v1/accounts

ヘッダー

X-Api-Key

string必須

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

Content-Type

string必須

JSON のリクエストボディを送る場合は application/json を使用します。

パスパラメータ

このエンドポイントにパスパラメータはありません。

リクエストボディ

name

string必須

人が読みやすいアカウント名。

provider

string必須

プロバイダ識別子。telegram、whatsapp、line、zalo など。

region

string必須

割り当てに使用するプロバイダのリージョン。プロバイダのリージョン一覧で allocatable: true と報告されたリージョンを選んでください。

auth_mode

string

認証フロー: code、qrcode、または session。

provider_data

object

プロバイダ固有の設定。秘匿値はログに出さないでください。

metadata

object

環境ラベル用のプラットフォーム側メタデータ。

レスポンスボディ

id

string

一意のアカウント識別子（acc_...）。アカウントスコープのルートで使用します。

name

string

人が読みやすいアカウント名。

provider

string

telegram、whatsapp、line、twitter、zalo などのプロバイダ識別子。

region

string

アカウントが割り当てられているプロバイダリージョン。

status

string

アカウントのライフサイクル状態（例: active）。

runtime_status

string

正規化されたランタイム状態。unknown、starting、running、stopping、stopped、reconnecting、disconnected、error のいずれか。

auth_mode

string

アカウントが使用する認証フロー: code、qrcode、または session。

capabilities

string[]

send_message や receive_message など、アカウントで有効化されている機能。

provider_account_ref

string

自社システムとアカウントを紐付けるために付与できる、プロバイダ側の識別子。

レスポンス

201

201 Created

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

400

Bad Request

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

401

Unauthorized

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

409

Conflict

要求された操作が、既存のプロバイダアカウントまたはリソースと競合しています。

500

Internal Server Error

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

リクエスト

curl -X POST https://api.unifyport.ai/v1/accounts \
  -H "X-Api-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Telegram Production",
  "provider": "telegram",
  "region": "global",
  "status": "active",
  "auth_mode": "qrcode",
  "capabilities": ["send_message", "receive_message"],
  "provider_data": {},
  "metadata": {
    "env": "production"
  },
  "provider_account_ref": "provider-side-identifier"
}'

レスポンス

{
  "data": {
    "id": "acc_example",
    "name": "Telegram Production",
    "provider": "telegram",
    "region": "global",
    "status": "active",
    "runtime_status": "stopped",
    "auth_mode": "qrcode",
    "capabilities": ["send_message", "receive_message"],
    "provider_account_ref": "provider-side-identifier"
  }
}