API Reference

Text recipients and status

get
https://production-api.shoutaboutus.com/api/v1/campaign//recipients/sms

Get each text (SMS) recipient of a campaign with their status: one row per text request, newest first, 10 per page unless you set limit. The page object is returned at the top level, not wrapped in data.

Prerequisites: a bearer token and the campaign's id (campaignId).

Authentication: Account token: only account users (others get 403). The campaign must belong to the caller's own company; otherwise 404.

Rate limit: 60 requests per minute, counted per user (the token’s user).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
Defaults to 4823

Required. The campaign's id (digits only). It must belong to your own company.

Query Params
string
enum
Defaults to clicked

Only rows at this stage: processed, pending, sent, delivered, clicked, failed. pending and failed match the status; the others match rows that reached that step (clicked: the link was clicked).

Allowed:
string
enum
Defaults to phone_number

Field to search: phone_number, status, message_id. Leave it out to search all three.

Allowed:
string
Defaults to 555

Text to search for (contains), up to 255 characters.

string
enum
Defaults to created_at

Column to sort by. Default created_at.

string
enum
Defaults to desc

Sort direction: asc or desc (either case). Default desc.

Allowed:
integer
Defaults to 10

Rows per page, 10 to 100. Values below 10 are raised to 10; above 100 returns 422. Default 10.

integer
Defaults to 1

Page number, from 1. Default 1.

Responses

Updated 18 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 18 days ago

Did this page help you?