API REFERENCEv1

List All Campaigns

GEThttps://api2.protexting.com/v1/mms-to-screen/index

⌘

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/index?access_token=<your_access_token>

Response parameters:

Parameter	Description
Id	Campaign Id, INTEGER
Title	Campaign Name, STRING
Keywords	Keywords Names, STRING
StartDate	Campaign Start Date, STRING
EndDate	Campaign End Date, STRING
Status	Campaign's status, STRING

Example Request:

Request example

1# Set PROTEXTING_ACCESS_TOKEN in your environment2curl --request GET \3  "https://api2.protexting.com/v1/mms-to-screen/index?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 OK2Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=03Pragma: no-cache4X-Rate-Limit-Limit: 605X-Rate-Limit-Remaining: 596X-Rate-Limit-Reset: 07X-Pagination-Total-Count: 108X-Pagination-Page-Count: 19X-Pagination-Current-Page: 110X-Pagination-Per-Page: 100Link: <https://api2.protexting.com/v1/mms-to-screen/index?access_token=your_access_token>; rel=self11Vary: Accept-Encoding,User-Agent12Content-Length: 45313Keep-Alive: timeout=15, max=7014Connection: Keep-AliveContent-Type: application/json; charset=UTF-8

Example Response Body:

JSON response example

1[
2    {
3    	"Id": 100,
4        "Title": "My Campaign",
5        "Keywords": ["MyKeyWord"],
6        "StartDate": "2016-01-01 01:00:00",
7        "EndDate": "2017-01-01 01:00:00",
8        "Status": "Active",
9    },
10    {
11    	"Id": 101,
12        "Title": "My Campaign 2",
13        "Keywords": ["MyKeyWord2"],
14        "StartDate": "2016-01-01 01:00:00",
15        "EndDate": "2017-01-01 01:00:00",
16        "Status": "Inactive",
17    }
18]

XML response example

1<response>
2    <item>
3    	<Id>100</Id>
4        <Title>My Campaign</Title>5        <Keywords>6           <item>MyKeyword</item>7        </Keywords>8        <StartDate>2016-01-01 01:00:00</StartDate>9        <EndDate>2017-01-01 01:00:00</EndDate>10        <Status>Active</Status>
11    </item>12    <item>13        <Id>101</Id>14        <Title>My Campaign</Title>15        <Keywords>16           <item>MyKeyword2</item>17        </Keywords>18        <StartDate>2016-01-01 01:00:00</StartDate>19        <EndDate>2017-01-01 01:00:00</EndDate>20        <Status>Active</Status>21    </item>
22</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 »

← PreviousLookup Number Next →List Campaign Messages

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