API Reference
API Reference

List Outbound Communication Batches

GET/api/v1/outbound/batches

Authentication

Syllable-API-Keyrequired

Send Syllable-API-Key in the header.

Need a credential? Create or manage an API token in the Syllable Console.

Parameters

Query parameters

page integer | null query optional

The page number from which to start (0-based)

Default 0Minimum 0Example 0
limit integer query optional

The maximum number of items to return

Default 25Minimum 0Example 25
search_fields enum<string>[] query optional

String names of fields to search. Correspond by index to search field values

Default []Example name
Item schema
itemsenum<string>required
Allowed values ["batch_id","campaign_id","status","expires_on","last_updated_at"]
search_field_values string[] query optional

Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list

Default []Example Some Object Name
Item schema
itemsstringrequired
order_by enum<string> | null query optional

The field whose value should be used to order the results

Allowed values ["batch_id","campaign_id","status","expires_on","last_updated_at"]Example name
order_by_direction enum<string> | null query optional

The direction in which to order the results

Allowed values ["asc","desc"]
fields enum<string>[] | null query optional

The fields to include in the response

Default []Example []
Item schema
itemsenum<string>required
Allowed values ["batch_id","campaign_id","status","expires_on","last_updated_at"]
start_datetime string | null query optional

The start datetime for filtering results

Example 2023-01-01T00:00:00Z
end_datetime string | null query optional

The end datetime for filtering results

Example 2024-01-01T00:00:00Z

Responses

200Successful Response

application/json

response ListResponse_CommunicationBatch_ required
5 fields
itemsCommunicationBatch[]required

List of items returned from the query

Item schema
itemsCommunicationBatchrequired
16 fields
batch_idstringrequired

Unique ID for conversation batch

campaign_idintegerrequired

Unique ID for campaign

expires_onstring (date-time) | nulloptional

Timestamp of batch expiration

pausedboolean | nulloptional

Whether the batch is on HOLD. When on HOLD, no outreach will be made.

call_rateinteger | nulloptional

Target number of outreach attempts per hour for this batch. When omitted, the batch inherits the campaign's hourly_rate.

Minimum 1Maximum 3600
auto_call_ratebooleanoptional

Pace this batch automatically to finish before expires_on, counting only the campaign's valid hours (daily_start_time..daily_end_time on active_days). The derived rate takes precedence over call_rate and over the campaign hourly_rate. Requires expires_on.

Default false
statusenum<string>optional

Status of batch

Allowed values ["PENDING","ACTIVE","PAUSED","FAILED","CANCELED","EXPIRED"]Default PENDING
auto_call_rate_baselinenumber | nulloptional

Read-only. The auto-paced rate first computed for this batch, set on its first dialing cycle. Subsequent cycles hold the rate within +/- 20% of it. Null until the batch has dialed, or when auto_call_rate is off.

upload_filenamestring | nulloptional

Name of file used to create batch

dispatch_idstring | nulloptional

A unique identifier for dipatched job

created_atstring (date-time)optional

Timestamp of batch creation

deleted_atstring (date-time) | nulloptional

Timestamp of batch deletion

deleted_reasonstring | nulloptional

Reason for batch deletion

last_updated_atstring (date-time) | nulloptional

Timestamp of last change to batch

last_updated_bystringrequired

Email of user who last updated campaign

error_messagestring | nulloptional

Error message if batch upload failed

pageintegerrequired

The page number of the results (0-based)

page_sizeintegerrequired

The number of items returned per page

total_pagesinteger | nulloptional

The total number of pages of results given the indicated page size

total_countinteger | nulloptional

The total number of items returned from the query

Response example
{
  "items": [
    {
      "batch_id": "string",
      "campaign_id": 0,
      "expires_on": "string",
      "paused": "string",
      "call_rate": "string",
      "auto_call_rate": false,
      "status": "PENDING",
      "auto_call_rate_baseline": "string",
      "upload_filename": "string",
      "dispatch_id": "string",
      "created_at": "string",
      "deleted_at": "string",
      "deleted_reason": "string",
      "last_updated_at": "string",
      "last_updated_by": "string",
      "error_message": "string"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_pages": "string",
  "total_count": "string"
}
422Validation Error

application/json

response HTTPValidationError required
1 field
detailValidationError[]optional
Item schema
itemsValidationErrorrequired
3 fields
locstring | integer[]required
Item schema
itemsstring | integerrequired
2 options
Option 1stringrequired
Option 2integerrequired
msgstringrequired
typestringrequired
Response example
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}