• 1-888-686-8581
  • [email protected]
  • Sign in
  • Sign up
  • Home
  • News
  • Docs
  • About
  • Policies
  • Hosted PBX
  • Pricing
  • Coverage
  • Contact

GetCountries SOAP Service

testtest

read more
  • Multitel
  • 13 Nov 2013 23:45
  • 0

E911 RemoveRecord SOAP Function

This function will remove a record from the E911 Emergency database.

Meta:

RemoveRecord (Username, Password, Number);

Sample usage:


Sample success output:



Sample unsuccessful output (number not in database) :

 

Sample unsuccessful output (incorrect username/password):

 

 

Related functions

 

 

Important note

Please note that if you are using the development API all results will be success ( RETURN => 1 ) but no records will be removed from database

read more
  • Docs
  • 05 Dec 2013 17:02
  • 0

E911 VerifyAddress SOAP WebService

This function will return a unique ID for each correct address submitted.  It will not charge your account in any way.

You can use this unique ID for the Provision E911 function . If no unique ID is given, then the E911 Provision will call the VerifyAddress function first and automatically generate a unique id.


Meta:

VerifyAddressWs(Username,Password,Address,City,State,Zip);


Sample usage:


Successful result:


Unsuccessful result (Address incorrect):


Unsuccessful result (Username or password incorrect)


Related functions

read more
  • Docs
  • 05 Dec 2013 16:56
  • 0

E911 ProvisionAddress SOAP WebService

This function will allow you to provision one address (at a time) with the E911 Emergency Service.

 

Meta:

ProvisionAddressWs(Username,Password,UniqueId,Address,Address2,City,State,Zip,Number,Callername);


Sample usage:

 

Sample successful output:
 
 
Please note that calling this function on an already provisioned number will have the effect of modifying that number's details (if Name/Address are not identical to what was provisioned previously).
 
Function will return an empty array if username/password are incorrect:

 




Related functions

read more
  • Docs
  • 05 Dec 2013 16:49
  • 0

E911 QueryRecord SOAP WebService

This function will provide details on a specific number that was previously provisioned with E911.

 

Meta:

QueryRecordWs(Username,Password,Number);

 

Sample usage:


Sample output:



IP field will output the IP address from which the original E911 provisioning request was made.
 
While this function is also available on the development API (http://api.multitel.net:91), it will return no results if there were no results in database. Therefore, to be able to use this function on the development API, you will have to have had previously added/provisioned numbers through the real API.  Calling the E911 provision function on the development API will store no records in the database.
 

Function will also return an empty result if username/password are incorrect.

 

 

Related functions

read more
  • Docs
  • 05 Dec 2013 15:27
  • 0

E911 QueryAll SOAP Function

This function will retrieve a list of all numbers that you have provisioned with E911 service.

 

Meta:

QueryAll(Username,Password);

 

Sample usage:

 


Sample output:
 

IP field will output the IP address from which the original E911 provisioning request was made.
 
While this function is also available on the development API (http://api.multitel.net:91), it will return no results if there were no results in database. Therefore, to be able to use this function on the development API, you will have to have had previously added/provisioned numbers through the real API.  Calling the E911 provision function on the development API will store no records in the database.
 
 
Incorrect username / password will produce an empty result:
 
 
 

Related functions

read more
  • Docs
  • 05 Dec 2013 15:23
  • 0

SendSMS (Text Message) SOAP Function

This function will allow you to send text messages towards worldwide destinations

Meta:

SendSmsWs(Username,Password,From,To,Text);

Sample usage:

 
Sample successful output:

 
Sample unsuccessful output (username/password incorrect):

 
Sample unsuccessful output (no network coverage):

 

[STATUS] can be either Success either Failed

[MESSAGE] can be one of the following:

 

Please note that when using development API (http://api.multitel.net:91/ ), result will always be "Success"

 

read more
  • Docs
  • 05 Dec 2013 15:11
  • 0

GetBalanceWs

This function will retrieve your account balance (USD)

Meta:

GetBalanceWs(Username,Password);

Sample usage:


Sample successful output:

 

Sample unsuccessful output (username/password incorrect):

 

read more
  • Docs
  • 05 Dec 2013 14:50
  • 0

CNAM SOAP WebService

This webservice will provide CallerID Name information for queried numbers.

Meta: 

CnamWs(Username, Password, Number, Region ) 

Sample usage:


Sample output:


For numbers not found, we will be returning the same number that was queried.

Please note that if no region is provided, cnam_northamerica will be used. This provides records from US and Canada.

Following regions are also available:

Germany - Region : cnam_germany
France     - Region: cnam_france
Australia  - Region: cnam_australia


Related functions

read more
  • Docs
  • 05 Dec 2013 19:23
  • 0

ReleaseNumbers SOAP Service

This function will allow you to release (cancel) numbers you have previously purchased. Please note that upon release, numbers might not be immediately available for re-purchase.

 

Meta:

ReleaseNumbersWs(Username, Password, Number);

Sample usage:

 

Sample successful output:

 

Sample unsuccessful output (no such number in inventory):

Sample unsuccessful output (incorrect username/password):

 
You can also use the development API (http://api.multitel.net:91) and numbers will not be deleted (you'll always receive a success message but the phone numbers will remain in your inventory)

read more
  • Docs
  • 05 Dec 2013 14:45
  • 0

GetRingto SOAP Service

This webservice will provide the ring-to (URI) for a specific number

Meta:

GetRingtoWs(UserName,Password,Number);

Sample usage:

Sample output (for an existing and valid number):

 

RingTypes:

1 - Sequential (All URIs are tried in the order they are listed)
2 - Random (Call is ringing on a random entry from the 3 entries provided. If only one entry was provided, call will only ring on that one)
3 - Simultaneous (Call is ringing on all URIs at the same time)

Out of the 3 possible RingTypes above, number "1" - Sequential , provides the best redundancy. Number 2 will not retry the other URIs if first URI fails, and number 3 can return busy or other message before the other URIs have had the chance to ring

 

Sample unsuccessful output (for a number which is not in the system):

 

 

 

Sample unsuccessful output (if user/password are incorrect):

 

 

read more
  • Docs
  • 05 Dec 2013 14:13
  • 0

ModifyRingTo SOAP Service

This webservice will allow you to modify the RingTo (URI) address for a specific number.

Meta:

ModifyRingTo(Username,Password,Number,NewRingTo)

Sample usage:

Sample successful output:

Please note that on success, return will be the same number the function was called for.

 

Sample unsuccessful output (User/Password incorrect):

Please note that this function will always return success if used on the development API (http://api.multitel.net:91).

read more
  • Docs
  • 05 Dec 2013 14:22
  • 0

PortNumber SOAP Service

This function will allow you to port numbers from your old carrier to Multitel

Meta:

PortNumberWs(Username, Password, Number, Name, Address, City, State, ZipCode, Country, ContactNumber, FromCarrier, AuthUser, Images1, Images2);

Sample usage:

Sample output:

read more
  • Docs
  • 11 Dec 2013 01:18
  • 0

PortNumber SOAP Service

This function will allow you to port numbers from your old carrier to Multitel

Meta:

PortNumberWs(Username, Password, Number, Name, Address, City, State, ZipCode, Country, ContactNumber, FromCarrier, AuthUser, Images1, Images2);

Sample usage:

Sample output:

read more
  • Docs
  • 11 Dec 2013 01:18
  • 0

GetDidInfo SOAP webservice

This service will provide service and technical info about a number

Meta:

GetDidInfoWs(Username, Password, Number);


Sample usage:

 

Sample output:

read more
  • Docs
  • 11 Dec 2013 01:32
  • 0

GetDidInfo SOAP webservice

This service will provide service and technical info about a number

Meta:

GetDidInfoWs(Username, Password, Number);


Sample usage:

 

Sample output:

read more
  • Docs
  • 11 Dec 2013 01:32
  • 0

ModifyNumber SOAP Service

This function will allow you to modify service parameters for specified number. You can enable or modify features such as Fax , VoiceMail, Cnam, etc


Sample usage:

Sample output:

read more
  • Docs
  • 11 Dec 2013 01:50
  • 0

ModifyNumber SOAP Service

This function will allow you to modify service parameters for specified number. You can enable or modify features such as Fax , VoiceMail, Cnam, etc


Sample usage:

Sample output:

read more
  • Docs
  • 11 Dec 2013 01:50
  • 0

GetCountries SOAP Service

This web service will provide a list of countries where phone numbers are available for purchase

Meta:

GetCountriesWs(Username,Password)


Sample Usage:


Sample output:

 

Output description:


The array returned will contain the following values:

COUNTRYCODE - the phone prefix for this specific country

DESCRIPTION - country name

COUNTRYID - country id - you'll use this with the GetAreas function

ISOCODE - ISO code

A2B - A2Billing id from cc_country/countries table (Useful if you wish to integrate our API into your A2Billing server)

LATITUDE - Country latitude (useful if you need to display results on a map)

LONGITUDE - Country longitude (useful if you need to display results on a map)

 

Function will return an empty array if username or password are not correct.


SOAP XML Definition:

read more
  • Docs
  • 18 Nov 2013 17:24
  • 0

GetAreas SOAP Service

This webservice will provide a list of areas where numbers are available for purchase.
 
Meta: 
 
GetAreasWs(UserName,Password,CountryCode,CountryID);
 
Sample usage:

 
 
Please note that you would have to provide both the CountryCode and CountryID (which is provided by the GetCountriesWs web service.
Not providing the CountryID has the potential to display wrong areas .  For example, if you would like to obtain area listing for Canada and you would not specify the CountryID , system will return first country area info where the Country Code starts with 1 , which is USA.  Same goes for Dominican Republic, Jamaica, and other countries having country code starting with "1".
 
 
Sample output:

 
 
Output description:
 
AREACODE : This will be the country code along with the area code . You will use this with the GetDIDs function.
DESCRIPTION:  Area description (Brussels, etc)
CLATITUDE: Country latitude (Useful if you need to display areas on a map)
CLONGITUDE: Country longitude (Useful is you need to display areas on a map)
ALATITUDE: Area latitude (Useful if you need to display areas on a map)
ALONGITUDE: Area longitude (Useful if you need to display areas on a map)
 
 

Function will return an empty array if username or password are not correct.

 

SOAP XML Definition:

read more
  • Docs
  • 21 Nov 2013 15:27
  • 0

GetDIDs SOAP Service

This webservice will provide a list of numbers from the area (prefix) you have selected.

Meta:

GetDidsWs(UserName,Password,CountryCode);

 

Sample usage:

 

Sample output:

 

Output description:

Number:   Phone number .  You'll use this number in the next process, BuyNumber
SetupCost: 
Cost to set this number up
MonthlyCharges: 
Per month charges
PerMinuteCharges: 
Per minute charges once the FreeMinutes have run off. It's advisable to try and purchase mostly numbers that have FreeMinutes available
Country: 
USA / Canada / Germany / etc
Area: 
Washington (area code where this number is located)
CountryCode:
Country prefix
StateCode:
Area/State prefix
FreeMinutes:
Number of free minutes (this is determined by the type of account you have or by the provider ; For example , even if your account type allows up to 500 free minutes, providers might be offer 0 free minutes for certain numbers

 

Function will return no output if username/password are incorrect , or an empty array if this area has no numbers available for purchase.

SOAP XML Definition

read more
  • Docs
  • 21 Nov 2013 15:59
  • 0

BuyNumber SOAP Service

This webservice will allow you to purchase a number.

Meta:

BuyNumber(UserName,Password,Number,URI,Type);

 

Sample usage:

 

Parameters:


# Username/Password
- your username and password
# Number - the number you are purchasing
# URI - the destination (SIP URI) for this number
# URI2/URI3 - backup destinations for this number
# RingType - how will we ring these numbers?
  * RingType => 1  - Sequential - all the URIs will be called in the order they are setup (First we will ring URI, then URI1, then URI2)
  * RingType => 2  - Random - only a single URI will be called, selected randomly from the list of provided URIs. If only a single URI is provided, then that'll be the one used
  * RingType => 3  - Simultaneously - ring all three URIs at the same time.
# FaxDetect
- If FaxDetect is set to 1 , all calls towards this number will automatically be picked up by the system and fax detection will run.  Please note that this feature is not free. Its a per account feature, so if you enable it on a single number or 100 numbers - it will cost you the same amount per month. Default value is 0 (not enabled)
# FaxRing
- how many seconds should we listen for fax tones before sending the call to URI / URI1 / URI2 ?
# FaxEmail
- the email address that will receive the fax messages. Please note that the emails are also stored on the server and you can always view them in your account.
# Vm
- If Vm is set to 1 , all unanswered calls will be picked up by our voicemail system. You can record a voicemail greeting in our customer control panel (your web account). Please note that this feature is not free. Its a per account feature, so if you enable it on a single number or 100 numbers - it will cost you the same amount per month. Default value is 0 (not enabled)
# Vmring
- How many seconds should we wait for an answer before the voicemail system picks up the call?
# Vmemail
- Whats the email address we should be sending this voicemail to?
# Vmtts
- Voicemail Text to Speech - This will attempt to translate your VoiceMail messages. Works only for messages in English (US/UK/Australian English) . Please note that this feature is not free. Its a per account feature, so if you enable it on a single number or 100 numbers - it will cost you the same amount per month. Default value is 0 (not enabled). This feature is only charged if you have numbers which have VoiceMail enabled.
# Cnam
- enable CNAM lookups for this number - This feature will attempt to identify incoming calls and provide a CallerID Name on the outbound call leg. This feature will charge for successful CNAM lookups.
# Type - type of forward ( 1 is for SIP)

 

A simplified version is available below:

 

Successful number purchase output:

 

Unsuccessful number purchase output (Number not available):

 

Unsuccessful number purchase output (Not enough credit):

 

Unsuccessful number purchase output (User or Password incorrect):

 

SOAP XML Definition

read more
  • Docs
  • 05 Dec 2013 13:37
  • 0
  • Telecom (7)
  • News (2)
  • Technology (2)
  • VoIP (1)

Labels


  • aaaa
  • quick
  • brown
  • fox
  • dlink
  • vulnerability
  • wireless sdasda
  • spectrum
  • frequency
  • fcc
  • bangladesh
  • regulator
  • portability
  • moldova
  • phone
  • telecom
  • voip
  • mobile
  • mtn
  • nigeria
  • huawei
  • ericsson
  • namibia
  • ixp
  • germany
  • south africa
  • ict
  • seacom
  • africa
  • soap
  • docs label
  • test12345
  • asd123
  • peering
  • iowa
  • vermont
  • regulation
  • saya
  • bjsdakjsd
  • aaa
  • sdfdsf dfdfs
  • sms
  • text
  • numbers
  • texting
  • english
  • test
  • argo

About

Multitel is a telecom solutions provider. We empower your telecom voice switches with e911 services, international phone numbers, texting/sms and CNAM services. Our API provides unrestricted access to our services enabling you and your customer to use and benefit from our solutions. Integration services are also available.

We proudly recommend Zoiper

Contact

Phone: 1-888-686-8581
Email: [email protected]

News

  • Keep in touch! Our SMS/Text en
  • VoIP Deregulation in Iowa and
  • Seacom launches Cape Town PoP
  • Telecom Namibia, Jasco partner
  • MTN Nigeria's latest deal to s

Quick Links

  • Home
  • About
  • Pricing
  • News
  • Docs
  • Policies
  • Contact

2014 © Multitel LLC. Privacy Policy | Terms of Service