Disposiciones

Generado desde DialerDigital/core commit 0fc18008b3c8 — especificación openapi/dialer-v1.yaml v0.134.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.

El conjunto de contrato dialer.v1.Disposition en grafía REST: el valor en minúsculas, el nombre de su enum y su número.

Endpoints

Método	Ruta	Resumen
GET	/v1/dispositions	Listar las disposiciones del contrato dialer.v1

Listar las disposiciones del contrato dialer.v1

GET /v1/dispositions

El enum dialer.v1.Disposition en grafía REST, una entrada por valor excepto DISPOSITION_UNSPECIFIED, ordenadas por number del enum. value es la forma en minúsculas que habla toda superficie REST (answered_human); enum y number son el nombre y el número propios del contrato, de modo que un consumidor del contrato protobuf puede mapear uno con el otro sin una tercera grafía. value es siempre enum sin su prefijo DISPOSITION_, en minúsculas.

Este es el conjunto CERRADO del contrato. La disposition de una fila de GET /v1/call_attempts, y el code de una regla de disposición, son un vocabulario abierto que se escribe literalmente, por lo que también pueden llevar códigos que no están listados aquí (abandoned, delivered, ai_conversation, invalid_number, ...). El catálogo no los restringe.

La lista es la misma para todos los tenants y no contiene datos de ningún tenant.

Respuestas

200

El catálogo.

Campo	Tipo	Obligatorio	Descripción
dispositions	arreglo de DispositionCatalogEntry	sí
dispositions[].value	string	sí	La grafía REST, por ejemplo answered_human.
dispositions[].enum	string	sí	El nombre del enum dialer.v1.Disposition, por ejemplo DISPOSITION_ANSWERED_HUMAN.
dispositions[].number	integer	sí	El número del enum en dialer.v1.
dispositions[].description	string	sí

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.

{
  "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 (core#2503) (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-*.

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