API REFERENCEv1

Schedule Group SMS & MMS Campaigns

POSThttps://api2.protexting.com/v1/sms/send-group-schedule-message

⌘

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

Request parameters:

* required parameters

Parameter	Description
* Message	String
* GroupIds	Object, see here »
CampaignName	String
DateTime	DateTime
MmsTemplateId	Integer, see here »
MmsHighResolution	Integer, 0 or 1, option to add short URL link in MMS, to view MMS in browser
Subject	String
TypeRecipients	Integer »

Response parameters:

Parameter	Description
Id	Integer
CampaignName	String
Message	String
DateTime	String
GroupIds	Object, see here »
TypeRecipients	Integer
ContactsCount	Integer
Status_Id	Integer, see here »
Status_Description	String, see here »
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 POST \3  "https://api2.protexting.com/v1/sms/send-group-schedule-message?access_token=${PROTEXTING_ACCESS_TOKEN:?Set your API token}" \4  --header 'Accept: application/json' \5  --header 'Content-Type: application/json' \6  --data '{7  "Message": "Hello World!",8  "GroupIds": [9    "100",10    "101"11  ]12}'

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/json; charset=utf-8
5Keep-Alive: timeout=5, max=100
6Link: <https://api2.protexting.com/v1/sms/send-group-schedule-message?access_token=your_access_token>; 7rel=self Pragma: no-cache Transfer-Encoding: chunked  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": "12345",4        "CampaignName": "Test Campaign",5        "Message": "Hello World!",
6        "DateTime": "2018-01-01 10:10:10",7        "GroupIds": ["100","101"],8        "TypeRecipients": 0,9        "ContactsCount": "150",10        "Status_Id": 3,11        "Status_Description": "Approved and Scheduled",12        "Type_Id": 1,13        "Type_Description": "SMS",14        "MmsTemplateId": "",15        "Subject": ""16    }
17]

XML response example

1<response>
2    <item>
3    	<Id>12345</Id>4        <CampaignName>Test Campaign</CampaignName>5        <Message>Hello World!</Message>6        <DateTime>2018-01-01 10:10:10</DateTime>7        <ContactsCount>150</ContactsCount>8        <GroupIds>9            <item>100</item>10            <item>101</item>11        </GroupIds>12        <TypeRecipients>0</TypeRecipients>13        <ContactsCount>150</ContactsCount>14        <Status_Id>3</Status_Id>15        <Status_Description>Approved and Scheduled</Status_Description>16        <Type_Id>1</Type_Id>17        <Type_Description>SMS</Type_Description>18        <MmsTemplateId/>19        <Subject/>
20    </item>
21</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 »

Type Recipients

Value	Description
1	Double opt-in Contacts
0	Single opt-in Contacts

Statuses

Status_Id	Status_Description
1	Pending
2	Action Required
3	Approved and Scheduled

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

← PreviousDelivery Reports Next →List Scheduled Group SMS & MMS Campaigns

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