CallFire Solutions

Get Number

Follow

GET NUMBER

Get information about a single number owned by your account

Using this operation you can select a number already purchased and in your account, using the 11 digit E.164 format. It returns information about that number including status, lease information, configuration, and more.

REQUEST PARAMETERS

ParameterDemo ValueDescriptionData Type
GetNumber   Number request by 11 digit telephone number object
Number 11 digit telephone number PhoneNumber

RESPONSE PARAMETERS

ParameterDescriptionData Type
Number Info about Number like Region  
Number 11 digit E.164 number PhoneNumber
NationalFormat Phone number formatted for local string
TollFree Is toll free number boolean
Region Region of number represented by city, state, prefix, etc...  
Prefix 4-7 digit prefix string
City Name of a city string
State State abbreviation string
Zipcode 5 digit zipcode string
Country 2 digit country code string
Lata Lata string
RateCenter   string
Latitude Latitude float
Longitude Longitude float
TimeZone   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
NumberConfiguration Configure Call and Text features  
CallFeature [UNSUPPORTED, PENDING, DISABLED, ENABLED] NumberFeature
TextFeature [UNSUPPORTED, PENDING, DISABLED, ENABLED] NumberFeature
InboundCallConfigurationType [TRACKING, IVR] InboundType
InboundCallConfiguration    
CallTrackingConfig    
Id Unique ID of InboundConfig long
TransferNumber   List[PhoneNumber]
Screen   boolean
Record   boolean
IntroSoundId   long
WhisperSoundId   long
IvrInboundConfig    
Id Unique ID of InboundConfig long
DialplanXml   string

EXAMPLE


using RestSharp;

namespace [your-namespace]
{
    public class [your-class]
    {
        public string GetNumber()
        {
            string number = "12132042444"; //Your number

            var client = new RestClient("https://www.callfire.com/api/1.1/rest/");
            client.Authenticator = new HttpBasicAuthenticator("YourLoginId", "password");

            var request = new RestRequest(string.Format("number/{0}", number), Method.GET);

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

The XML returned is:

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

<r:Resource xmlns="http://api.callfire.com/data" xmlns:r="http://api.callfire.com/resource">

    <Number>

       <Number>12132042444</Number>

       <NationalFormat>12132042444</NationalFormat>

       <TollFree>false</TollFree>

       <Status>ACTIVE</Status>

       <LeaseInfo>

          <LeaseBegin>2014-12-02Z</LeaseBegin>

          <LeaseEnd>2015-01-02Z</LeaseEnd>

          <AutoRenew>true</AutoRenew>

       </LeaseInfo>

       <NumberConfiguration>

          <CallFeature>ENABLED</CallFeature>

          <TextFeature>ENABLED</TextFeature>

          <InboundCallConfigurationType>TRACKING</InboundCallConfigurationType>

          <InboundCallConfiguration>

             <CallTrackingConfig id="3630161003">

                <TransferNumber>12132042446</TransferNumber>

                <Screen>false</Screen>

                <Record>true</Record>

             </CallTrackingConfig>

          </InboundCallConfiguration>

       </NumberConfiguration>

    </Number>

</r:Resource>

Have more questions? Submit a request

Comments