Error codes

campaign_recipients_unavailable

HTTP status: 503
Retry: After Retry-After
Execution: Nothing was done
Admin needed: No

Recipients could not be checked. Starting again or resuming re-screens recipients. The recipient list could not be read completely, so the API refused rather than dial anyone unscreened.

What it means

The API returns HTTP 503 with error.code set to campaign_recipients_unavailable. The default message is: "The campaign's recipients could not be read for screening right now, so nothing was dialled."

Common causes

A temporary failure reading the recipient list.

How to identify it

Check the response status (503) and error.code (campaign_recipients_unavailable). Branch on error.code, not on the message text: messages can be reworded, codes do not change within v1. Log error.request_id (also sent as the X-Request-Id header) so support can find the request.

How to fix it

Wait Retry-After seconds and retry (with the same Idempotency-Key if you sent one).

Retry guidance

Wait for the number of seconds in the Retry-After response header, then retry.

Did anything happen?

This request was refused before any call was placed and before anything was charged.

Idempotency

Nothing was dialled. Retry (with the same key if you sent one).

Who can fix it

The developer who sends the request can fix it; no administrator action is normally needed.

When to contact support

If it persists for more than a few minutes, write to support@relationsai.com with the request_id. See Support for what to include (the request_id, the time in UTC, the operation, and whether you used a test or live key) and what never to send (API keys, Authorization headers, webhook signing secrets, recording links, transcripts or customer data).

Example error response

JSON
{
  "error": {
    "code": "campaign_recipients_unavailable",
    "message": "The campaign's recipients could not be read for screening right now, so nothing was dialled.",
    "details": {},
    "request_id": "req_sgqkigvfg7na6jm4ot2nnocl",
    "retry": "after",
    "doc_url": "https://docs.relationsai.com/errors/campaign_recipients_unavailable"
  }
}

Operations that can return this error

POST /campaigns/{campaign_id}/start: Start a campaign
POST /campaigns/{campaign_id}/resume: Resume a campaign

See all codes in the error-code reference.

internal_error service_unavailable