API REFERENCEv1

List Scheduled Single SMS & MMS

GEThttps://api2.protexting.com/v1/sms/single-schedule-messages

⌘

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

Response parameters:

Parameter	Description
Id	Integer
MobilePhone	String
Message	String
DateTime	String
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 GET \3  "https://api2.protexting.com/v1/sms/single-schedule-messages?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/json; charset=utf-8
5Keep-Alive: timeout=5, max=100
6Link: <https://api2.protexting.com/v1/sms/single-schedule-messages?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        "MobilePhone":"16461234567",5        "Message":"Hello World!"
6        "DateTime": "2021:01:11 10:05:00",7        "Status_Id" : "3",8        "Status_Description": "Approved and Scheduled", 9        "Type_Id": 1, 10        "Type_Description": "SMS", 11        "MmsTemplateId": "", 12        "Subject": ""
13    },14    ........
15]

XML response example

1<response>2 3   <item>4       <Id>12345</Id> 5       <MobilePhone>16461234567</MobilePhone>6       <Message>Hello World!</Message>7       <DateTime>2021:01:11 10:05:00</DateTime>8       <Status_Id>3</Status_Id>9       <Status_Description>Approved and Scheduled</Status_Description>10       <Type_Id>1</Type_Id>11       <Type_Description>SMS</Type_Description>12       <MmsTemplateId></MmsTemplateId>13       <Subject></Subject>14    </item>15    <item>16    .........17    </item>18</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 »

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

← PreviousSchedule Single SMS & MMS Next →Delete Scheduled Single SMS & MMS

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