live-chat

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

An operator answers a visitor.

Kimlik Doğrulama

Bearer token olarak bir API anahtarı gönderin. Anahtar livechat.reply iznine sahip olmalıdır; bu izne sahip olmayan bir anahtar 404 ile değil, 403 ile reddedilir.

Bu uç nokta hiçbir organizasyon kimliği almaz. Anahtarınız zaten ait olduğu organizasyonu tanımlar ve yanıt bu organizasyonla sınırlandırılır.

Dene

Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.

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> }'

Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın

Ayrıntılar

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.

Parametreler

Ad	Tür	Zorunlu	Ne olduğu
`conversationId (path)`	`string`	Evet	—

İstek gövdesi

Ad	Tür	Zorunlu	Ne olduğu
`message`	`string`	Evet	—

Yanıt

Ad	Tür	Zorunlu	Ne olduğu
`id`	`string`	Evet	—
`widget_id`	`string`	Evet	—
`state`	`string<ai, waiting, open, offline, closed>`	Evet	—
`visitor_name`	`string`	Evet	—
`visitor_email`	`string`	Evet	—
`page_url`	`string`	Evet	—
`page_title`	`string`	Evet	—
`referrer`	`string`	Evet	—
`country`	`string`	Evet	Two-letter country, resolved at our edge from the connection. The visitor's IP address itself is never stored.
`locale`	`string`	Evet	—
`assigned_operator`	`string`	Evet	—
`cursor`	`integer`	Evet	—
`started_at`	`string`	Evet	—
`last_message_at`	`string`	Evet	—
`message`	`ChatMessage`	Hayır	—

Bu uç noktanın dönderebileceği hatalar

401 · 403 · 404 · 422

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