Get person text message log

get

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

Retrieve the text messages sent to or received from the given person. Private, giving-related campaign messages are hidden unless you have the Full Read Contributions permission.

Required permission: Full Read SMS Logs

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

≥ 1

The id of the person.

Query Params

fromName

string

Return messages whose sender name contains the given text.

fromNumber

string

Return messages sent from a phone number containing the given digits.

message

string

Return messages whose body contains the given text.

status

string

Comma-delimited list of delivery status ids: 1 = Sent, 2 = Delivered, 3 = Expired, 4 = Failed.

cost.start

double

Return messages costing at least this amount.

cost.end

double

Return messages costing at most this amount.

sentOn.start

date-time

Return messages sent on or after this date.

sentOn.end

date-time

Return messages sent on or before this date.

sentBy

string

Return messages sent by the given user name.

direction

string

Comma-delimited list of directions to include: 1 = received (incoming), 2 = sent (outgoing).

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