Check Keyword Availability


URL:

https://api2.protexting.com/v1/keyword/check-availability?keyword=<keyword>&number=<your_number>&access_token=<your_access_token>


Method:

GET

Request parameters:

* required parameters

Parameter Description
* keyword  String, min 4 characters
* number  Integer, (account short code or long number) see here »

Response parameters:

Parameter Description
Keyword  String
Number  Integer, (account short code or long number) see here »
Status_Id  Integer
Status_Description  String
Message  String

Example Request:

curl -i -H "Accept:application/xml" "https://api2.protexting.com/v1/keyword/check-availability?keyword=ProTexting&number=82257&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/keyword/check-availability?keyword=ProTexting&number=82257&access_token=your_access_token&page=1>; 
rel=self Pragma: no-cache 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:

[
    {
    	"Keyword": "ProTexting",
        "Number": "82257",
        "Status_Id": 0,
        "Status_Description": "Not_Available",
        "Message: "The keyword is not available."
    }
]
		
<response>
    <item>
    	<Keyword>ProTexting</Keyword>
        <Number>82257</Number>
<Status_Id>0</Status_Id>
<Status_Description>Not_Avialable</Status_Description>
<Message>The keyword is not available</Message> </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

Id Description
0 Not Available
1 Avialable