Get the list of available DID (phone numbers) for the selected area.

Sample URIs

GET https://api.multitel.net/{output}/getdids/{UserName}/{Password}/{countrycode}
POST https://api.multitel.net/{output}/getdids

List of parameters:

ParameterRequiredDescription
outputYesOne of :  json , xml , csv
usernameYesYour account username or API username.
passwordYesYour account password or API password.
countrycodeYesThe area code prefix - we will list numbers within this prefix only. Get it from GetAreas
voipNoFilter and show only numbers having VoIP capability
smsNoFilter and show only numbers having SMS capability
mmsNoFilter and show only numbers having MMS capability
quantityNo

Limits the number of entries to the value of quantity variable

Information on output values:

Key nameDescription
NumberPhone number available for purchase - use it with buynumbers function
SetupCostSetup fees for this number (NRC - Non recurring charges)
MonthlyChargesMonthly fees to rent this number (MRC - Monthly recurring charges)
PerMinuteChargesCost per minute (applies to each inbound call, once the "FreeMinutes" have depleted or if going over the number of channels
CountryCountry this number belongs to (not always provided)
AreaArea this number belongs to (not always provided)
CountryCodeNumeric telephone country code (not always provided)
StateCodeNumeric telephone area code (not always provided)
FreeMinutesFree inbound minutes - all calls within this quota of free minutes are free of charge. Quota of free minutes replenishes monthly.
VOIPThis phone number allows VoIP calls (audio/telephone calls) - also referred to as "number features" on web portal
SMSThis phone number allows inbound SMS (text messages) - also referred to as "number features" on web portal
MMSThis phone number allows inbound MMS (media messages) - also referred to as "number features" on web portal
PER_SMSCost to receive an inbound SMS (text message)
PER_MMSCost to receive an inbound MMS (media message)
SS7Carrier indication circuit (also known as CIC)
ISOCODECountry ISOCODE (2 letter) for this number.

Important info

  • Please note that the "Number" output parameter will be used as parameter for the buynumbers function
  • All prices shown in the output of GetDIDs function are in $ USD, unless otherwise stated in the output of the function or by your account manager.

Sample output - JSON

{"DATA":
[{"Number":"4420********","SetupCost":"0","MonthlyCharges":"1.00","PerMinuteCharges":"0.006",
"Country":"United Kingdom","Area":"London","CountryCode":"4420","StateCode":"4420",
"FreeMinutes":"5000","VOIP":"1","SMS":"0","MMS":"0","PER_SMS":"0","PER_MMS":"0","SS7":"5559","ISOCODE":"GB"},
{"Number":"442038088438","SetupCost":"0","MonthlyCharges":"1.00","PerMinuteCharges":"0.0092",
"Country":"United Kingdom","Area":"London","CountryCode":"GB","StateCode":"4420",
"FreeMinutes":"0","VOIP":"1","SMS":"0","MMS":"0","PER_SMS":"0.00000","PER_MMS":"0","SS7":"6108","ISOCODE":"GB"},
{"Number":"442038088446","SetupCost":"0","MonthlyCharges":"1.00","PerMinuteCharges":"0.0092",
"Country":"United Kingdom","Area":"London","CountryCode":"GB","StateCode":"4420",
"FreeMinutes":"0","VOIP":"1","SMS":"0","MMS":"0","PER_SMS":"0.00000","PER_MMS":"0","SS7":"6671","ISOCODE":"GB"}]}

Important info

Please note the `incomplete` numbers in the above output (4420********)  . If purchasing one of these numbers, the full number will be shown after purchase.

Sample output - XML

<?xml version="1.0"?>
<DATA>
  <Number>4420********</Number>
  <SetupCost>0</SetupCost>
  <MonthlyCharges>1.00</MonthlyCharges>
  <PerMinuteCharges>0.006</PerMinuteCharges>
  <Country>United Kingdom</Country>
  <Area>London</Area>
  <CountryCode>4420</CountryCode>
  <StateCode>4420</StateCode>
  <FreeMinutes>5000</FreeMinutes>
  <VOIP>1</VOIP>
  <SMS>0</SMS>
  <MMS>0</MMS>
  <PER_SMS>0</PER_SMS>
  <PER_MMS>0</PER_MMS>
  <SS7>5675</SS7>
  <ISOCODE>GB</ISOCODE>
</DATA>
<DATA>
  <Number>442038088438</Number>
  <SetupCost>0</SetupCost>
  <MonthlyCharges>1.00</MonthlyCharges>
  <PerMinuteCharges>0.0092</PerMinuteCharges>
  <Country>United Kingdom</Country>
  <Area>London</Area>
  <CountryCode>GB</CountryCode>
  <StateCode>4420</StateCode>
  <FreeMinutes>0</FreeMinutes>
  <VOIP>1</VOIP>
  <SMS>0</SMS>
  <MMS>0</MMS>
  <PER_SMS>0.00000</PER_SMS>
  <PER_MMS>0</PER_MMS>
  <SS7>6453</SS7>
  <ISOCODE>GB</ISOCODE>
</DATA>
<DATA>
  <Number>442038088446</Number>
  <SetupCost>0</SetupCost>
  <MonthlyCharges>1.00</MonthlyCharges>
  <PerMinuteCharges>0.0092</PerMinuteCharges>
  <Country>United Kingdom</Country>
  <Area></Area>
  <CountryCode>GB</CountryCode>
  <StateCode>4420</StateCode>
  <FreeMinutes>0</FreeMinutes>
  <VOIP>1</VOIP>
  <SMS>0</SMS>
  <MMS>0</MMS>
  <PER_SMS>0.00000</PER_SMS>
  <PER_MMS>0</PER_MMS>
  <SS7>6857</SS7>
  <ISOCODE>GB</ISOCODE>
</DATA>
<DATA>

Important info

Please note the `incomplete` numbers in the above output (4420********)  . If purchasing one of these numbers, the full number will be shown after purchase.

Sample output - CSV

curl https://api.multitel.net/csv/getdids/{username}/{password}/4420

4420********,0,1.00,0.006,"United Kingdom",,4420,4420,5000,1,0,0,0,0,5795,GB 442038088438,0,1.00,0.0092,"United Kingdom",,GB,4420,0,1,0,0,0.00000,0,6597,GB 442038088446,0,1.00,0.0092,"United Kingdom",,GB,4420,0,1,0,0,0.00000,0,6040,GB

Sample URIs:
GET https://api.multitel.net/csv/getdids/{UserName}/{Password}/{countrycode}?download=0|1
POST https://api.multitel.net/csv/getdids?download=0|1

Important info

All parameters are case-insensitive so for example, in POST requests,  "UserName" parameter can also be written as "username" , "Username" or "uSeRnAmE".