Dispositions

Generated from DialerDigital/core commit 0fc18008b3c8 — spec openapi/dialer-v1.yaml v0.134.0. Do not edit by hand; see How this reference is built. Download the OpenAPI spec.

Español

The dialer.v1.Disposition contract set in REST spelling: the lowercase value, its enum name and number.

Endpoints

Method	Path	Summary
GET	/v1/dispositions	List the dispositions of the dialer.v1 contract

List the dispositions of the dialer.v1 contract

GET /v1/dispositions

The dialer.v1.Disposition enum in REST spelling, one entry per value except DISPOSITION_UNSPECIFIED, ordered by enum number. value is the lowercase form every REST surface speaks (answered_human); enum and number are the contract's own name and number, so a consumer of the protobuf contract can map one to the other without a third spelling. value is always enum without its DISPOSITION_ prefix, lowercased.

This is the contract's CLOSED set. The disposition of a row of GET /v1/call_attempts, and the code of a disposition rule, are an open vocabulary written verbatim, so they can also carry codes that are not listed here (abandoned, delivered, ai_conversation, invalid_number, ...). The catalog does not narrow them.

The list is the same for every tenant and carries no tenant data.

Responses

200

The catalog.

Field	Type	Required	Description
dispositions	array of DispositionCatalogEntry	yes
dispositions[].value	string	yes	The REST spelling, for example answered_human.
dispositions[].enum	string	yes	The dialer.v1.Disposition enum name, for example DISPOSITION_ANSWERED_HUMAN.
dispositions[].number	integer	yes	The enum number in dialer.v1.
dispositions[].description	string	yes

401 — Unauthorized

Missing, unknown or revoked API key (or, on /v1/admin/*, a bad/unset admin token; on webhooks, a bad/missing signature). A dashboard session (ddu_) that a newer login of the same person ended answers the code session_superseded instead (tenant flag single_session_enforced), so the screen can say why it was signed out; a logout, an expired or an unknown token stay unauthorized.

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

429 — ApiKeyRateLimited

This API key is over its request quota, or the tenant's keys together are over the tenant ceiling (core#2503) (code rate_limited). The request was not processed. Wait Retry-After seconds and retry; a refusal is not counted against the budget, so that wait is always enough. Bounded per API key and, above the keys, per tenant (api_tenant_requests_per_minute): a sibling key is unaffected until the tenant's keys together reach that ceiling. The quota applies to every operation reachable with a dd_ key, so the operations that name a more specific 429 (call control, dispositions, SMS, …) can ALSO answer this one with its X-RateLimit-* headers.

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