Saltar a contenido

Ticket

Creación de ticket

Para realizar una integración para crear ticket es necesario hacer lo siguiente: 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
POST https://queue-api.ofimatic.net/api/v1/tickets
X-Api-Key: {{API_KEY}}
Content-Type: application/json
{
    "topic_id": string,
    "data": {
        "id": int,
        "name": string,
        "lastname": string
    }
}

Ejemplo

1
2
3
4
5
6
7
8
{
    "topic_id": "519ac790-85cd-411e-b744-d21d83f21178",
    "data": {
        "id":1,
        "name":"Juan",
        "lastname":"Perez"
    }
}

Resultado al crear el ticket

Cuando el resultado es 200 OK

1
2
3
4
5
6
7
8
9
{
    "id": uuid,
    "topic_id": uuid,
    "status_id": int,
    "ticket_number": string,
    "sla_minutes": int,
    "priority": int,
    "created_at": utc-date
}
Si el tópico usado tiene la opción with_turn con el valor true, al momento de crear un ticket también se generara un turno el cual muestra el siguiente resultado: 

{
    "id": uuid,
    "topic_id": uuid,
    "status_id": int,
    "ticket_number": string,
    "turn": {
        "id": int,
        "created_at": utc-date,
        "attention_date": date,
        "start_hour": string(time: hh:mm:ss),
        "end_hour": string(time: hh:mm:ss),
        "code": string
    },
    "sla_minutes": 60,
    "priority": 1,
    "created_at": "2024-07-29T13:56:20.58197239Z"
}

Descripción de los campos

Campo Tipo Descripción Requerido/Valor por defecto
topic_id uuid Id del tópico desde el cual se creara el ticket ✔
status_id int Estado padre del ticket Se usa el status_default del tópico, si este tiene, entonces, es requerido.
customer_status_id int Estado del cliente del ticket Se usa el status_default del tópico, si este no tiene entonces, es null
assigned_user_id uuid Id de usuario al cual se asigna 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: [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 (id del archivo en el fileserver) ✖
data JSON Conjunto de datos asociados al ticket. Estos datos se pueden visualizar de acuerdo a la plantilla. ✔
topic_id int Id del turno que se usara para copiar el code cuando se genere el turno del ticket. ✖
attention_date string Fecha de atención en la cual se atenderá el turno, en el formato: yyyy-mm-dd datetime.NOW
bot_script_id_success int Integración Aless: id del script al cual debe saltar el bot si el ticket se crea correctamente. ✖
bot_script_id_failed int Integración 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 esta dentro de horario se retorna el siguiente error:

{
    "code": "error.invalid_reference",
    "message": "error creating ticket: 'no schedules or turn'"
}

Pruebalo en Postman