public
POST /v1/public/chat/{publicKey}/conversations/{conversationId}/human
The visitor asks for a person.
認証
このエンドポイントは公開されています。認証情報や組織情報は不要で、当社のマーケティングサイトやAI回答エンジンが読み取っているものと同じです。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/public/chat/{publicKey}/conversations/{conversationId}/humanログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Anonymous, authorised by X-Zinn-Chat-Token. Moves the conversation into the operator queue. Idempotent — asking twice is the same as asking once.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
publicKey (path) | string | はい | The widget's public key. Public by design — it ships in the page source of every site that embeds the widget — so it NAMES a widget and authorises nothing; the Origin header is… |
conversationId (path) | string | はい | — |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
state | string<ai, waiting, open, offline, closed> | はい | — |
cursor | integer | はい | — |
poll_after_ms | integer | はい | How long the widget should wait before asking again. Decided by the SERVER on every response, because a cadence baked into the widget is cached on somebody else's site behind… |
messages | ChatMessage[] | はい | — |
このエンドポイントが返すエラー
404 · 429