Page tree
Skip to end of metadata
Go to start of metadata

Obtain technical and billing information about a number in your account.

Sample URIs

GET: https://api.multitel.net/{output}/getdidinfo/{username}/{password}/{number}
POST: https://api.multitel.net/{output}/getdidinfo

List of parameters:

ParameterRequiredDescription
outputYesOne of :  json , xml , csv
usernameYesYour account username or API username.
passwordYesYour account password or API password.
numberYesPhone number you are looking up

Information on output values:

Key nameDescription
NumberPhone number we are looking up
SetupCostNRC (Non recurrent charge) you paid fort his number
MonthlyChargesMRC (Monthly recurrent charges) you are paying for this number
PerMinuteChargesPer minute charges you are paying for inbound calls on this number
UriRing-to settings , URI
Uri2Ring-to settings, URI2
Uri3Ring-to settings, URI3
RingTypeRing-type ( 1: ring ; 2: music on hold)
ForwardDestination1: SIP, 2: Dial ; 7: SIP Account
FaxDetect(retired) 1/0 - Is Fax Detection enabled?
FaxRing(retired) 5 (seconds) - Number of seconds we will listen for fax ring tone
FaxEmail(retired) - Where will we send emails to?
CnamIs CNAM lookup enabled for this number? (1/0)
Vm(retired) is VoiceMail enabled for this number?
Vmring(retired) how many seconds should we ring primary URIs before forwarding to VoiceMail?
Vmtts(retired) Voicemail text to speech (vms2t )
Vmemail(retired) where should we forward the voicemails?
RemainingMinutesHow many free minutes remaining? (will show negative if none were given or if going over the quota)
FreeMinutesHow many free inbound minutes does this number have?
DescriptionDescription (user-set) for this number
ChannelsHow many channels are assigned to this number?
ServiceActiveIs this number active?
Voice_EnabledCan this number receive audio calls?
SMS_EnabledCan this number receive SMS/text messages?
MMS_EnabledCan this number receive MMS messages?
DateCreatedDate when number was purchased.

Sample output - JSON

{"DATA":[{"Number":"1234567890","SetupCost":"0","MonthlyCharges":"1.00","PerMinuteCharges":"0.009",
"FreeMinutes":"5000","Uri":"123456789@sip.server.com","Uri2":"1234567890@sip.server2.com",
"Uri3":"1234567890@sip.server3.com","RingType":"1","ForwardDestination":"1","FaxDetect":"0","FaxRing":"5",
"FaxEmail":"","Cnam":"0","Vm":"0","Vmring":"20","Vms2t":"0","Vmemail":"","RemainingMinutes":"4427",
"ServiceActive":"1","Description":"","Atcd":"0","Record":"0","Screening":"0","RingStyle":"1","SMS_Enabled":"0",
"Channels":"5","Voice_Enabled":"1","MMS_Enabled":"0","Subaccount_Id":"312323333","DateCreated":"2013-09-10 14:24:11"}]}

Sample output - XML

<?xml version="1.0"?>
<DATA>
  <Number>1234567890</Number>
  <SetupCost>0</SetupCost>
  <MonthlyCharges>1.00</MonthlyCharges>
  <PerMinuteCharges>0.009</PerMinuteCharges>
  <FreeMinutes>5000</FreeMinutes>
  <Uri>123456789@sip.server.com</Uri>
  <Uri2>1234567890@sip.server2.com</Uri2>
  <Uri3>1234567890@sip.server3.com</Uri3>
  <RingType>1</RingType>
  <ForwardDestination>1</ForwardDestination>
  <FaxDetect>0</FaxDetect>
  <FaxRing>5</FaxRing>
  <FaxEmail></FaxEmail>
  <Cnam>0</Cnam>
  <Vm>0</Vm>
  <Vmring>20</Vmring>
  <Vms2t>0</Vms2t>
  <Vmemail></Vmemail>
  <RemainingMinutes>4427</RemainingMinutes>
  <ServiceActive>1</ServiceActive>
  <Description></Description>
  <Atcd>0</Atcd>
  <Record>0</Record>
  <Screening>0</Screening>
  <RingStyle>1</RingStyle>
  <SMS_Enabled>0</SMS_Enabled>
  <Channels>5</Channels>
  <Voice_Enabled>1</Voice_Enabled>
  <MMS_Enabled>0</MMS_Enabled>
  <Subaccount_Id>312323333</Subaccount_Id>
  <DateCreated>2013-09-10 14:24:11</DateCreated>
</DATA>

Important

  • All prices shown in the output of GetDIDInfo function are in $ USD, unless otherwise stated in the output of the function or by your account manager.