Search text recipients

get

https://{tenant}.onechurchsoftware.com/api/sms/campaigns/{id}/recipients

Retrieve the recipients of a sent text message, with each recipient's delivery outcome.

Required permission: Limited SMS

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

≥ 1

The id of the campaign.

Query Params

name

string

Text matched against the recipient's names and aliases. When multiple words are given, every word must match.

phone

string

Return recipients whose phone number contains the given digits.

status

string

Comma-delimited list of outcomes: sent, delivered, failed.

skip

int32

≥ 0

The number of records to skip before returning results, used for paging.

limit

int32

≥ 0

The maximum number of records to return per page. Defaults to 50.

sort.property

string

The field to sort the results by. The default field depends on the endpoint.

sort.dir

string

enum

The sort direction: "asc" or "desc".

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

200OK