POST GET sms/recipientsSummary

Get summary metrics for a given SMS

* required

Parameters

Name	Type	Description
smsID *	integer	Unique ID of an SMS

Response Data

Name

Type

Description

recipients

integer

Total SMS recipients

unsubscribes

integer

Recipients that opted out after receiving the SMS

deliveryStatuses

object

Delivered	integer	Recipients sent the SMS with confirmed delivery
Failed	integer	Recipients that were not sent the SMS due to an error
Pending Confirmation	integer	Recipients sent the SMS and pending delivery confirmation
Queued	integer	Recipients queued to be sent the SMS
Unknown	integer	Recipients sent the SMS but never confirmed delivery

Permissions

Method requires the SMS Viewer permission

Example Calls

GET

/sms/recipientsSummary?smsID=123

cURL

Copy

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

Response Data

{"data":{"recipients":25,"unsubscribes":0,"deliveryStatuses":{"Failed":4,"Delivered":16,"Queued":0,"Pending Confirmation":0,"Unknown":5}},"success":1,"code":0,"requestID":"F98D5F0E-72A5-4A0B-994FCC79725366F7"}

API Console

The console uses production data, so BE CAREFUL!

GET

sms/recipientsSummary

Param	Value	Type	Description
smsID *		integer	Unique ID of an SMS

Access token: *