GET
/
api
/
v1
/
outbound
/
batches

Authorizations

Syllable-API-Key
string
header
required

Query Parameters

page
integer | null
default:
0
Required range: x > 0
limit
integer
default:
25
Required range: x > 0
search_fields
enum<string>[]
Available options:
batch_id,
campaign_id,
status,
type,
source,
rate,
expires_on,
retry_count,
retry_interval
search_field_values
string[]
order_by
enum<string> | null
Available options:
batch_id,
campaign_id,
status,
type,
source,
rate,
expires_on,
retry_count,
retry_interval
order_by_direction
enum<string> | null
Available options:
asc,
desc
fields
enum<string>[] | null
Available options:
batch_id,
campaign_id,
status,
type,
source,
rate,
expires_on,
retry_count,
retry_interval
start_datetime
string | null
end_datetime
string | null

Response

200
application/json
batch_id
string
required

Unique ID for conversation batch

campaign_id
integer
required

Unique ID for campaign

type
string
required

Call, SMS, email

source
string
required

Source phone number, email, or SMS number

rate
integer
required

Target number of outreach calls per minute

last_updated_by
string
required

User who last updated campaign

expires_on
string | null

Timestamp of batch expiration

retry_count
integer
default:
0

Number of retries per target

retry_interval
string | null

How long (30m, 12h, 7d) to wait before retrying

status
enum<string>

Status of batch

Available options:
PENDING,
ACTIVE,
IDLE,
CANCELED,
COMPLETED
created_at
string

Timestamp of batch creation

deleted_at
string | null

Timestamp of batch deletion

deleted_reason
string | null

Reason for batch deletion

last_worked_on
string | null

Timestamp of last batch activity