API リファレンス

会話

会話へのラベルの追加 / 削除

複数の会話に対してラベルを一括で付与または解除します。action は add または remove で、conversation_ids には少なくとも 1 つの id を含める必要があります。現在は WhatsApp のみ対応 — 他のプロバイダは 501 unsupported_by_provider を返します。

POSThttps://api.unifyport.ai/v1/accounts/{account_id}/conversations/labels

呼び出す前に

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

パラメーターの取得元
account_id
アカウント作成・取得応答の data.id を使います。識別子は X-Api-Key のワークスペースに属します。 アカウント取得

リクエストパラメータ

ヘッダー

X-Api-Key
string必須

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

Content-Type
string必須

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

パスパラメータ

account_id
string必須

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

リクエストボディ

label_id
string必須

ラベル識別子。

action
string必須

ラベルメンバー操作: add または remove。

enum: add, remove

conversation_ids[]
string[]必須

ラベルとの関連を変更する会話識別子。

minItems: 1

結果の確認

記載された応答項目と HTTP 状態を確認します。204 成功には本文がありません。診断には X-Request-Id を使い、次は関連操作を参照します。

レスポンス 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "label_id": "label_example",
    "action": "add",
    "conversation_ids": [
      "peer_example"
    ]
  }
}

レスポンスボディ

label_id
string

削除または更新されたラベル識別子。

action
string

適用されたラベルメンバー操作。

enum: add, remove

conversation_ids[]
string[]

操作の対象となった会話識別子。

レスポンス

200

200 OK

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

400

Bad Request

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

401

Unauthorized

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

409

Conflict

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

500

Internal Server Error

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

501

Not Implemented

選択したプロバイダはこの操作を実装していません。

502

Bad Gateway

プロバイダアダプタまたは上流サービスが操作を完了できませんでした。

失敗時の対応

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

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