marketplace
GET /v1/marketplace/conversations/{conversation_id}/messages
One thread's messages, for whichever side of it you are on.
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
組織 ID を入力する場所
このエンドポイントはクエリパラメータとして org_id を受け取ります。省略した場合はテナントサブツリー全体が対象になり、指定した場合は特定の組織のみに絞り込まれます。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/marketplace/conversations/{conversation_id}/messages \
-H "Authorization: Bearer zdk_live_…"ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
docs/147 §5. The door both parties share — above all the SELLER's way to read a pre-sales question, which the buyer-keyed enquiry route cannot serve. Reading clears your side's unread count. Held messages are hidden from both parties.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
conversation_id (path) | string | はい | — |
org_id (query) | string | いいえ | Which of your organizations is reading. Naming one you do not belong to is 403. |
cursor (query) | string | いいえ | Opaque cursor from a previous page's page.next_cursor. |
limit (query) | integer | いいえ | Maximum items to return (page size). |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
data | MarketplaceMessage[] | はい | — |
page | PageMeta | はい | — |
このエンドポイントが返すエラー
401 · 403 · 404