POST GET sms/recipients

Get recipients for a given SMS

* required

Parameters

Name	Type	Description
smsID *	integer	Unique ID of an SMS
page	integer	Number of page in results to return Default: 1 Min: 1
rpp	integer	Number of records to return per page Default: 50 Min: 1 Max: 250

Response Data

Name	Type	Description
contactID	integer	ID of contact
firstName	string
lastName	string
mobileNumber	string
deliveryStatus	string	Status of delivery to the recipient
unsubscribed	boolean	Recipient opted out after receiving the SMS
dateSent	datetime	Date SMS was sent to the recipient

Permissions

Method requires the SMS Viewer permission

Example Calls

Get all recipients

GET

/sms/recipients?smsID=123

cURL

Copy

curl https://api.emailer.emfluence.com/v1/sms/recipients?smsID=123 \
	-H "Authorization: Bearer {{accessToken}}"

Response Data

{"success":1,"data":{"records":[{"contactID":123,"firstName":"John","lastName":"Doe","deliveryStatus":"Delivered","unsubscribed":false,"mobileNumber":"+18165551234","dateSent":"2023-07-31 12:00:00"},{"contactID":456,"firstName":"Jane","lastName":"Doe","deliveryStatus":"Delivered","unsubscribed":false,"mobileNumber":"+18165556789","dateSent":"2023-07-31 12:01:00"}],"paging":{"totalPages":1,"next":"","rpp":50,"prev":"","page":1,"totalRecords":2}},"code":0,"requestID":"C361331E-DCAA-4A2D-BEBCCE2F9E70365A"}

API Console

The console uses production data, so BE CAREFUL!

GET

sms/recipients

Param	Type	Description
smsID *	integer	Unique ID of an SMS
page	integer	Number of page in results to return Default: 1 Min: 1
rpp	integer	Number of records to return per page Default: 50 Min: 1 Max: 250

Access token: *