public
POST /v1/public/chat/{publicKey}/conversations/{conversationId}/messages
The visitor says something else.
प्रमाणीकरण
हा एंडपॉइंट सार्वजनिक आहे. याला कोणतीही क्रेडेन्शियल आणि कोणतेही ऑर्गनायझेशन लागत नाही — हे तेच आहे जे आमची स्वतःची मार्केटिंग साइट आणि AI आन्सर इंजिने वाचतात.
या एंडपॉइंटला कोणतीही संस्था आयडी (organisation id) लागत नाही. तुमची की (key) आधीच ती कोणत्या संस्थेशी संबंधित आहे हे ओळखते आणि प्रतिसाद त्यानुसार मर्यादित केला जातो.
प्रयत्न करा
कोनसांस्कृतिक कंसात (<>) असलेली कोणतीही गोष्ट तुमच्या स्वतःच्या मूल्यांनी बदला आणि key प्लेसहोल्डरला तुमच्या डॅशबोर्डवरील किने बदला.
curl -X POST https://api.zinndigital.com/v1/public/chat/{publicKey}/conversations/{conversationId}/messages \
-H "Content-Type: application/json" \
-d '{ "message": <string> }'साइन इन केलेले आहे? तुमच्या डॅशबोर्डमधील API कन्सोल तुमची खरी संस्था आयडी आणि तुमची स्वतःची की आपोआप भरतो आणि लाइव्ह API विरुद्ध विनंती कार्यान्वित करतो जेणेकरून तुम्हाला वास्तविक प्रतिसाद पाहता येईल. एपी कन्सोलमध्ये हा एंडपॉइंट उघडा
तपशील
Anonymous, authorised by X-Zinn-Chat-Token. The message is written to the database in this request, before any operator or assistant is involved — so nothing is lost when a consumer is down. A visitor writing into a conversation the operator had closed reopens it rather than being told it is over.
पॅरामीटर्स
| नाव | प्रकार | आवश्यक | हे काय आहे |
|---|---|---|---|
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 | होय | — |
विनंती मुख्य भाग
| नाव | प्रकार | आवश्यक | हे काय आहे |
|---|---|---|---|
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[] | होय | — |
ही एंडपॉइंट परत करू शकेल अशा त्रुटी
404 · 422 · 429