Skip to main content
GET
Get a batch call

Authorizations

Authorization
string
header
required

A Bearer token. Create keys in the portal under Settings > API keys (https://app.ryvo.so/developers). The token has the form ryvo_live_<64 hex characters> and is shown once.

Header: Authorization: Bearer ryvo_live_...

Path Parameters

id
string<uuid>
required

The Ryvo uuid of the batch call.

Response

The batch with its recipients.

id
string<uuid> | null
required

null only if the provider accepted the batch but Ryvo could not record it; use provider_batch_id to find it later.

Example:

"2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f"

provider_batch_id
string
required
Example:

"btcal_01abcdef"

name
string
required
Example:

"September follow-ups"

status
enum<string>
required
Available options:
pending,
in_progress,
completed,
cancelled,
failed
Example:

"in_progress"

agent
object | null
required
provider_agent_id
string
required
Example:

"agent_8801kpabc123"

phone_number_id
string<uuid> | null
required
provider_phone_number_id
string | null
required
Example:

"phnum_01abcdef"

scheduled_at
string<date-time> | null
required
totals
object
required
created_at
string<date-time>
required
last_synced_at
string<date-time> | null
required
retry_count
integer
required
concurrency
integer | null
required
recipients
object[]
required