Ticket Creación de ticket Para crear un ticket, envíe una petición POST con una clave API en la cabecera X-Api-Key:
POST https://queue-api.obmessage.ai/api/v1/tickets
X-Api-Key: {{API_KEY}}
Content-Type: application/json
Ejemplo de petición El siguiente cuerpo es JSON válido. Reemplace topic_id por el ID de un tópico configurado; los campos dentro de data dependen de la plantilla de ese tópico.
{
"topic_id" : "519ac790-85cd-411e-b744-d21d83f21178" ,
"data" : {
"id" : 1 ,
"name" : "Juan" ,
"lastname" : "Pérez"
}
}
Con API_KEY definida en el entorno, puede enviar la petición con curl:
curl --request POST 'https://queue-api.obmessage.ai/api/v1/tickets' \
--header "X-Api-Key: $API_KEY " \
--header 'Content-Type: application/json' \
--data '{
"topic_id": "519ac790-85cd-411e-b744-d21d83f21178",
"data": {
"id": 1,
"name": "Juan",
"lastname": "Pérez"
}
}'
Resultado al crear el ticket Cuando el resultado es 200 OK, se obtiene una respuesta como esta. Los valores son ilustrativos:
{
"id" : "d680591d-3636-49ae-a8a5-91542897db13" ,
"topic_id" : "519ac790-85cd-411e-b744-d21d83f21178" ,
"status_id" : 1 ,
"ticket_number" : "A001" ,
"sla_minutes" : 60 ,
"priority" : 1 ,
"created_at" : "2024-07-29T13:56:20.58197239Z"
}
Si el tópico tiene with_turn en true, también se genera un turno. Una respuesta ilustrativa sería:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 {
"id" : "d680591d-3636-49ae-a8a5-91542897db13" ,
"topic_id" : "519ac790-85cd-411e-b744-d21d83f21178" ,
"status_id" : 1 ,
"ticket_number" : "A001" ,
"turn" : {
"id" : 1 ,
"created_at" : "2024-07-29T13:56:20.58197239Z" ,
"attention_date" : "2024-07-29" ,
"start_hour" : "09:00:00" ,
"end_hour" : "17:00:00" ,
"code" : "A001"
},
"sla_minutes" : 60 ,
"priority" : 1 ,
"created_at" : "2024-07-29T13:56:20.58197239Z"
}
Los tipos de los campos de respuesta son:
Campo Tipo id, topic_id UUID como cadena status_id, sla_minutes, priority Entero ticket_number Cadena created_at Fecha y hora UTC turn.id Entero turn.created_at Fecha y hora UTC turn.attention_date Fecha (yyyy-mm-dd) turn.start_hour, turn.end_hour Hora (hh:mm:ss) turn.code Cadena
Descripción de los campos Campo Tipo Descripción Requerido / Valor por defecto topic_id uuid ID del tópico desde el cual se creará el ticket. ✔ status_id int Estado padre del ticket. Se usa el status_default del tópico. Si el tópico no tiene un estado predeterminado, este campo es requerido. customer_status_id int Estado del cliente del ticket. Se usa el status_default del tópico. Si el tópico no tiene un estado predeterminado, el valor será null. assigned_user_id uuid ID del usuario al cual se asignará el ticket. ✖ sla_minutes int Valor SLA del ticket. Si no se envía, se usa el sla_minutes del tópico. priority int Prioridad del ticket. Rango permitido: [1-10]. El valor por defecto es 1. Si no se envía, se usa el default_priority del tópico. comment string Comentarios asociados al ticket. ✖ attachments []JSON Archivos adjuntos al ticket. Debe enviarse el ID del archivo registrado en el fileserver. ✖ data JSON Conjunto de datos asociados al ticket. Estos datos se visualizan de acuerdo con la plantilla configurada. ✔ turn_id int ID del turno que se usará para copiar el code cuando se genere el turno del ticket. ✖ attention_date string Fecha de atención en la que se atenderá el turno, en formato yyyy-mm-dd. datetime.NOW bot_script_id_success int Integración con Aless: ID del script al cual debe saltar el bot si el ticket se crea correctamente. ✖ bot_script_id_failed int Integración con Aless: ID del script al cual debe saltar el bot si ocurre algún error al crear el ticket. ✖
Errores al crear el ticket Si el tópico utilizado no está dentro del horario configurado, se retorna el siguiente error:
{
"code" : "error.invalid_reference" ,
"message" : "error creating ticket: 'no schedules or turn'"
}
Pruébelo en Postman