API リファレンス
会話GET

会話の詳細

単一の会話の詳細をリアルタイムに返します。conversation_id はクエリパラメータとして渡します(List conversations が返す値と同じです)。レスポンスには常に conversation_id / type / title / avatar_url(存在しない場合は空文字列)が含まれ、加えてグループの members_count などタイプ固有のフィールドが含まれます。会話が見つからない場合は 404 を返します。

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

ヘッダー

X-Api-Key
string必須

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

パスパラメータ

account_id
string必須

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

クエリパラメータ

conversation_id
string必須

参照する会話 — List conversations が conversation_id として返す値。

type
string

参照を一意に特定するための会話タイプ(user、group、または channel)。

enum: user, group, channel

リクエストボディ

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

レスポンスボディ

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

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

レスポンス

200
200 OK

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

400
Bad Request

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

401
Unauthorized

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

404
Not Found

要求されたプロバイダリソースが見つかりません。

409
Conflict

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

500
Internal Server Error

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

501
Not Implemented

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

502
Bad Gateway

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

リクエスト

curl -X GET https://api.unifyport.ai/v1/accounts/{account_id}/conversations/info?conversation_id=peer_example&type=group \
  -H "X-Api-Key: <YOUR_API_KEY>"

レスポンス

{
  "data": {
    "conversation_id": "peer_example",
    "type": "group",
    "title": "Group title",
    "avatar_url": "",
    "description": "...",
    "unread_count": 0,
    "members_count": 42
  }
}