live-chat
POST /v1/chat/conversations/{conversationId}/close
Close a conversation.
Autenticación
Envía una clave de API como token de portador. La clave debe tener el permiso livechat.reply; una clave que no lo tenga se rechazará con un código 403, no 404.
Este endpoint no requiere ningún id de organización. Su clave ya identifica la organización a la que pertenece, y la respuesta está delimitada a ella.
Pruébalo
Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.
curl -X POST https://api.zinndigital.com/v1/chat/conversations/{conversationId}/close \
-H "Authorization: Bearer zdk_live_…"¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API
Detalles
Requires `livechat.reply`. Idempotent. A visitor who writes again reopens it rather than being told the conversation is over.
Parámetros
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
conversationId (path) | string | Sí | — |
Respuesta
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
id | string | Sí | — |
widget_id | string | Sí | — |
state | string<ai, waiting, open, offline, closed> | Sí | — |
visitor_name | string | Sí | — |
visitor_email | string | Sí | — |
page_url | string | Sí | — |
page_title | string | Sí | — |
referrer | string | Sí | — |
country | string | Sí | Two-letter country, resolved at our edge from the connection. The visitor's IP address itself is never stored. |
locale | string | Sí | — |
assigned_operator | string | Sí | — |
cursor | integer | Sí | — |
started_at | string | Sí | — |
last_message_at | string | Sí | — |
Errores que este endpoint puede devolver
401 · 403 · 404