live-chat

POST `/v1/chat/conversations/{conversationId}/messages`

An operator answers a visitor.

Uwierzytelnianie

Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie livechat.reply; klucz bez niego jest odrzucany z kodem 403, a nie 404.

Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

curl -X POST https://api.zinndigital.com/v1/chat/conversations/{conversationId}/messages \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "message": <string> }'

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

Requires `livechat.reply`. Claims the conversation for the caller if nobody has it yet, so the assistant stops answering over the top of a person.

Parametry

Nazwa	Typ	Wymagane	Co to jest
`conversationId (path)`	`string`	Tak	—

Treść żądania

Nazwa	Typ	Wymagane	Co to jest
`message`	`string`	Tak	—

Odpowiedź

Nazwa	Typ	Wymagane	Co to jest
`id`	`string`	Tak	—
`widget_id`	`string`	Tak	—
`state`	`string<ai, waiting, open, offline, closed>`	Tak	—
`visitor_name`	`string`	Tak	—
`visitor_email`	`string`	Tak	—
`page_url`	`string`	Tak	—
`page_title`	`string`	Tak	—
`referrer`	`string`	Tak	—
`country`	`string`	Tak	Two-letter country, resolved at our edge from the connection. The visitor's IP address itself is never stored.
`locale`	`string`	Tak	—
`assigned_operator`	`string`	Tak	—
`cursor`	`integer`	Tak	—
`started_at`	`string`	Tak	—
`last_message_at`	`string`	Tak	—
`message`	`ChatMessage`	Nie	—

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 404 · 422

POST /v1/chat/conversations/{conversationId}/messages