会話
会話ラベル一覧
アカウント側の会話ラベルを一覧します。limit / cursor でページングします。各ラベルは id と name を公開します。現在は WhatsApp のみ対応 — 他のプロバイダは 501 unsupported_by_provider を返します。
https://api.unifyport.ai/v1/accounts/{account_id}/conversations/labels対応チャネル
呼び出す前に
対象ワークスペースの X-Api-Key をサーバー側で使用します。実行前にすべてのプレースホルダーを置き換えます。
パラメーターの取得元
- account_id
- アカウント作成・取得応答の data.id を使います。識別子は X-Api-Key のワークスペースに属します。 アカウント取得
リクエストパラメータ
ヘッダー
X-Api-Keyワークスペース API キー。このヘッダーからワークスペースを特定します。
パスパラメータ
account_idconversations ルートで使用される識別子。
クエリパラメータ
cursorプロバイダの不透明なカーソル。前の応答の next_cursor を変更せずに渡します。最初のページでは省略または空にします。偽造、期限切れ、別クエリで再利用したカーソルは、無視、最初のページへのリセット、またはプロバイダエラーとなる場合があります。一律の 400 応答を前提にしないでください。
limitページサイズは 1〜100。既定値は各エンドポイント説明を参照してください。
minimum: 1 · maximum: 100
リクエストボディ
このエンドポイントは JSON ボディを必要としません。
結果の確認
この API に記載された応答項目と HTTP 状態で結果を判断し、関連操作から次の手順を選びます。
レスポンス 200 OK
{
"request_id": "<REQUEST_ID>",
"data": {
"items": [
{
"id": "label_example",
"name": "VIP"
}
],
"next_cursor": "",
"has_more": false
}
}
レスポンスボディ
id会話ラベル識別子。
name会話ラベルの表示名。
next_cursor次ページ用の不透明なカーソル。cursor として渡し直します。空文字列の場合は次のページがないことを意味します。
has_moreこのページの先にさらに結果がある場合は true。
レスポンス
200200 OK
リクエスト成功。レスポンスボディの例を参照してください。
400Bad Request
リクエストボディ、パス、またはパラメータが不正です。
401Unauthorized
X-Api-Key ヘッダが欠落しているか無効です。
409Conflict
要求された操作が、既存のプロバイダアカウントまたはリソースと競合しています。
500Internal Server Error
サービスで予期しないエラーが発生しました。
501Not Implemented
選択したプロバイダはこの操作を実装していません。
502Bad Gateway
プロバイダアダプタまたは上流サービスが操作を完了できませんでした。
失敗時の対応
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 とワークスペースの有効性を確認します。