API REFERENCEv1

List Sent Group Campaigns

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

⌘

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

List Sent Group Campaigns

Response parameters:

Parameter	Description
Id	Integer
CampaignName	String
Message	String
DateTime	String
ContactsCount	Integer
Type_Id	Integer see here »
Type_Description	String see here »
MmsTemplateId	Integer, see here »
Subject	String

Example Request:

Request example

1# Set PROTEXTING_ACCESS_TOKEN in your environment2curl --request GET \3  "https://api2.protexting.com/v1/sent-history/group-list?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-list?access_token=your_access_token&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    	"Id": 1001,
4        "CampaignName": "Campaign Name",5        "Message": "Hello World!",6        "DateTime": "2018-01-30 12:12:00",7        "ContactsCount": 10,8        "Type_Id": 1,9        "Type_Description": "SMS",10        "MmsTemplateId": "",11        "Subject": ""12        
13    },
14    {
15    	.........
16    }
17]

XML response example

1<response>
2    <item>
3    	<Id>10001</Id>
4        <CampaignName>Campaign Name</CampaignName>5        <Message>Hello World!</Message>6        <DateTime>2018-01-30 12:12:00</DateTime>7        <ContactsCount>10</ContactsCount>8        <Type_Id>1</Type_Id>9        <Type_Description>SMS</Type_Description>10        <MmsTemplateId/>11        <Subject/>
12    </item>
13    <item>14    .................15    </item>
16</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 »

Messages type:

Type_Id	Type_Description
1	SMS
2	MMS

Resource File Requirements
File type: jpg, gif, bmp, png, tiff
Recommended audio length: no more than 60 seconds
Keep at a high bitrate
Size: 70.00MB
Do not support animated GIF files

← PreviousDelete Scheduled Single SMS & MMS Next →List Sent Group Campaign Contacts

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