SEARCH AVAILABLE KEYWORDS

Search for keywords available for purchase

Using this operation you can supply a list of keywords to see whether or not they are available for purchase. The available keywords will be returned in the result.

The available keywords found can be purchased using CreateNumberOrder.

REQUEST PARAMETERS

Parameter Data Type Demo Value Description
SearchAvailableKeywords object
Keywords List[string]

RESPONSE PARAMETERS

Parameter Data Type Description
KeywordQueryResult List of Keywords returned from query
TotalResults long Results count
Keyword Info on Keyword like status and lease info
ShortCode PhoneNumber
Keyword string
Status NumberStatus [PENDING, ACTIVE, RELEASED, UNAVAILABLE]
LeaseInfo Info about Lease
LeaseBegin date Date lease began
LeaseEnd date Date lease ends
AutoRenew boolean Is lease set to renew each month

EXAMPLE

using RestSharp;

namespace [your-namespace]
{
    public class [your-class]
    {
        public string SearchAvailableKeywords()
        {
            var client = new RestClient("https://www.callfire.com/api/1.1/rest/");
            client.Authenticator = new HttpBasicAuthenticator("YourLoginId", "password");

            var request = new RestRequest("number/keyword/search", Method.GET);
            request.AddParameter("Keywords", "TestKeyWord");

            var response = client.Execute(request);
            string content = response.Content;
            return content;
        }
    }
}

The XML returned is:

If the keyword is available, the following XML will be returned:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<r:ResourceList xmlns="http://api.callfire.com/data" xmlns:r="http://api.callfire.com/resource" totalResults="1">

    <Keyword>

       <ShortCode>67076</ShortCode>

       <Keyword>TestKeyword</Keyword>

    </Keyword>

</r:ResourceList>

If the keyword is not available, the following XML will be returned:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<r:ResourceList xmlns="http://api.callfire.com/data" xmlns:r="http://api.callfire.com/resource" totalResults="0"/>