CallFire Solutions

Search Available Keywords

Follow

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

ParameterDemo ValueDescriptionData Type
SearchAvailableKeywords     object
Keywords   List[string]

RESPONSE PARAMETERS

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

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"/>

 

Have more questions? Submit a request

Comments