URL:
https://api2.protexting.com/v1/sms/send-group-schedule-message?access_token=your_access_token
Method:
POST
* 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 » |
| 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 |
curl -i -H "Content-Type:application/json" -XPOST "https://api2.protexting.com/v1/sms/send-group-schedule-message?access_token=your_access_token" -d '{"Message":"Hello World!","GroupIds":["100","101"]}'
Status Code: 200 OK Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0 Connection: Keep-Alive Content-Type: application/json; charset=utf-8 Keep-Alive: timeout=5, max=100 Link: <https://api2.protexting.com/v1/sms/send-group-schedule-message?access_token=your_access_token>;
rel=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
[
{
"Id": "12345",
"CampaignName": "Test Campaign",
"Message": "Hello World!",
"DateTime": "2018-01-01 10:10:10",
"GroupIds": ["100","101"],
"TypeRecipients": 0,
"ContactsCount": "150",
"Status_Id": 3,
"Status_Description": "Approved and Scheduled",
"Type_Id": 1,
"Type_Description": "SMS",
"MmsTemplateId": "",
"Subject": ""
}
]
<response>
<item>
<Id>12345</Id>
<CampaignName>Test Campaign</CampaignName>
<Message>Hello World!</Message>
<DateTime>2018-01-01 10:10:10</DateTime>
<ContactsCount>150</ContactsCount>
<GroupIds>
<item>100</item>
<item>101</item>
</GroupIds>
<TypeRecipients>0</TypeRecipients>
<ContactsCount>150</ContactsCount>
<Status_Id>3</Status_Id>
<Status_Description>Approved and Scheduled</Status_Description>
<Type_Id>1</Type_Id>
<Type_Description>SMS</Type_Description>
<MmsTemplateId/>
<Subject/>
</item>
</response>
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 and Examples here »
| Value | Description |
|---|---|
| 1 | Double opt-in Contacts |
| 0 | Single opt-in Contacts |
| Status_Id | Status_Description |
|---|---|
| 1 | Pending |
| 2 | Action Required |
| 3 | Approved and Scheduled |
| 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 |