public
POST /v1/public/chat/{publicKey}/conversations
A visitor says something for the first time.
인증
이 엔드포인트는 공개되어 있습니다. 자격 증명이나 조직 정보가 필요하지 않으며, 당사의 마케팅 사이트와 AI 답변 엔진이 읽는 것과 동일합니다.
이 엔드포인트는 조직 ID를 받지 않습니다. 사용자의 키가 이미 속한 조직을 식별하며, 응답은 해당 조직으로 한정됩니다.
무료 체험하기
대괄호 안에 있는 모든 내용을 사용자 지정 값으로 바꾸고, 키 플레이스홀더는 대시보드의 키로 바꾸세요.
curl -X POST https://api.zinndigital.com/v1/public/chat/{publicKey}/conversations \
-H "Content-Type: application/json" \
-d '{ "message": <string> }'로그인하셨나요? 대시보드의 API 콘솔이 실제 조직 ID와 본인의 키를 자동으로 채우고 라이브 API를 대상으로 요청을 실행하므로 실제 응답을 확인할 수 있습니다. API 콘솔에서 이 엔드포인트를 여세요
상세 정보
Anonymous. Opens a conversation and writes the visitor's first message, then lets the assistant answer it inline if the customer has AI switched on. The response carries a visitorToken once and never again. It is a bearer secret — the only thing standing between one visitor and another's transcript on the same site — so the widget keeps it in the visitor's own storage and presents it in X-Zinn-Chat-Token on every subsequent call. It is never accepted in a query string, because a query string is written to every access log.
매개변수
| 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
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… |
요청 본문
| 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
message | string | 예 | — |
page_url | string | 아니요 | — |
page_title | string | 아니요 | — |
referrer | string | 아니요 | — |
locale | string | 아니요 | — |
name | string | 아니요 | — |
email | 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[] | 예 | — |
conversation_id | string | 예 | — |
visitor_token | string | 예 | Returned ONCE and never again. A bearer secret — the only thing between one visitor and another's transcript on the same site — presented afterwards in X-Zinn-Chat-Token, never… |
이 엔드포인트가 반환할 수 있는 오류
404 · 422 · 429