Soporte

Generado desde DialerDigital/core commit bbb8e373d900 — especificación openapi/dialer-v1.yaml v0.151.0. No se edita a mano; consulta Cómo se construye esta referencia. Descargar la especificación OpenAPI.

English version

Traducción en curso

Esta referencia se genera desde la especificación OpenAPI. Las cadenas que todavía no tienen traducción aparecen en inglés.

Tickets de soporte con número y objetivo de primera respuesta según el nivel del plan.

Endpoints

Método	Ruta	Resumen
`GET`	`/v1/support/tickets`	Los tickets de soporte del tenant
`POST`	`/v1/support/tickets`	Abrir un ticket de soporte
`GET`	`/v1/support/tickets/{id}`	Un ticket de soporte con su hilo
`POST`	`/v1/support/tickets/{id}/messages`	Añadir un mensaje a un ticket
`POST`	`/v1/support/tickets/{id}/close`	Cerrar un ticket

Los tickets de soporte del tenant

http

GET /v1/support/tickets

El más reciente primero, con tope de 200. Filtra con ?status=.

Parámetros

Nombre	En	Tipo	Obligatorio	Descripción
`status`	query	`open` · `answered` · `resolved` · `closed`	no

Respuestas

`200`

Los tickets (sin hilo; consulta uno para ver sus mensajes).

Campo	Tipo	Obligatorio	Descripción
`tickets`	arreglo de SupportTicket	sí
`tickets[].id`	string (uuid)	sí
`tickets[].tenant_id`	string (uuid)	sí	Cuenta propietaria del ticket; direcciona las rutas de hilo y respuesta bajo `/v1/admin/tenants/{id}/support/tickets`.
`tickets[].number`	integer	sí	Número global del ticket.
`tickets[].reference`	string	sí	`TKT-<number>`, citado en el asunto del correo de respuesta.
`tickets[].subject`	string	sí
`tickets[].body`	string	sí
`tickets[].status`	`open` · `answered` · `resolved` · `closed`	sí
`tickets[].priority`	`low` · `normal` · `high` · `urgent`	sí
`tickets[].level`	`standard` · `priority`	sí	Nivel de soporte del plan cuando se abrió.
`tickets[].request_id`	string,null	no
`tickets[].contact_email`	string,null	no
`tickets[].first_response_due_at`	string (date-time)	sí
`tickets[].first_responded_at`	string,null (date-time)	no
`tickets[].created_at`	string (date-time)	sí
`tickets[].updated_at`	string (date-time)	sí

`400` — BadRequest

Petición mal formada (errores de forma/tipo, filtros no válidos, marcas de tiempo erróneas).

json

{
  "error": {
    "code": "bad_request",
    "message": "from must be RFC-3339"
  }
}

`401` — Unauthorized

Clave de API ausente, desconocida o revocada (o, en /v1/admin/*, un token de administración incorrecto o sin definir; en webhooks, una firma incorrecta o ausente). Una sesión del dashboard (ddu_) que un inicio de sesión más reciente de la misma persona haya cerrado responde en cambio con el código session_superseded (indicador de tenant single_session_enforced), para que la pantalla pueda explicar por qué se cerró la sesión; un cierre de sesión, un token vencido o uno desconocido siguen siendo unauthorized.

json

{
  "error": {
    "code": "unauthorized",
    "message": "invalid or revoked API key"
  }
}

`429` — ApiKeyRateLimited

Esta clave de API ha superado su cuota de peticiones, o las claves del tenant en conjunto han superado el techo del tenant (code rate_limited). La petición no se procesó. Espera Retry-After segundos y reintenta; un rechazo no cuenta contra el presupuesto, así que esa espera siempre basta. Acotado por clave de API y, por encima de las claves, por tenant (api_tenant_requests_per_minute): una clave hermana no se ve afectada hasta que las claves del tenant en conjunto alcanzan ese techo. La cuota se aplica a toda operación alcanzable con una clave dd_, así que las operaciones que nombran un 429 más específico (control de llamadas, disposiciones, SMS, …) PUEDEN responder TAMBIÉN este, con sus cabeceras X-RateLimit-*.

json

{
  "error": {
    "code": "rate_limited",
    "message": "API key request quota exceeded; retry after the interval in Retry-After"
  }
}

Abrir un ticket de soporte

http

POST /v1/support/tickets

Devuelve el number del ticket (referencia TKT-<number>) y arranca el reloj de primera respuesta. El objetivo depende del nivel del plan: standard (Starter): 1 día hábil; priority (Growth, Scale, Enterprise): 4 horas hábiles, contadas de lunes a viernes en UTC. first_response_due_at es ese instante. La respuesta del operador se envía por correo a contact_email (por defecto: el correo del usuario del dashboard que lo abre; una clave dd_ sin él no envía correo). contact_email debe ser la dirección de un usuario ACTIVO del tenant, si no 422 invalid_contact_email. Un tenant tiene como máximo support_tickets_max_open tickets sin terminar (open + answered; 30 por defecto): por encima, 409 ticket_limit; una respuesta o un cierre libera un hueco. Abrir tickets también tiene límite de tasa por tenant (429 con Retry-After).

Cuerpo de la petición (JSON, obligatorio)

Campo	Tipo	Obligatorio	Descripción
`subject`	string	sí
`body`	string	sí
`priority`	`low` · `normal` · `high` · `urgent`	no
`request_id`	string	no	El `x-request-id` de la llamada a la API sobre la que trata el ticket, si la hay.
`contact_email`	string	no

Respuestas

`201`

El ticket abierto, con su primer mensaje.

Campo	Tipo	Obligatorio	Descripción
`ticket`	any	sí

`400` — BadRequest

Petición mal formada (errores de forma/tipo, filtros no válidos, marcas de tiempo erróneas).

json

{
  "error": {
    "code": "bad_request",
    "message": "from must be RFC-3339"
  }
}

`401` — Unauthorized

json

{
  "error": {
    "code": "unauthorized",
    "message": "invalid or revoked API key"
  }
}

`409` — Conflict

Transición de estado no válida, conflicto de unicidad, o un asiento que está ocupado/reservado.

json

{
  "error": {
    "code": "conflict",
    "message": "invalid state transition"
  }
}

`422` — Unprocessable

La forma es correcta, la semántica no (regla de dominio incumplida).

json

{
  "error": {
    "code": "unprocessable",
    "message": "scheduled_at is closer than the minimum notice for a callback (10 minutes unless the tenant's callback_min_notice_seconds says otherwise)"
  }
}

`429` — ApiKeyRateLimited

json

{
  "error": {
    "code": "rate_limited",
    "message": "API key request quota exceeded; retry after the interval in Retry-After"
  }
}

Un ticket de soporte con su hilo

http

GET /v1/support/tickets/{id}

Parámetros

Nombre	En	Tipo	Obligatorio	Descripción
`id`	path	string (uuid)	sí	UUID del recurso. Los ids mal formados o de otro tenant se leen como `404`.

Respuestas

`200`

El ticket.

Campo	Tipo	Obligatorio	Descripción
`ticket`	any	sí

`401` — Unauthorized

json

{
  "error": {
    "code": "unauthorized",
    "message": "invalid or revoked API key"
  }
}

`404` — NotFound

Id desconocido, mal formado (no UUID) O id de otro tenant: RLS devuelve cero filas, así que los tres son indistinguibles por diseño (sin fuga de existencia, nunca un 403 para ids ajenos).

json

{
  "error": {
    "code": "not_found",
    "message": "resource not found for this tenant"
  }
}

`429` — ApiKeyRateLimited

json

{
  "error": {
    "code": "rate_limited",
    "message": "API key request quota exceeded; retry after the interval in Retry-After"
  }
}

Añadir un mensaje a un ticket

http

POST /v1/support/tickets/{id}/messages

Reabre un ticket respondido o resuelto. 409 cuando está cerrado.

Parámetros

Nombre	En	Tipo	Obligatorio	Descripción
`id`	path	string (uuid)	sí	UUID del recurso. Los ids mal formados o de otro tenant se leen como `404`.

Cuerpo de la petición (JSON, obligatorio)

Campo	Tipo	Obligatorio	Descripción
`body`	string	sí

Respuestas

`201`

El ticket con el mensaje nuevo.

Campo	Tipo	Obligatorio	Descripción
`ticket`	any	sí

`400` — BadRequest

Petición mal formada (errores de forma/tipo, filtros no válidos, marcas de tiempo erróneas).

json

{
  "error": {
    "code": "bad_request",
    "message": "from must be RFC-3339"
  }
}

`401` — Unauthorized

json

{
  "error": {
    "code": "unauthorized",
    "message": "invalid or revoked API key"
  }
}

`404` — NotFound

Id desconocido, mal formado (no UUID) O id de otro tenant: RLS devuelve cero filas, así que los tres son indistinguibles por diseño (sin fuga de existencia, nunca un 403 para ids ajenos).

json

{
  "error": {
    "code": "not_found",
    "message": "resource not found for this tenant"
  }
}

`409` — Conflict

Transición de estado no válida, conflicto de unicidad, o un asiento que está ocupado/reservado.

json

{
  "error": {
    "code": "conflict",
    "message": "invalid state transition"
  }
}

`429` — ApiKeyRateLimited

json

{
  "error": {
    "code": "rate_limited",
    "message": "API key request quota exceeded; retry after the interval in Retry-After"
  }
}

Cerrar un ticket

http

POST /v1/support/tickets/{id}/close

Parámetros

Nombre	En	Tipo	Obligatorio	Descripción
`id`	path	string (uuid)	sí	UUID del recurso. Los ids mal formados o de otro tenant se leen como `404`.

Respuestas

`200`

El ticket cerrado.

Campo	Tipo	Obligatorio	Descripción
`ticket`	any	sí

`401` — Unauthorized

json

{
  "error": {
    "code": "unauthorized",
    "message": "invalid or revoked API key"
  }
}

`404` — NotFound

Id desconocido, mal formado (no UUID) O id de otro tenant: RLS devuelve cero filas, así que los tres son indistinguibles por diseño (sin fuga de existencia, nunca un 403 para ids ajenos).

json

{
  "error": {
    "code": "not_found",
    "message": "resource not found for this tenant"
  }
}

`429` — ApiKeyRateLimited

json

{
  "error": {
    "code": "rate_limited",
    "message": "API key request quota exceeded; retry after the interval in Retry-After"
  }
}

Soporte ​

Endpoints ​

Los tickets de soporte del tenant ​

200 ​

400 — BadRequest ​

401 — Unauthorized ​

429 — ApiKeyRateLimited ​

Abrir un ticket de soporte ​

201 ​

400 — BadRequest ​

401 — Unauthorized ​

409 — Conflict ​

422 — Unprocessable ​

429 — ApiKeyRateLimited ​

Un ticket de soporte con su hilo ​

200 ​

401 — Unauthorized ​

404 — NotFound ​

429 — ApiKeyRateLimited ​

Añadir un mensaje a un ticket ​

201 ​

400 — BadRequest ​

401 — Unauthorized ​

404 — NotFound ​

409 — Conflict ​

429 — ApiKeyRateLimited ​

Cerrar un ticket ​

200 ​

401 — Unauthorized ​

404 — NotFound ​

429 — ApiKeyRateLimited ​

Soporte

Endpoints

Los tickets de soporte del tenant

`200`

`400` — BadRequest

`401` — Unauthorized

`429` — ApiKeyRateLimited

Abrir un ticket de soporte

`201`

`400` — BadRequest

`401` — Unauthorized

`409` — Conflict

`422` — Unprocessable

`429` — ApiKeyRateLimited

Un ticket de soporte con su hilo

`200`

`401` — Unauthorized

`404` — NotFound

`429` — ApiKeyRateLimited

Añadir un mensaje a un ticket

`201`

`400` — BadRequest

`401` — Unauthorized

`404` — NotFound

`409` — Conflict

`429` — ApiKeyRateLimited

Cerrar un ticket

`200`

`401` — Unauthorized

`404` — NotFound

`429` — ApiKeyRateLimited