public

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

The visitor says something else.

Toute la documentation pour développeurs →

Authentification

Cet point de terminaison est public. Il ne nécessite aucun identifiant ni aucune organisation : c'est ce que notre propre site marketing et nos moteurs de réponse IA lisent.

Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

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

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

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.

Paramètres

Nom	Type	Obligatoire	Qu'est-ce que c'est
`publicKey (path)`	`string`	Oui	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`	Oui	—

Corps de la requête

Nom	Type	Obligatoire	Qu'est-ce que c'est
`message`	`string`	Oui	—
`page_url`	`string`	Non	—
`page_title`	`string`	Non	—
`referrer`	`string`	Non	—
`locale`	`string`	Non	—
`name`	`string`	Non	—
`email`	`string`	Non	—

Réponse

Nom	Type	Obligatoire	Qu'est-ce que c'est
`state`	`string<ai, waiting, open, offline, closed>`	Oui	—
`cursor`	`integer`	Oui	—
`poll_after_ms`	`integer`	Oui	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[]`	Oui	—

Erreurs que cet point de terminaison peut renvoyer

404 · 422 · 429

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