Crear conversación
Los desarrolladores pueden crear conversaciones a través de la API.
Método de solicitud
POST
URL de solicitud
https://livedesk-api.engagelab.com/api/v2/accounts/conversations
Autenticación
Para más información, consulte la descripción del método de autenticación en Descripción general de la API.
Solicitud
Ejemplo de solicitud
curl -X POST https://livedesk-api.engagelab.com/api/v2/accounts/conversations \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic base64(api_key:api_secret)' \
{
"inbox_id": 407, // Obligatorio
"contact_id": 2219256, // Especifique contact_id o source_id para garantizar que el remitente pueda identificarse correctamente
"source_id": "123456789"
}
curl -X POST https://livedesk-api.engagelab.com/api/v2/accounts/conversations \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic base64(api_key:api_secret)' \
{
"inbox_id": 407, // Obligatorio
"contact_id": 2219256, // Especifique contact_id o source_id para garantizar que el remitente pueda identificarse correctamente
"source_id": "123456789"
}
Este bloque de código se muestra en una ventana flotante
Parámetros del encabezado de la solicitud
| Campo | Tipo | Descripción |
|---|---|---|
| Authorization | string | Use Authorization: Basic base64(API Key:API Secret) para la autenticación. Vaya a la página de API Key para obtener la API Key y el API Secret, únalos con dos puntos y luego codifíquelos en Base64. |
| Content-Type | application/json | Este es el formato de datos de la solicitud. Use application/json. |
Parámetros del cuerpo de la solicitud
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| inbox_id | String | Sí | ID del canal. Debe coincidir con el ID utilizado en la interfaz de creación de contactos. |
| contact_id | String | No | ID del contacto. Es el id devuelto en la respuesta de la interfaz de creación de contactos. |
| source_id | String | No | ID de origen. |
Respuesta
Ejemplo de respuesta
{
"meta": {
"sender": {
"additional_attributes": {},
"availability_status": "offline",
"email": null,
"id": 2219256,
"name": "wjTest",
"phone_number": null,
"blocked": false,
"identifier": null,
"thumbnail": "",
"custom_attributes": {},
"created_at": 1766571624
},
"channel": "Channel::Api",
"hmac_verified": false
},
"id": 40,
"messages": [],
"account_id": 17623000010928,
"uuid": "660ce36f-46bb-4153-948c-8a26e6dab634",
"inbox_id": 407,
"additional_attributes": {},
"agent_last_seen_at": 0,
"assignee_last_seen_at": 0,
"can_reply": true,
"contact_last_seen_at": 0,
"custom_attributes": {},
"labels": [],
"muted": false,
"snoozed_until": null,
"status": "open",
"priority": null,
"conversation_category": "chat",
"chat_mode": "private_chat",
"is_forum": false,
"created_at": 1766572062,
"updated_at": 1766572062.5803902,
"timestamp": 1766572062,
"first_reply_created_at": 0,
"unread_count": 0,
"last_non_activity_message": null,
"last_activity_at": 1766572062,
"waiting_since": 1766572062,
"sla_policy_id": null,
"ticket_id": null,
"over_limit": false,
"content_preview": {
"content": null,
"message_type": null,
"created_at": null
},
"platform": {
"channel_type": "Channel::Api",
"inbox_name": "JennyApi",
"inbox_id": 407
},
"account_info": {
"contact_name": "wjTest",
"contact_email": null,
"contact_phone": null,
"contact_id": 2219256,
"contact_avatar": ""
},
"assignment": {
"assignee_id": null,
"assignee_name": null,
"assignee_email": null,
"team_id": null,
"team_name": null
}
}
{
"meta": {
"sender": {
"additional_attributes": {},
"availability_status": "offline",
"email": null,
"id": 2219256,
"name": "wjTest",
"phone_number": null,
"blocked": false,
"identifier": null,
"thumbnail": "",
"custom_attributes": {},
"created_at": 1766571624
},
"channel": "Channel::Api",
"hmac_verified": false
},
"id": 40,
"messages": [],
"account_id": 17623000010928,
"uuid": "660ce36f-46bb-4153-948c-8a26e6dab634",
"inbox_id": 407,
"additional_attributes": {},
"agent_last_seen_at": 0,
"assignee_last_seen_at": 0,
"can_reply": true,
"contact_last_seen_at": 0,
"custom_attributes": {},
"labels": [],
"muted": false,
"snoozed_until": null,
"status": "open",
"priority": null,
"conversation_category": "chat",
"chat_mode": "private_chat",
"is_forum": false,
"created_at": 1766572062,
"updated_at": 1766572062.5803902,
"timestamp": 1766572062,
"first_reply_created_at": 0,
"unread_count": 0,
"last_non_activity_message": null,
"last_activity_at": 1766572062,
"waiting_since": 1766572062,
"sla_policy_id": null,
"ticket_id": null,
"over_limit": false,
"content_preview": {
"content": null,
"message_type": null,
"created_at": null
},
"platform": {
"channel_type": "Channel::Api",
"inbox_name": "JennyApi",
"inbox_id": 407
},
"account_info": {
"contact_name": "wjTest",
"contact_email": null,
"contact_phone": null,
"contact_id": 2219256,
"contact_avatar": ""
},
"assignment": {
"assignee_id": null,
"assignee_name": null,
"assignee_email": null,
"team_id": null,
"team_name": null
}
}
Este bloque de código se muestra en una ventana flotante
Parámetros de respuesta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| meta | Object | No | Objeto de metadatos. |
| sender | Object | No | Información del remitente. |
| additional_attributes | Object | No | Atributos adicionales. |
| availability_status | String | No | Estado de disponibilidad. |
| Null | No | Correo electrónico. | |
| id | Number | No | ID del contacto. |
| name | String | No | Nombre del remitente. |
| phone_number | Null | No | Número de teléfono. |
| blocked | Boolean | No | Indica si está bloqueado. |
| identifier | Null | No | Identificador del atributo del usuario. |
| thumbnail | String | No | Miniatura. |
| custom_attributes | Object | No | Atributos personalizados. |
| created_at | Number | No | Marca de tiempo de creación de la conversación. |
| channel | String | No | Tipo de canal. |
| hmac_verified | Boolean | No | Estado de verificación HMAC. |
| id | Number | No | ID de la conversación. |
| messages | Array | No | Matriz de mensajes. |
| account_id | Number | No | ID del proyecto. |
| uuid | String | No | Identificador único. |
| inbox_id | Number | No | ID del canal. |
| additional_attributes | Object | No | Atributos adicionales. |
| agent_last_seen_at | Number | No | Última vez que el agente fue visto. |
| assignee_last_seen_at | Number | No | Última vez que el responsable fue visto. |
| can_reply | Boolean | No | Indica si se puede responder. |
| contact_last_seen_at | Number | No | Última vez que el contacto fue visto. |
| custom_attributes | Object | No | Atributos personalizados. |
| labels | Array | No | Matriz de etiquetas. |
| muted | Boolean | No | Indica si está silenciado. |
| snoozed_until | Null | No | Fecha hasta la que permanece en pausa. |
| status | String | No | Estado. |
| priority | Null | No | Prioridad. |
| conversation_category | String | No | Categoría de la conversación. |
| chat_mode | String | No | Modo de chat. |
| is_forum | Boolean | No | Indica si es un foro. |
| created_at | Number | No | Marca de tiempo de creación. |
| updated_at | Number | No | Marca de tiempo de actualización. |
| timestamp | Number | No | Marca de tiempo. |
| first_reply_created_at | Number | No | Hora de creación de la primera respuesta. |
| unread_count | Number | No | Número de mensajes no leídos. |
| last_non_activity_message | Null | No | Último mensaje que no corresponde a una actividad. |
| last_activity_at | Number | No | Hora de la última actividad. |
| waiting_since | Number | No | Hora de inicio de la espera. |
| sla_policy_id | Null | No | ID de la política SLA. |
| ticket_id | Null | No | ID del ticket. |
| over_limit | Boolean | No | Indica si se superó el límite. |
| content_preview | Object | No | Vista previa del contenido. |
| content_preview.content | Null | No | Contenido de vista previa. |
| content_preview.message_type | Null | No | Tipo de mensaje. |
| content_preview.created_at | Null | No | Hora de creación. |
| platform | Object | No | Información de la plataforma. |
| channel_type | String | No | Tipo de canal. |
| inbox_name | String | No | Nombre de la bandeja de entrada. |
| inbox_id | Number | No | ID de la bandeja de entrada. |
| account_info | Object | No | Información de la cuenta. |
| contact_name | String | No | Nombre del contacto. |
| contact_email | Null | No | Correo electrónico del contacto. |
| contact_phone | Null | No | Teléfono del contacto. |
| contact_id | Number | No | ID del contacto. |
| contact_avatar | String | No | Avatar del contacto. |
| assignment | Object | No | Información de asignación. |
| assignee_id | Null | No | ID del responsable. |
| assignee_name | Null | No | Nombre del responsable. |
| assignee_email | Null | No | Correo electrónico del responsable. |
| team_id | Null | No | ID del equipo. |
| team_name | Null | No | Nombre del equipo. |
