API REFERENCEv1
View Sent Single Message
GET
https://api2.protexting.com/v1/sent-history/single-view⌘
Pass your server-side token as access_token. Replace sample values with your own. Authentication & setup →
View Sent Single Message
Request parameters:
* required parameters
| Parameter | Description |
|---|---|
| * id | Integer, Sent Single Message Id |
Response parameters:
| Parameter | Description |
|---|---|
| Id | Integer |
| MobilePhone | String |
| Message | String |
| DateTime | String |
| Type_Id | Integer see here » |
| Type_Description | String see here » |
| MmsTemplateId | Integer, see here » |
| Subject | String |
| DeliveryStatus_Id | Integer see here » |
| DeliveryStatus_Description | String see here » |
| Api_Id | String more info » |
Example Request:
Request example
# Set PROTEXTING_ACCESS_TOKEN in your environmentcurl --request GET \ "https://api2.protexting.com/v1/sent-history/single-view?id=%3Csent_single_message_id%3E&access_token=${PROTEXTING_ACCESS_TOKEN:?Set your API token}" \ --header 'Accept: application/json'Example Response Headers:
Response headers example
Status Code: 200 OK
Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
Connection: Keep-Alive
Content-Type: application/xml; charset=utf-8
Keep-Alive: timeout=5, max=100
Link: <https://api2.protexting.com/v1/sent-history/single-view?access_token=your_access_token&id=<sent_single_message_id>>; rel=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: 0Example Response Body:
JSON response example
{
"Id": 1001,
"MobilePhone": "1646595xxxx", "Message": "Hello World!", "DateTime": "2018-01-30 12:12:00", "Type_Id": 1, "Type_Description": "SMS", "MmsTemplateId": "", "Subject": "", "DeliveryStatus_Id": 2, "DeliveryStatus_Description": "Delivered", "Api_Id":""}XML response example
<response>
<item>
<Id>10001</Id>
<MobilePhone>1646595xxxx</MobilePhone> <Message>Hello World!</Message> <DateTime>2018-01-30 12:12:00</DateTime> <Type_Id>1</Type_Id> <Type_Description>SMS</Type_Description> <MmsTemplateId/> <Subject/> <DeliveryStatus_Id>2</DeliveryStatus_Id> <DeliveryStatus_Description>Delivered</DeliveryStatus_Description> <Api_Id/>
</item>
</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 |
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 |
| 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 |
Reference from the ProTexting documentation catalog. Code examples are illustrative; this page does not execute API requests.