Get a COD confirmation
Read current answers and the refusal check, if present. Rescheduling can finish with partial choices or a note, so date and time range may be null. Later customer answers can change completed confirmation states. The failure slot exposes the most recently failed confirmation or refusal check.
Unknown query parameters are rejected. Omit the request body; only an absent body or an empty object is accepted.
Responses
| Status | Meaning and codes |
|---|---|
| 200 | Current confirmation status and details in your workspace. |
| 401 | Problem Details. Codes: API_KEY_INVALID. |
| 404 | Problem Details. Codes: COD_CONFIRMATION_NOT_FOUND. |
| 422 | Problem Details. Codes: DEVELOPER_INVALID_INPUT. |
| 429 | Problem Details. Codes: RATE_LIMITED. Retry-After: 1 is present only for RATE_LIMITED; quota errors do not include it. |
Success and handled error responses send Cache-Control: no-store and X-Correlation-ID (the resolved/generated UUID). Errors use application/problem+json and the reusable ProblemDetails schema below. Retry-After: 1 is sent only for RATE_LIMITED. Request examples read your key from a server environment variable; replace all fictional values.
Schemas and examples
ApiKeyAuthorizationBearer <token>Server-side API key. publicId is 12 lowercase base32 characters (a-z, 2-7); secret is 43 base64url characters from 32 random bytes. Use Authorization: Bearer <complete key>. The API key determines the workspace; requests cannot select another workspace. All public routes share 20 requests per second per key. See API-key authentication.
confirmationId*stringConfirmation ID in your workspace, returned when you create a COD confirmation.
uuidX-Correlation-ID?stringOptional tracing ID. A UUID-shaped value is echoed in the response. Missing or invalid values are replaced with a generated UUID, not rejected.
Current confirmation status and details in your workspace.
application/json- response
confirmationId*stringConfirmation UUID.
uuidreference*stringCaller order reference.
to*stringNormalized E.164 recipient.
status*stringCurrent confirmation state.
"accepted""awaiting_answer""confirmed""cancelled""rescheduling""rescheduled""no_response""failed"answeredAt*|Answer/completion time, including partial follow-up expiry.
date-timereschedule*|nullrefusalCheck*|nullfailure*|Most recently failed confirmation or refusal check, or null.
createdAt*stringConfirmation creation time.
date-time