Skip to main content
Crea una conversación en el inbox indicado. Es obligatorio enviar source_id (identificador de origen) e inbox_id. Opcionalmente puedes asignar a agente o equipo, enviar un mensaje inicial y atributos personalizados.

​
Autenticación

​
api_access_token
string
required
Token de usuario (userApiKey) o de bot (agentBotApiKey).

​
Parámetros de ruta

​
account_id
integer
required
ID de la cuenta.

​
Cuerpo de la solicitud

​
source_id
string
required
Identificador de origen de la conversación. Ejemplo: 1234567890.
​
inbox_id
integer
required
ID del inbox donde se crea la conversación. Tipos permitidos: Website, Phone, Api, Email.
​
contact_id
integer
ID del contacto asociado (opcional).
​
status
string
Estado inicial: open, resolved, pending. Por defecto suele ser open.
​
assignee_id
integer
ID del agente al que se asigna la conversación.
​
team_id
integer
ID del equipo al que se asigna la conversación.
​
message
object
Mensaje inicial. Requiere content (string). Para WhatsApp puede incluir template_params.
​
additional_attributes
object
Atributos adicionales (ej. browser, os) para contexto.
​
custom_attributes
object
Atributos personalizados (clave-valor) definidos en la cuenta.
​
snoozed_until
string
Fecha/hora ISO hasta la cual la conversación queda en snooze.

​
Ejemplo de solicitud

curl -X POST 'https://app.yampi.ai/api/v1/accounts/1/conversations' \
  -H 'api_access_token: TU_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "source_id": "widget-abc-123",
    "inbox_id": 1,
    "contact_id": 10,
    "status": "open",
    "message": { "content": "Hola, necesito ayuda con mi pedido." }
  }'

​
Respuesta exitosa

{
  "id": 100,
  "account_id": 1,
  "inbox_id": 1
}
​
id
number
required
ID de la conversación creada.
​
account_id
number
ID de la cuenta.
​
inbox_id
number
ID del inbox.

​
Errores

  • 403: Access denied — sin permiso o inbox/contacto inválido.
  • 401: No autenticado.