List Messages


URL:

https://api2.protexting.com/v1/inbox/index?access_token=your_access_token


Method:

GET

Request parameters:

Parameter Description
Type_Id  Integer (Messages Type) »
Keyword_Id  Integer (Keyword ID) see here »
Campaign_Id  Integer,(Campaign ID) see here »

Response parameters:

Parameter Description
MobilePhone String
Message String
DateReceived Date Time
AppName String
CampaignName String
Type_Id Integer  »
Type_Description String  »
Resource_Urls Object
Groups Object

Example Request:

curl -i -H "Accept:application/json" "https://api2.protexting.com/v1/inbox/index?access_token=your_access_token"

 

Example Response Headers:

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/inbox/?access_token=your_access_token&page=1>; 
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: 10 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:

[
    {
    	"MobilePhone": "16461234567",
        "Message": "Hello World!",
"DateReceived":"2016-01-01 10:10:10",
"AppName":"Auto Replay",
"CampaignName":"",
"Type_Id": 1,
"Type_Description": "SMS",
"Resource_Urls": [],
"Groups":[{
"Id": 100,
"Name": "My Group"
}] },
... ]
<response>
    <item>
    	<MobilePhone>16461234567</MobilePhone>
        <Message>Hello World!</Message>
<DateReceived>2016-01-01 10:10:10</DateReceived>
<AppName>Auto Replay</AppName>
<CampaignName></CampaignName>
<Type_Id>1</Type_Id>
<Type_Description>SMS</Type_Description>
<Resource_Urls></Resource_Urls>
<Groups></Groups> </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 »

 

Type's messages:

Type_Id Type_Description
1 SMS
2 MMS