API REFERENCEv1

List Campaign Messages

GEThttps://api2.protexting.com/v1/mms-toscreen/get-messages

⌘

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

Endpoint

1https://api2.protexting.com/v1/mms-to-screen/get-messages?access_token=<your_access_token>&campaign_id=<campaign_id>

Response parameters:

Parameter	Description
Id	Message Id, INTEGER
Mobile	Phone Number, STRING
Message	Message, STRING
Type	Type of message, STRING
Status_Id	Status of message, INTEGER
Status_Description	Status of message, STRING
Resource_File	URL to resource file, STRING
Resource_Type	Resource type, STRING
Date_Received	Date, STRING

Example Request:

Request example

1# Set PROTEXTING_ACCESS_TOKEN in your environment2curl --request GET \3  "https://api2.protexting.com/v1/mms-toscreen/get-messages?access_token=${PROTEXTING_ACCESS_TOKEN:?Set your API token}" \4  --header 'Accept: application/json'

Server-side exampleJSON · HTTPS

Example Response Headers:

Example

1Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
2Pragma: no-cache
3X-Rate-Limit-Limit: 60
4X-Rate-Limit-Remaining: 59
5X-Rate-Limit-Reset: 0
6X-Pagination-Total-Count: 10
7X-Pagination-Page-Count: 1
8X-Pagination-Current-Page: 1
9X-Pagination-Per-Page: 100
10Link: <https://api2.protexting.com/v1/mms-to-screen/get-messages?access_token=your_access_token&campaign_id=campaign_id>; rel=self
11Vary: Accept-Encoding,User-Agent
12Content-Length: 475
13Keep-Alive: timeout=15, max=100
14Connection: Keep-Alive
15Content-Type: application/json; charset=UTF-8

Example Response Body:

JSON response example

1[
2    {3        "Id":100,"Mobile":"1234567890",4        "Message":"Test Message",5        "Keyword":"Mykeyword",6        "Type":"Sms",7        "Status_Id":1,8        "Status_Description":"Pending",9        "Resource_File":"",10        "Resource_Type":"",11        "Date_Received":"2016-01-01 01:00:00"12    },13    {14        "Id":101,"Mobile":"1234567890",15        "Message":"Test Message 2",16        "Keyword":"Mykeyword2",17        "Type":"Sms",18        "Status_Id":1,19        "Status_Description":"Pending",20        "Resource_File":"",21        "Resource_Type":"",22        "Date_Received":"2016-01-01 02:00:00"23     }
24]

XML response example

1<response>
2    <item>3        <Id>100</Id>4        <Mobile>1234567890</Mobile>5        <Message>Test Message</Message>6        <Keyword>Mykeyword</Keyword>7        <Type>Sms</Type>8        <Status_Id>1</Status_Id>9        <Status_Description>Pending</Status_Description>10        <Resource_File/>11        <Resource_Type/>12        <Date_Received>2016-01-01 01:00:00</Date_Received>13    </item>14    <item>15        <Id>101</Id>16        <Mobile>1234567890</Mobile>17        <Message>Test Message 2</Message>18        <Keyword>Mykeyword 2</Keyword>19        <Type>Sms</Type>20        <Status_Id>1</Status_Id>21        <Status_Description>Pending</Status_Description>22        <Resource_File/>23        <Resource_Type/>24        <Date_Received>2016-01-01 02:00:00</Date_Received>25    </item>26</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 »

← PreviousList All Campaigns Next →List Campaign Queue Messages

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