public

GET /v1/public/chat/{publicKey}/conversations/{conversationId}/messages

Anything said since the visitor's cursor.

Все эндпоинты public

Вся документация для разработчиков

Аутентификация

Этот эндпоинт является публичным. Он не требует учетных данных и организации — его читают наш собственный маркетинговый сайт и поисковые системы на базе ИИ.

Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.

Попробовать

Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.

curl -X GET https://api.zinndigital.com/v1/public/chat/{publicKey}/conversations/{conversationId}/messages

Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли

Подробнее

Anonymous, authorised by X-Zinn-Chat-Token. Returns immediately — empty if there is nothing — and tells the caller when to ask again in pollAfterMs. ⛔ This endpoint does not hold the connection open, and no future version of it should. The engine is WSGI with a small fixed number of concurrent request slots, so a long-poll or an SSE stream here would consume a share of the entire platform's capacity per open chat. When concurrency outgrows short-polling, chat moves to its own ASGI service — it does not become a socket on this one. ⭐ pollAfterMs is decided by the server, never by the widget. A cadence baked into a JavaScript file is cached on somebody else's site behind somebody else's CDN, so the one number governing fleet-wide load would be the one number we could not change.

Параметры

ИмяТипОбязательноЧто это
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Да
after (query)integerНетThe highest seq the caller already has. A per-conversation counter, not a timestamp: two messages written in the same millisecond are indistinguishable by clock, so a time…

Ответ

ИмяТипОбязательноЧто это
statestring<ai, waiting, open, offline, closed>Да
cursorintegerДа
poll_after_msintegerДа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…
messagesChatMessage[]Да

Ошибки, которые может возвращать этот эндпоинт

404 · 429