assistant
GET /v1/assistant/conversations
List your own assistant conversations.
認証
ベアラー トークンとして API キーを送信します。キーには tickets.reply 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
組織 ID を入力する場所
このエンドポイントはクエリパラメータとして org_id を受け取ります。省略した場合はテナントサブツリー全体が対象になり、指定した場合は特定の組織のみに絞り込まれます。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/assistant/conversations \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
⛔ **Your own**, not your organization's. RLS scopes rows to a tenant and has no opinion about which colleague wrote them; an agency thread that starts "my card keeps getting declined" is not something every member should read back, so this filters on the calling user as well. An API-key principal has no user and cannot use this surface at all. Requires `tickets.reply`.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
cursor (query) | string | いいえ | Opaque cursor from a previous page's `page.next_cursor`. |
limit (query) | integer | いいえ | Maximum items to return (page size). |
org_id (query) | Uuid | いいえ | Narrow to one organization. ⛔ Narrows, never widens: the base set is always what you may act in, and an `org_id` you cannot act in intersects to nothing rather than raising — a… |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
data | AssistantConversation[] | はい | — |
page | PageMeta | はい | — |
このエンドポイントが返すエラー
401 · 403 · 422 · 429