v1

latestSwagger 2.02026-08-06114161439.7 KB
SMS Broadcast

Get all broadcast lists for an org unit

Returns a list of broadcasts with pagination and filtering options

get/broadcasts

Query parameters

pageinteger

1-based page number for paginated results. Integer, default 1, min 1. Alternative to offset; used by SMS Broadcast endpoints.

limitinteger

Maximum number of records to return per page. Integer, default 100, max 2000, min 1.

filterstring[]

Comma separated list of field column name with conditional (=, !=, <=, >=, >, <, like) followed by the value to compare against, Please make sure to add spaces after and before while using "like" operator example "agent_name like test_name". Filterable fields include agent_name, status, broadcast_name. e.g. "broadcast_name like test", "status = scheduled", "agent_name != John Doe"

timezonestring string

To be used in conjunction with the filter param call_started field. Allows the user to specify which timezone is being used for the call_started filter value. Example value: "America/New_York"

Response

An array of broadcast lists

broadcast_idinteger

Broadcast conversation ID

broadcast_namestring

Name of the broadcast

agent_namestring

Agent name

messages_sentinteger

Number of messages sent

responsesinteger

Number of responses received

created_atstring date-time

Creation timestamp