会話

会話一覧

会話をリアルタイム一覧します。limit は 1..100、既定 20。type は user / group / channel の完全一致値で trim されません。WhatsApp で label_id を省略すると starred /「特别关注」会話のみ返します。無効 cursor の扱いは Provider ごとに異なります。

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

呼び出す前に

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

パラメーターの取得元

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

リクエストパラメータ

ヘッダー

X-Api-Key

string必須

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

パスパラメータ

account_id

string必須

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

クエリパラメータ

type

string

user、group、channel の完全一致値をカンマ区切りで指定します。trim されません。

cursor

string

不透明な next_cursor。先頭は省略します。無効・期限切れ cursor の扱いは Provider ごとに異なります。

limit

integer

ページサイズは 1〜100。既定値は各エンドポイント説明を参照してください。

minimum: 1 · maximum: 100

label_id

string

完全一致のラベル ID。WhatsApp では省略すると starred /「特别关注」会話を返します。

リクエストボディ

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

結果の確認

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

レスポンス 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "items": [
      {
        "conversation_id": "peer_example",
        "type": "user",
        "title": "Display name",
        "avatar_url": "",
        "unread_count": 3,
        "last_message_at": "2026-05-13T10:00:00Z"
      }
    ],
    "next_cursor": "",
    "has_more": false
  }
}

レスポンスボディ

conversation_id

string

会話識別子。メッセージ送信時や会話ルート呼び出し時の宛先として使用します。

type

string

会話タイプ: user、group、または channel。

enum: user, group, channel

title

string

会話の表示タイトル。

username

string

利用可能な場合の会話のプロバイダ側ユーザー名。

avatar_url

string

アバター URL。設定がない場合は空文字列。

description

string

グループまたはチャンネルの説明（利用可能な場合）。

last_message_at

string

直近のメッセージの RFC3339 タイムスタンプ。

format: date-time

last_message_text

string

利用可能な場合の最新メッセージのテキストプレビュー。

unread_count

integer

会話内の未読メッセージ数。

format: int64

members_count

integer

メンバー数。グループ会話で返されます。

format: int64

subscribers_count

integer

利用可能な場合のチャンネル形式会話の購読者数。

format: int64

is_pinned

boolean

接続アカウントが会話を固定しているかどうか。

is_muted

boolean

接続アカウントが会話をミュートしているかどうか。

created_at

string

利用可能な場合のプロバイダ報告による会話作成時刻。

format: date-time

extra

object

標準スキーマで表現されないプロバイダ固有フィールド。

next_cursor

string

次ページ用の不透明なカーソル。cursor として渡し直します。空文字列の場合は次のページがないことを意味します。

has_more

boolean

このページの先にさらに結果がある場合は true。

レスポンス

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 とワークスペースの有効性を確認します。