会話
会話メンバー一覧
group タイプの会話メンバーを一覧します。conversation_id はクエリで渡し、cursor / limit でページングします。各項目は peer_id / display_name / avatar_url を返し、role は member / admin / superadmin のいずれかです。superadmin はグループの所有者または作成者です。1 対 1 など未対応の会話タイプでは 400 を返します。
https://api.unifyport.ai/v1/accounts/{account_id}/conversations/members呼び出す前に
対象ワークスペースの X-Api-Key をサーバー側で使用します。実行前にすべてのプレースホルダーを置き換えます。
パラメーターの取得元
- account_id
- アカウント作成・取得応答の data.id を使います。識別子は X-Api-Key のワークスペースに属します。 アカウント取得
- conversation_id
- 参照する会話 — List conversations が conversation_id として返す値。
リクエストパラメータ
ヘッダー
X-Api-Keyワークスペース API キー。このヘッダーからワークスペースを特定します。
パスパラメータ
account_idconversations ルートで使用される識別子。
クエリパラメータ
conversation_id参照する会話 — List conversations が conversation_id として返す値。
type参照を一意に特定するための会話タイプ（user、group、または channel）。
enum: user, group, channel
cursor不透明な next_cursor。先頭は省略します。無効・期限切れ cursor の扱いは Provider ごとに異なります。
limitページサイズは 1〜100。既定値は各エンドポイント説明を参照してください。
minimum: 1 · maximum: 100
リクエストボディ
このエンドポイントは JSON ボディを必要としません。
結果の確認
記載された応答項目と HTTP 状態を確認します。204 成功には本文がありません。診断には X-Request-Id を使い、次は関連操作を参照します。
レスポンス 200 OK
{
"request_id": "<REQUEST_ID>",
"data": {
"items": [
{
"peer_id": "user_example",
"display_name": "",
"avatar_url": "",
"role": "superadmin"
}
],
"next_cursor": "",
"has_more": false
}
}
レスポンスボディ
peer_idチャネル側の安定したメンバー識別子。不透明な文字列として保存し、そのまま使用します。
username利用可能な場合のメンバーのプロバイダ側ユーザー名。
display_nameメンバーの表示名。ない場合は空文字列。
avatar_urlメンバーのアバター URL。ない場合は空文字列。
role正規化ロール。所有者/作成者は superadmin、管理者は admin、一般または不明は member。
enum: member, admin, superadmin
joined_atプロバイダが報告したメンバーの参加時刻。
format: date-time
extra電話番号などのプロバイダ固有メンバーフィールド。
next_cursor次ページ用の不透明なカーソル。cursor として渡し直します。空文字列の場合は次のページがないことを意味します。
has_moreこのページの先にさらに結果がある場合は true。
レスポンス
200200 OK
リクエスト成功。レスポンスボディの例を参照してください。
400Bad Request
リクエストボディ、パス、またはパラメータが不正です。
401Unauthorized
X-Api-Key ヘッダが欠落しているか無効です。
404Not Found
要求されたプロバイダリソースが見つかりません。
409Conflict
要求された操作が、既存のプロバイダアカウントまたはリソースと競合しています。
500Internal Server Error
サービスで予期しないエラーが発生しました。
501Not Implemented
選択したプロバイダはこの操作を実装していません。
502Bad Gateway
プロバイダアダプタまたは上流サービスが操作を完了できませんでした。
失敗時の対応
HTTP 状態と error.code/numeric_code を確認し、request_id を保存します。原因に応じてパラメーター修正・認証・状態確認を行い、送信や書き込みの再試行前に前回の結果を確認します。 エラーリファレンス
- invalid_request · 10000 · 400
- 必須項目、形式、チャネルの条件を確認して修正します。
- invalid_api_key · 11001 · 401
- X-Api-Key とワークスペースの有効性を確認します。