SOAP and REST/JSON API - Documentation
API Documentation
This Document is a Complete Reference Guide for the use of VoIP.ms API.
INTRODUCTION
With the VoIP.ms API, you can easily integrate VoIP.ms functionality on your website, intranet, extranet or customer portal.
The VoIP.ms API provides the basic functions needed to manage, purchase and cancel DID numbers, create and edit sub-accounts, consult CDR, balance and much more.
This document is aimed to help you setup and integrate VoIP.ms API properly into your website. It will also provide a complete list of functions, parameters needed, response from functions and possible error codes with their meaning.
VoIP.ms also supports Application-to-Person (A2P) delivery for business text messaging. However, requirements and fees vary due to industry regulations. The default limit is 100 SMS per day, which can be raised upon request.
FUNCTIONS LIST
VoIP.ms API has over 100 functions to help you integrate our services into your website. All of these functions expect a minimun of two parameters:
api_username (email used to login to VoIP.ms portal)
api_password (password created for the API)
The functions are separated in the following categories:
|
General |
|
|
getBalance |
- Retrieves Balance for your Account if no additional parameter is provided. - Retrieves Balance and Calls Statistics for your Account if "advanced" parameter is true. |
|
getConference |
- Retrieves a list of Conferences if no additional parameter is provided. - Retrieves a specific Conference if a conference code is provided. |
|
getConferenceMembers |
- Retrieves a list of Member profiles if no additional parameter is provided. - Retrieves a specific member if a member code is provided. |
|
getConferenceRecordings |
- Retrieves a list of recordings of a specific conference. |
|
getConferenceRecordingFile |
- Retrieves a specific Recording File data in Base64 format. |
|
getSequences |
- Retrieves a list of Sequences if no Sequence ID is provided. - Retrieves a specific Sequence if a Sequence ID is provided. |
|
getCountries |
- Retrieves a list of Countries if no additional parameter is provided. - Retrieves a specific Country if a country code is provided. |
|
getIP |
- Shows the IP used by the client application requesting information from the API * this is the only function not using the IP for authentication. * the IP returned should be the one used in the API Configuration. |
|
getLanguages |
- Retrieves a list of Languages if no additional parameter is provided. - Retrieves a specific Language if a language code is provided. |
|
getLocales |
- Retrieves a list of locale codes if no additional parameter is provided. - Retrieves a specific locale code if a language code is provided. |
|
getServersInfo |
- Retrieves a list of Servers with their info if no additional parameter is provided. - Retrieves a specific Server with its info if a Server POP is provided. |
|
getTransactionHistory |
- Retrieves the Transaction History records between two dates. |
|
Accounts |
|
|
createSubAccount |
- Adds a new Sub Account entry to your Account |
|
delSubAccount |
- Deletes a specific Sub Account from your Account |
|
getAllowedCodecs |
- Retrieves a list of Allowed Codecs if no additional parameter is provided. - Retrieves a specific Allowed Codec if a codec code is provided. |
|
getAuthTypes |
- Retrieves a list of Authentication Types if no additional parameter is provided. - Retrieves a specific Authentication Type if an auth type code is provided. |
|
getDeviceTypes |
- Retrieves a list of Device Types if no additional parameter is provided. - Retrieves a specific Device Type if a device type code is provided. |
|
getDTMFModes |
- Retrieves a list of DTMF Modes if no additional parameter is provided. - Retrieves a specific DTMF Mode if a DTMF mode code is provided. |
|
getInvoice |
- Retrieves a URL to download the invoice in a PDF file. |
|
getLockInternational |
- Retrieves a list of Lock Modes if no additional parameter is provided. - Retrieves a specific Lock Mode if a lock code is provided. |
|
getMusicOnHold |
- Retrieves a list of Music on Hold Options if no additional parameter is provided. - Retrieves a specific Music on Hold Option if a MOH code is provided. |
|
delMusicOnHold |
- Deletes a specific custom Music on Hold. |
|
getNAT |
- Retrieves a list of NAT Options if no additional parameter is provided. - Retrieves a specific NAT Option if a NAT code is provided. |
|
getProtocols |
- Retrieves a list of Protocols if no additional parameter is provided. - Retrieves a specific Protocol if a protocol code is provided. |
|
getRegistrationStatus |
- Retrieves the Registration Status of all accounts if no account is provided. |
|
getReportEstimatedHoldTime |
- Retrieves a list of 'ReportEstimateHoldTime' Types if no additional parameter is provided. - Retrieves a specific 'ReportEstimateHoldTime' Type if a type code is provided. |
|
getRoutes |
- Retrieves a list of Route Options if no additional parameter is provided. - Retrieves a specific Route Option if a route code is provided. |
|
getSubAccounts |
- Retrieves all Sub Accounts if no additional parameter is provided. - Retrieves Reseller Client Accounts if Reseller Client ID is provided. - Retrieves a specific Sub Account if a Sub Account is provided. |
|
addMemberToConference |
- Add Member to a Conference |
|
setSubAccount |
- Updates Sub Account information. |
|
Call Detail Records |
|
|
getCallAccounts |
- Retrieves all Sub Accounts if no additional parameter is provided. - Retrieves Reseller Client Accounts if Reseller Client ID is provided. |
|
getCallBilling |
- Retrieves a list of Call Billing Options. |
|
getCallTypes |
- Retrieves a list of Call Types and All DIDs if no additional parameter is provided. - Retrieves a list of Call Types and Reseller Client DIDs if a Reseller Client ID is provided. |
|
getCDR |
- Retrieves the Call Detail Records of all your calls. |
|
getRates |
- Retrieves the Rates for a specific Package and a Search term. |
|
getTerminationRates |
- Retrieves the Rates for a specific Route (Premium, Value) and a Search term. |
|
getResellerCDR |
- Retrieves the Call Detail Records for a specific Reseller Client. |
|
getResellerSMS |
- Retrieves a list of SMS messages for a specific Reseller Client. by: date range, sms type, DID number, and contact |
|
getResellerMMS |
- Retrieves a list of MMS messages for a specific Reseller Client. by: date range, mms type, DID number, and contact |
|
Call Parking |
|
|
getCallParking |
- Retrieves all Call Parking entries if no additional parameter is provided. - Retrieves a specific Parking entry if a Call Parking ID is provided. |
|
setCallParking |
- Updates a specific Call Parking entry if a Call Parking ID is provided. - Adds a new Call Parking entry if no Call Parking ID is provided. |
|
delCallParking |
- Deletes a specific Call Parking entry from your Account. |
|
Call Recordings |
|
|
getCallRecordings |
- Retrieves all call recordings related to account. |
|
getCallRecording |
- Retrieves one especific call recording information, including the recording file on mp3 format. |
|
sendCallRecordingEmail |
- Send information and audio file to email account. |
|
delCallRecording |
- Delete specific call recording, audio file and information related. |
|
Clients |
|
|
addCharge |
- Adds a Charge to a specific Reseller Client |
|
addPayment |
- Adds a Payment to a specific Reseller Client |
|
assignDIDvPRI |
- Assigns a Per Minute DID to a VPRI (Flat Rate DIDs can’t be assigned) |
|
getBalanceManagement |
- Retrieves a list of Balance Management Options if no additional parameter is provided. - Retrieves a specific Balance Management Option if a code is provided. |
|
getCharges |
- Retrieves Charges made to a specific Reseller Client. |
|
getClientPackages |
- Retrieves a list of Packages for a specific Reseller Client. |
|
getClients |
- Retrieves a list of all Clients if no additional parameter is provided. - Retrieves a specific Reseller Client if a Reseller Client ID is provided. - Retrieves a specific Reseller Client if a Reseller Client e-mail is provided. |
|
getClientThreshold |
- Retrieves the Threshold Information for a specific Reseller Client. |
|
getDeposits |
- Retrieves Deposits made for a specific Reseller Client. |
|
getPackages |
- Retrieves a list of Packages if no additional parameter is provided. - Retrieves a specific Package if a package code is provided. |
|
getResellerBalance |
- Retrieves Balance and Calls Statistics for a specific Reseller Client for the last 30 days and current day. |
|
setClient |
- Updates Reseller Client information. |
|
setClientThreshold |
- Update the Threshold Amount for a specific Reseller Client.- Update the Threshold notification e-mail for a specific Reseller Client if the e-mail address is provided. |
|
setConference |
- Updates a specific Conference if a conference code is provided. - Adds a new Conference entry if no conference code is provided. |
|
setConferenceMember |
- Updates a specific Member profile if a member code is provided. - Adds a new Member profile entry if no member code is provided. |
|
setSequences |
- Updates a specific Sequence if a Sequence ID is provided. - Adds a new Sequence entry if no Sequence ID is provided. |
|
signupClient |
- Signs a new Reseller Client to your Reseller Account. |
|
DIDs |
|
|
backOrderDIDUSA |
- Backorder DID (USA) from a specific ratecenter and state. |
|
backOrderDIDCAN |
- Backorder DID (CANADA) from a specific ratecenter and province. |
|
cancelDID |
- Deletes a specific DID from your Account. |
|
connectDID |
- Connects a specific DID to a specific Reseller Client Sub Account |
|
delCallback |
- Deletes a specific Callback from your Account. |
|
delCallerIDFiltering |
- Deletes a specific CallerID Filtering from your Account. |
|
delCallHunting |
- Deletes a specific Call Hunting from your Account. |
|
delConference |
- Deletes a specific Conference from your Account. |
|
delConferenceMember |
- Deletes a specific Member profile from your Account. |
|
delSequences |
- Deletes a specific Sequence from your Account. |
|
delClient |
- Deletes a specific reseller client from your Account. |
|
delDISA |
- Deletes a specific DISA from your Account. |
|
deleteSMS |
- Deletes a specific SMS from your Account. |
|
deleteMMS |
- Deletes a specific MMS from your Account. |
|
delForwarding |
- Deletes a specific Forwarding from your Account. |
|
delIVR |
- Deletes a specific IVR from your Account. |
|
delPhonebook |
- Deletes a specific Phonebook from your Account. |
|
delPhonebookGroup |
- Deletes a specific Phonebook group from your Account. |
|
delQueue |
- Deletes a specific Queue from your Account. |
|
delRecording |
- Deletes a specific Recording from your Account. |
|
delRingGroup |
- Deletes a specific Ring Group from your Account. |
|
delSIPURI |
- Deletes a specific SIP URI from your Account. |
|
delStaticMember |
- Deletes a specific Static Member from Queue. |
|
delTimeCondition |
- Deletes a specific Time Condition from your Account. |
|
getCallbacks |
- Retrieves a list of Callbacks if no additional parameter is provided. - Retrieves a specific Callback if a Callback code is provided. |
|
getCallerIDFiltering |
- Retrieves a list of CallerID Filterings if no additional parameter is provided. - Retrieves a specific CallerID Filtering if a CallerID Filtering code is provided. |
|
getCallHuntings |
- Retrieves a list of Call Huntings if no additional parameter is provided. - Retrieves a specific Call Huntings if a Call Hunting code is provided. |
|
getCarriers |
- Retrieves a list of Carriers for Vanity Numbers if no additional parameter is provided. - Retrieves a specific Carrier for Vanity Numbers if a carrier code is provided. |
|
getDIDCountries |
- Retrieves a list of Countries for International DIDs if no country code is provided. - Retrieves a specific Country for International DIDs if a country code is provided. |
|
getDIDsCAN |
- Retrives a list of Canadian DIDs by Province and Ratecenter. |
|
getDIDsInfo |
- Retrieves information from all your DIDs if no additional parameter is provided. - Retrieves information from Reseller Client's DIDs if a Reseller Client ID is provided. - Retrieves information from Sub Account's DIDs if a Sub Accunt is provided. - Retrieves information from a specific DID if a DID Number is provided. - Retrieves SMS information from a specific DID if the SMS is available. |
|
getDIDsInternationalGeographic |
- Retrieves a list of International Geographic DIDs by Country. |
|
getDIDsInternationalNational |
- Retrieves a list of International National DIDs by Country. |
|
getDIDsInternationalTollFree |
- Retrieves a list of International TollFree DIDs by Country. |
|
getDIDsUSA |
- Retrives a list of USA DIDs by State and Ratecenter. |
|
getDIDvPRI |
- Retrives the list of DIDs assigned to the VPRI. |
|
getDISAs |
- Retrieves a list of DISAs if no additional parameter is provided. - Retrieves a specific DISA if a DISA code is provided. |
|
getForwardings |
- Retrieves a list of Forwardings if no additional parameter is provided. - Retrieves a specific Forwarding if a fwd code is provided. |
|
getInternationalTypes |
- Retrieves a list of Types for International DIDs if no additional parameter is provided. - Retrieves a specific Types for International DIDs if a type code is provided. |
|
getIVRs |
- Retrieves a list of IVRs if no additional parameter is provided. - Retrieves a specific IVR if a IVR code is provided. |
|
getJoinWhenEmptyTypes |
- Retrieves a list of 'JoinWhenEmpty' Types if no additional parameter is provided. - Retrieves a specific 'JoinWhenEmpty' Types if a type code is provided. |
|
getMMS |
- Retrieves a list of MMS messages by: date range, mms type, DID number, and contact. |
|
getMediaMMS |
- Retrieves media files from the message. |
|
getPhonebook |
- Retrieves a list of Phonebook entries if no additional parameter is provided. - Retrieves a list of Phonebook entries if a name is provided. - Retrieves a specific Phonebook entry if a Phonebook code is provided. - Retrieves a list of Phonebook entries if a phonebook group name is provided. - Retrieves a list of Phonebook entries if a phonebook group code is provided. |
|
getPhonebookGroups |
- Retrieves a list of Phonebook groups if no additional parameter is provided. - Retrieves a list of Phonebook groups if a name is provided. - Retrieves a specific Phonebook group if a group ID is provided. |
|
getPortability |
- Shows if a DID Number can be ported into our network. - Display plans and rates available if the DID Number can be ported into our network. |
|
getProvinces |
- Retrieves a list of Canadian Provinces. |
|
getQueues |
- Retrieves a list of Queue entries if no additional parameter is provided. - Retrieves a specific Queue entry if a Queue code is provided. |
|
getRateCentersCAN |
- Retrieves a list of Canadian Ratecenters by Province. |
|
getRateCentersUSA |
- Retrieves a list of USA Ratecenters by State. |
|
getRecordings |
- Retrieves a list of Recordings if no additional parameter is provided. - Retrieves a specific Recording if a Recording code is provided. |
|
getRecordingFile |
- Retrieves a specific Recording File data in Base64 format. |
|
getRingGroups |
- Retrieves a list of Ring Groups if no additional parameter is provided. - Retrieves a specific Ring Group if a ring group code is provided. |
|
getRingStrategies |
- Retrieves a list of Ring Strategies if no additional parameter is provided. - Retrieves a specific Ring Strategy if a ring strategy code is provided. |
|
getSIPURIs |
- Retrieves a list of SIP URIs if no additional parameter is provided. - Retrieves a specific SIP URI if a SIP URI code is provided. |
|
getSMS |
- Retrieves a list of SMS messages by: date range, sms type, DID number, and contact. |
|
getStates |
- Retrieves a list of USA States. |
|
getStaticMembers |
- Retrieves a list of Static Members from a queue if no additional parameter is provided. - Retrieves a specific Static Member from a queue if Queue ID and Member ID are provided |
|
getTimeConditions |
- Retrieves a list of Time Conditions if no additional parameter is provided. - Retrieves a specific Time Condition if a time condition code is provided. |
|
getVoicemailSetups |
- Retrieves a list of Voicemail Setup Options if no additional parameter is provided. - Retrieves a specific Voicemail Setup Option if a voicemail setup code is provided. |
|
getVoicemailAttachmentFormats |
- Retrieves a list of Email Attachment Format Options if no additional parameter is provided. - Retrieves a specific Email Attachment Format Option if a format value is provided. |
|
orderDID |
- Orders and Adds a new DID Number to the Account. |
|
orderDIDInternationalGeographic |
- Orders and Adds new International Geographic DID Numbers to the Account. |
|
orderDIDInternationalNational |
- Orders and Adds new International National DID Numbers to the Account. |
|
orderDIDInternationalTollFree |
- Orders and Adds new International TollFree DID Numbers to the Account. |
|
orderDIDVirtual |
- Orders and Adds a new Virtual DID Number to the Account. |
|
orderTollFree |
- Orders and Adds a new Toll Free Number to the Account. |
|
orderVanity |
- Orders and Adds a new Vanity Toll Free Number to the Account. |
|
removeDIDvPRI |
- Removes a DID from a VPRI |
|
searchDIDsCAN |
- Searches for Canadian DIDs by Province using a Search Criteria. |
|
searchDIDsUSA |
- Searches for USA DIDs by State using a Search Criteria. |
|
searchTollFreeCanUS |
- Searches for USA/Canada Toll Free Numbers using a Search Criteria. - Shows all USA/Canada Toll Free Numbers available if no criteria is provided. |
|
searchTollFreeUSA |
- Searches for USA Toll Free Numbers using a Search Criteria. - Shows all USA Toll Free Numbers available if no criteria is provided. |
|
searchVanity |
- Searches for Vanity Toll Free Numbers using a Search Criteria. |
|
sendSMS |
- Send a SMS message to a Destination Number. |
|
sendMMS |
- Send a MMS message to a Destination Number. |
|
setCallback |
- Updates a specific Callback if a callback code is provided. - Adds a new Callback entry if no callback code is provided. |
|
setCallerIDFiltering |
- Updates a specific Caller ID Filtering if a filtering code is provided. - Adds a new Caller ID Filtering if no filtering code is provided. |
|
setCallHunting |
- Updates a specific Call Hunting if a Call Hunting code is provided. - Adds a new Call Hunting if no Call Hunting code is provided. |
|
setDIDBillingType |
- Updates the Billing Plan from a specific DID. |
|
setDIDInfo |
- Updates the information from a specific DID. |
|
setDIDPOP |
- Updates the POP from a specific DID. |
|
setDIDRouting |
- Updates the Routing from a specific DID. |
|
setDIDVoicemail |
- Updates the Voicemail from a specific DID. |
|
setDISA |
- Updates a specific DISA if a disa code is provided. - Adds a new DISA entry if no disa code is provided. |
|
setForwarding |
- Updates a specific Forwarding if a fwd code is provided. - Adds a new Forwarding entry if no fwd code is provided. |
|
setIVR |
- Updates a specific IVR if an IVR code is provided. - Adds a new IVR entry if no IVR code is provided. |
|
setPhonebook |
- Updates a specific Phonebook entry if a phonebook code is provided. - Adds a new Phonebook entry if no phonebook code is provided. |
|
setPhonebookGroup |
- Updates a specific Phonebook group if a phonebook code is provided. - Adds a new Phonebook group if no phonebook group code is provided. - Assigns or modifies group members if a member list is provided |
|
setQueue |
- Updates a specific Queue entry if a queue code is provided. - Adds a new Queue entry if no queue code is provided. |
|
setRecording |
- Updates a specific Recording File if a Recording ID is provided. - Adds a new Recording file entry if no Recording ID is provided. |
|
setRingGroup |
- Updates a specific Ring Group if a ring group code is provided. - Adds a new Ring Group entry if no ring group code is provided. |
|
setSIPURI |
- Updates a specific SIP URI if a SIP URI code is provided. - Adds a new SIP URI entry if no SIP URI code is provided. |
|
setSMS |
- Enable/Disable the SMS Service for a DID - Change the SMS settings for a DID |
|
setStaticMember |
- Updates a specific Member from queue if a Member code is provided. - Adds a new Member to Queue if no Member code is provided. |
|
setTimeCondition |
- Updates a specific Time Condition if a time condition code is provided. - Adds a new Time Condition entry if no time condition code is provided. |
|
unconnectDID |
- Unconnects specific DID from Reseller Client Sub Account. |
|
Fax |
|
|
connectFAX |
- Connects a specific FAX DID to a specific Reseller Client Sub Account |
|
unconnectFAX |
- Unconnects specific FAX DID from Reseller Client Sub Account. |
|
cancelFaxNumber |
- Deletes a specific Fax Number from your Account. |
|
deleteFaxMessage |
- Deletes a specific Fax Message from your Account. |
|
delEmailToFax |
- Deletes a specific "Email to Fax configuration" from your Account. |
|
delFaxFolder |
- Deletes a specific Fax Folder from your Account. |
|
getBackOrders |
- Retrieves a list of backorder DIDs if no additional parameter is provided. - Retrieves a specific backorder DID if a backorder DID code is provided. |
|
getFaxProvinces |
- Retrieves a list of Canadian Fax Provinces if no additional parameter is provided. - Retrieves a specific Canadian Fax Province if a province code is provided. |
|
getFaxStates |
- Retrieves a list of American Fax States if no additional parameter is provided. - Retrieves a specific American Fax State if a state code is provided. |
|
getFaxRateCentersCAN |
- Retrieves a list of Canadian Ratecenters by Province. |
|
getFaxRateCentersUSA |
- Retrieves a list of USA Ratecenters by State. |
|
getFaxNumbersInfo |
- Retrieves a list of Fax Numbers. |
|
getFaxNumbersPortability |
- Shows if a Fax Number can be ported into our network |
|
getFaxMessages |
- Retrieves a list of Fax Messages. - Retrieves a specific Fax Message if a Fax Message ID is provided. |
|
getFaxMessagePDF |
- Retrieves a Base64 code of the Fax Message to create a PDF file. |
|
getFaxFolders |
- Retrieves a list of Fax Folders from your account. |
|
getEmailToFax |
- Retrieves a list of "Email to Fax configurations" from your account if no additional parameter is provided. - Retrieves a specific "Email to Fax configuration" from your account if a ID is provided. |
|
mailFaxMessagePDF |
- Send a Fax Message attached as a PDF file to an email destination. |
|
moveFaxMessage |
- Moves a Fax Message to a different folder. |
|
orderFaxNumber |
- Orders and Adds a new Fax Number to the Account. |
|
setFaxFolder |
- Create or update the information of a specific Fax Folder. |
|
setEmailToFax |
- Create or update the information of a specific "Email to Fax configuration". |
|
searchFaxAreaCodeCAN |
- Retrieves a list of Canadian Ratecenters searched by Area Code. |
|
searchFaxAreaCodeUSA |
- Retrieves a list of USA Ratecenters searched by Area Code. |
|
setFaxNumberInfo |
- Updates the information from a specific Fax Number. |
|
setFaxNumberEmail |
- Updates the email configuration from a specific Fax Number. |
|
setFaxNumberURLCallback |
- Updates the url callback configuration from a specific Fax Number. |
|
sendFaxMessage |
- Send a Fax message to a Destination Number. |
|
e911 |
|
|
e911AddressTypes |
- Retrieves a list of e911 Address Types if no additional parameter is provided. - Retrieves a specific e911 Address Type if an Address code is provided. |
|
e911Cancel |
- Cancel the e911 Service from a specific DID. |
|
e911Info |
- Retrieves the e911 information from a specific DID. |
|
e911Provision |
- Subscribes your DID to the e911 Emergency Services. |
|
e911ProvisionManually |
- Subscribes your DID to the e911 Emergency Services. - All e911 information will be validated by the VoIP.ms staff. |
|
e911Update |
- Updates the Information from your e911 Emergency Services Subscription. |
|
e911Validate |
- Validates your e911 information in order to start your e911 Emergency Services Subscription. |
|
Local Number Portability (LNP) |
|
|
addLNPPort |
- Add one or more numbers to start a portability process. |
|
addLNPFile |
- Add an invoice file to a portability process. |
|
getLNPStatus |
- Retrieve the current status of a given portability process. |
|
getLNPNotes |
- Retrieve the list of notes from the given portability process. |
|
getLNPListStatus |
- Retrieve the list of possible status of a portability process. |
|
getLNPList |
- Retrieve the full list of all your portability processes. |
|
getLNPDetails |
- Retrieve the details of a given portability process. |
|
getLNPAttachList |
- Retrieve the list of invoice (attached) files from a given portability process. |
|
getLNPAttach |
- Retrieve the details of an attached invoice. |
|
Voicemail |
|
|
createVoicemail |
- Adds a new Voicemail entry to your Account |
|
delMessages |
- Deletes all messages in all servers from a specific Voicemail from your Account |
|
delMemberFromConference |
- Removes a member profile from a specific Conference from your Account |
|
delVoicemail |
- Deletes a specific Voicemail from your Account |
|
getPlayInstructions |
- Retrieves a list of Play Instructions modes if no additional parameter is provided. - Retrieves a specific Play Instructions mode if a play code is provided. |
|
getTimezones |
- Retrieves a list of Timezones if no additional parameter is provided. - Retrieves a specific Timezone if a timezone code is provided. |
|
getVoicemails |
- Retrieves a list of Voicemails if no additional parameter is provided. - Retrieves a specific Voicemail if a voicemail code is provided. |
|
getVoicemailFolders |
- Retrieves a list of default Voicemail Folders if no additional parameter is provided. - Retrieves a list of Voicemail Folders within a mailbox if mailbox parameter is provided. - Retrieves a specific Folder if a folder name is provided. |
|
getVoicemailMessageFile |
- Retrieves a specific Voicemail Message File in Base64 format. |
|
getVoicemailMessages |
- Retrieves a list of Voicemail Messages if mailbox parameter is provided. - Retrieves a list of Voicemail Messages in a Folder if a folder is provided. - Retrieves a list of Voicemail Messages in a date range if a from and to are provided. |
|
getVPRIs |
- Retrieves a list of vpri. |
|
markListenedVoicemailMessage |
- Mark a Voicemail Message as Listened or Unlistened. - If value is 'yes', the voicemail message will be marked as listened and will be moved to the Old Folder. - If value is 'no', the voicemail message will be marked as not-listened and will be moved to the INBOX Folder. |
|
markUrgentVoicemailMessage |
- Mark Voicemail Message as Urgent or not Urgent. - If value is 'yes', the voicemail message will be marked as urgent and will be moved to the Urgent Folder. - If value is 'no', the voicemail message will be unmarked as urgent and will be moved to the INBOX Folder. |
|
moveFolderVoicemailMessage |
- Move Voicemail Message to a Destination Folder. |
|
sendVoicemailEmail |
- Send a Voicemail Message File to an Email Address. |
|
setVoicemail |
- Updates the information from a specific Voicemail. |
FUNCTION STATUS AND ERROR CODE
All the API functions return a Status value after execution.
- If the function executes without any problems, then status value will be "success".
- If the function finds problems, the status will return an error code giving you an idea of what went wrong. You can find all possible error codes and short explanations in the following table
|
Error Codes |
|
|
account_with_dids |
The Account has DIDs assigned to it. |
|
api_limit_exceeded |
API requests limit per minute has been reached |
|
api_not_enabled |
API has not been enabled or has been disabled |
|
cancel_failed |
The cancellation wasn't completed. |
|
can_have_only_one_profile_without_pin |
The conference can just have one profile member without pin |
|
conference_member_relation_not_found |
There is no relation between the profile member and the conference. |
|
did_in_use |
DID Number is already in use |
|
did_limit_reached |
You have reached the maximum number of DID numbers allowed for your account type. Please contact our team if you have a specific use case or if you would like to upgrade to a Business account. |
|
duplicated_name |
There is already another entry with this name |
|
duplicated_pin |
The given pin has been duplicated |
|
e911_disabled |
DID e911 service it's not enabled. |
|
e911_pending |
DID e911 service has been requested and is in validation process. |
|
error_deleting_msg |
Error when deleting message |
|
error_moving_msg |
Error when move the voicemail message to folder |
|
exceeds_file_size |
The file exceeds the limite size allowed. |
|
existing_did |
You can't set a callback to an existing VoIP.ms DID number |
|
forwards_exceeded |
Your account is limited to 4 forward entries |
|
invalid_account |
This is not a valid account |
|
invalid_address |
Address is missing or the format is invalid. |
|
invalid_admin |
This is not a valid admin |
|
invalid_agent_ring_timeout |
This is not a valid Agent ring time out value |
|
invalid_allowedcodecs |
One of the codecs provided is invalid Format and Values: ulaw;g729;gsm;all |
|
invalid_announce_join_leave |
This is not a valid "Announce join leave" |
|
invalid_announce_only_user |
This is not a valid "Announce only user" |
|
invalid_announce_position_frequency |
This is not a valid Announce position frequency |
|
invalid_announce_round_seconds |
This is not a valid "Announce round seconds" |
|
invalid_announce_user_count |
This is not a valid "Announce user count" |
|
invalid_area_code |
this is not a valid Area Code. |
|
invalid_attachid |
The given ID is invalid or doesn't exist. |
|
invalid_attachmessage |
this is not a valid AttachMessage Should be: yes/no |
|
invalid_attach_file |
Valid formats: PDF, MS Word, BMP, JPG |
|
invalid_authtype |
This is not a valid Auth Type |
|
invalid_authtype_h323 |
You must select IP Auth to use H.323 |
|
invalid_authtype_iax2 |
You must use User/Password Authentication for IAX2 |
|
invalid_balancemanagement |
This is not a valid BalanceManagement |
|
invalid_base_recording |
This is not a valid recording path |
|
invalid_billingtype |
This is not a valid Billing Type Allowed values: 1 = PerMinute, 2 = Flat |
|
invalid_callback |
This is not a valid Callback |
|
invalid_callback_enable |
This is not a valid Callback enable value |
|
invalid_callback_retry |
This is not a valid Callback retry |
|
invalid_callerid |
This is not a valid CallerID |
|
invalid_calleridprefix |
This is not a valid CID Prefix, lenght should be less than 20 chars |
|
invalid_callerid_override |
This is not a valid CallerID Override |
|
invalid_callhunting |
This is not a valid Call Hunting |
|
invalid_callparking |
This is not a valid Call Parking |
|
invalid_callrecording |
This is not a valid Call recording |
|
invalid_call_type |
Call Type is not valid. |
|
invalid_canada_routing |
This is not a valid Canada Route |
|
invalid_carrier |
This is not a valid Carrier |
|
invalid_charge |
This is not a valid Charge |
|
invalid_city |
City is missing or the format is invalid. |
|
invalid_client |
This is not a valid Client |
|
invalid_cnam |
This is not a valid CNAM Should be: 1/0 |
|
invalid_codec |
This is not a valid Codec |
|
invalid_conference |
This is not a valid Conference ID |
|
invalid_contact |
This is not a valid Contact Number |
|
invalid_country |
Country is missing or the format is invalid, must be in format ISO 3166-1 alpha-2, example: US, CA, etc. (You can use the values returned by the method getCountries) |
|
invalid_countryid |
This is not a valid Country ID |
|
invalid_credentials |
Username or Password is incorrect |
|
invalid_date |
This is not a valid date Format is: yyyy-mm-dd |
|
invalid_daterange |
Date Range should be 92 days or less |
|
invalid_datetime |
This is not a valid datetime Format is: yyyy-mm-dd hh:mm:ss |
|
invalid_date_from |
The "From" date should be prior to the "To" date. |
|
invalid_dayrange |
This is not a valid Day Range |
|
invalid_delay_before |
This is not a valid DelayBefore |
|
invalid_deletemessage |
This is not a valid DeleteMessage Should be: yes/no |
|
invalid_description |
This is not a valid Description |
|
invalid_destination |
This is not a valid Destination |
|
invalid_destination_folder |
This is not a valid Destination Folder |
|
invalid_devicetype |
This is not a valid Device Type |
|
invalid_dialtime |
This is not a valid Dialtime |
|
invalid_did |
This is not a valid DID |
|
invalid_digits |
These are not valid DigitsOrderDIDVirtual: Digits must be 3 numbers |
|
invalid_digit_timeout |
This is not a valid DigitTimeOut |
|
invalid_disa |
This is not a valid DISA |
|
invalid_diversion_header |
This is not a valid Diversion Header. It must be a numeric value, accepting only 0 or 1. |
|
invalid_drop_silence |
This is not a valid "drop silence" value |
|
invalid_dst |
This is not a valid Destination Number |
|
invalid_dtmfmode |
This is no a valid DTMF Mode |
|
invalid_dtmf_digits |
This is no a valid DTMF digit |
|
invalid_email |
This is not a valid email or email is already in database |
|
invalid_email_attachment_format |
This is not a valid format value |
|
invalid_email_enable |
This is not a valid email enable value |
|
invalid_enable_ip_restriction |
This is not a valid Enable IP Restriction value |
|
invalid_enable_pop_restriction |
This is not a valid Enable POP Restriction value |
|
invalid_endhour |
This is not a valid End Hour |
|
invalid_endminute |
This is not a valid End Minute |
|
invalid_extension |
This is not a valid extension Extension can only contain digits |
|
invalid_failover_header |
This is not a valid failover header Should be: account/vm/fwd/none |
|
invalid_fax_id |
This is not a valid Fax Message ID |
|
invalid_file |
This is not a valid File |
|
invalid_filter |
This is not a valid Filter |
|
invalid_firstname |
First name is missing or the format is invalid. |
|
invalid_foc_enddate |
Invalid date format, must be: YYYY-mm-dd. Example: 2018-02-22 |
|
invalid_foc_startdate |
Invalid date format, must be: YYYY-mm-dd. Example: 2018-02-22 |
|
invalid_folder |
This is not a valid Folder |
|
invalid_folder_id |
This is not a valid Fax Folder ID |
|
invalid_forwarding |
This is not a valid forwarding |
|
invalid_forwarding_did |
Forwarding to the same did is not allowed |
|
invalid_forward_enable |
This is not a valid forward enable value |
|
invalid_frequency_announcement |
This is not a valid Frequency announce |
|
invalid_from_number |
This is not a valid sender number. |
|
invalid_fullname |
This is not a valid Full Name |
|
invalid_id |
This is not a valid ID |
|
invalid_if_announce_position_enabled_report_e |
This is not a Report estimated hold time type |
|
invalid_internaldialtime |
This is not a valid Internal Dialtime Should be: 1 to 60 |
|
invalid_internalvoicemail |
This is not a valid Internal Voicemail |
|
invalid_internationalroute |
This is not a valid International Route |
|
invalid_invoice_type |
Invalid invoice type, possible values: 0 = US, 1 = CAN. |
|
invalid_ip |
This is an invalid IP |
|
invalid_ip_auth |
Do not provide an IP address for User/Pass Authentication |
|
invalid_ip_iax2 |
Do not provide an IP address for IAX2 |
|
invalid_ivr |
This is not a valid IVR |
|
invalid_jitter_buffer |
This is not a valid "jitter buffer" value |
|
invalid_join_announcement |
This is not a valid 'Join Announcement' Type for a Queue |
|
invalid_join_empty_type |
This is not a valid 'JoinWhenEmpty' Type for a Queue |
|
invalid_language |
This is not a valid Language Should be: es/en/fr |
|
invalid_lastname |
Lastname is missing or the format is invalid. |
|
invalid_listened |
This is not a valid Listened value |
|
invalid_location |
This is not a valid Location |
|
invalid_lockinternational |
This is not a valid Lock International |
|
invalid_mailbox |
This is not a valid mailbox |
|
invalid_maximum_callers |
This is not a valid maximum callers value |
|
invalid_maximum_wait_time |
This is not a valid maximum wait time value |
|
invalid_max_expiry |
This is not a valid Max Expiry (value must be between 60 and 3600 seconds) |
|
invalid_member |
This is not a valid Member |
|
invalid_member_delay |
This is not a valid Member Delay |
|
invalid_message_num |
This is not a valid Voicemail Message Number |
|
invalid_method |
This is not a valid Method |
|
i< |