Search text campaigns

get

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

Retrieve sent and received text messages with their delivery statistics. Requires permission to view text messaging; without permission to view text logs, only campaigns the signed-in user sent or replies to are returned. Private, giving-related campaigns are hidden unless you have the Full Read Contributions permission.

Required permission: Limited SMS

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

entry

int32

≥ 1

The id of a campaign. Returns only that campaign.

from

string

Return campaigns whose sending number or sender's name contains the given text.

recipient

string

Return campaigns sent to a recipient whose number or name contains the given text.

involving

string

Return campaigns where either the sender or a recipient matches the given text.

message

string

Return campaigns whose message contains the given text.

incoming

boolean

When true, return only incoming (received) messages; when false, only outgoing campaigns.

automated

boolean

When true, return only automated (system-sent) campaigns; when false, only manually composed ones.

string

Return campaigns sent by a user whose name contains the given text.

cost.start

double

Return campaigns costing at least this amount.

cost.end

double

Return campaigns costing at most this amount.

openRate.start

double

Return campaigns with a delivery rate of at least this percentage.

openRate.end

double

Return campaigns with a delivery rate of at most this percentage.

timestamp.start

date-time

Return campaigns sent on or after this date.

timestamp.end

date-time

Return campaigns sent on or before this date.

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.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200OK