live-chat

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

An operator answers a visitor.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (bearer token). يجب أن يحمل المفتاح إذن livechat.reply؛ والمفتاح الذي لا يملكه يُرفض بالرمز 403 وليس 404.

لا يقبل هذا الطرف أي معرف للمؤسسة. يحدد مفتاحك بالفعل المؤسسة التي ينتمي إليها، وتكون الاستجابة محصورة في نطاقها.

جربه الآن

استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.

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

هل سجلت الدخول؟ تقوم وحدة تحكم واجهة برمجة التطبيقات في لوحة التحكم الخاصة بك بربط معرف مؤسستك الحقيقي ومفتاحك الخاص، وتنفذ الطلب مقابل واجهة برمجة التطبيقات المباشرة لتتمكن من رؤية الاستجابة الفعلية. افتح هذه النهاية الطرفية في وحدة تحكم API

التفاصيل

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.

المعلمات

الاسم	النوع	مطلوب	ما هو هذا
`conversationId (path)`	`string`	نعم	—

جسم الطلب

الاسم	النوع	مطلوب	ما هو هذا
`message`	`string`	نعم	—

الاستجابة

الاسم	النوع	مطلوب	ما هو هذا
`id`	`string`	نعم	—
`widget_id`	`string`	نعم	—
`state`	`string<ai, waiting, open, offline, closed>`	نعم	—
`visitor_name`	`string`	نعم	—
`visitor_email`	`string`	نعم	—
`page_url`	`string`	نعم	—
`page_title`	`string`	نعم	—
`referrer`	`string`	نعم	—
`country`	`string`	نعم	Two-letter country, resolved at our edge from the connection. The visitor's IP address itself is never stored.
`locale`	`string`	نعم	—
`assigned_operator`	`string`	نعم	—
`cursor`	`integer`	نعم	—
`started_at`	`string`	نعم	—
`last_message_at`	`string`	نعم	—
`message`	`ChatMessage`	لا	—

الأخطاء التي يمكن أن تُرجعها نقطة النهاية هذه

401 · 403 · 404 · 422

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