List Numbers


URL:

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


Method:

GET

Response parameters:

Parameter Description
Number  String
Status_Id  Integer, view statuses »
Status_Description  String, view statuses » 
Blocked_Date  String, Date Time 

Example Request:

curl -i -H "Accept:application/xml" "https://api2.protexting.com/v1/numbers/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/xml; charset=utf-8
Keep-Alive: timeout=5, max=100
Link: <https://api2.protexting.com/v1/numbers/index?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:

[
    {
    	"Number":16463498xxx,
        "Status_Id": 0,
"Status_Description":"Active",
"Blocked_Date" : null },
... ]
<response>
    <item>
    	<Number>16463498xxx</Number>
        <Status_Id>0</Status_Id>
<Status_Description>Active</Status_Description>
<Blocked_Date/> </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 »

 

Statuses:

Status Id Status Description
0 Active
1 Inactive
301 Temporarily blocked.
302 Permanently blocked.