API REFERENCEv1

List Sent Group Campaign Contacts

GEThttps://api2.protexting.com/v1/sent-history/group-contacts

⌘

Pass your server-side token as access_token. Replace sample values with your own. Authentication & setup →

List Sent Group Campaign Contacts

Request parameters:

* required parameters

Parameter	Description
* id	Integer, Campaign ID
number	String, filtered by Phone Number

Response parameters:

Parameter	Description
Number	String
DeliveryStatus_Id	Integer
DeliveryStatus_Description	String

Example Request:

Request example

1# Set PROTEXTING_ACCESS_TOKEN in your environment2curl --request GET \3  "https://api2.protexting.com/v1/sent-history/group-contacts?id=%3Ccampaign_id%3E&access_token=${PROTEXTING_ACCESS_TOKEN:?Set your API token}" \4  --header 'Accept: application/json'

Server-side exampleJSON · HTTPS

Example Response Headers:

Response headers example

1Status Code: 200 OK
2Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
3Connection: Keep-Alive
4Content-Type: application/xml; charset=utf-8
5Keep-Alive: timeout=5, max=100
6Link: <https://api2.protexting.com/v1/sent-history/group-contacts?access_token=your_access_token&id=<campaign_id>&page=1>; 7rel=self Pragma: no-cache Transfer-Encoding: chunked X-Pagination-Current-Page: 1 X-Pagination-Page-Count: 1 X-Pagination-Per-Page: 100 X-Pagination-Total-Count: 1 X-Powered-By: PHP/5.6.2 X-Rate-Limit-Limit: 60 X-Rate-Limit-Remaining: 59 X-Rate-Limit-Reset: 0

Example Response Body:

JSON response example

1[
2    {
3    	"Number": 1646595xxxx,
4        "DeliveryStatus_Id": 2,5        "DeliveryStatus_Description": "Delivered"6        
7    },
8    {
9    	.........
10    }
11]

XML response example

1<response>
2    <item>
3    	<Number>1646595xxxx</Number>
4        <DeliveryStatus_Id>2</DeliveryStatus_Id>5        <DeliveryStatus_Description>Delivered</DeliveryStatus_Description>
6    </item>
7    <item>8    .................9    </item>
10</response>

HTTP Status Codes:

The standard HTTP Status Codes are used. More information is available here: http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml

Error Codes:

Error Codes and Examples here »

Delivery statuses:

Delivery Status Id	Delivery Status Description
1	Pending
2	Delivered
3	Failed
4	Bufered
5	Rejected
6	Optout
7	Unknown
8	Disconected
9	Optedout
10	Processed
11	Retrieved
12	Expired

← PreviousList Sent Group Campaigns Next →List Sent Single Messages

Reference from the ProTexting documentation catalog. Code examples are illustrative; this page does not execute API requests.