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:
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)
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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 a specific account. |
| 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. |
| 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. |
| Clients | |
| addCharge | - Adds a Charge to a specific Reseller Client |
| addPayment | - Adds a Payment to a specific Reseller Client |
| 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. |
| 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. |
| 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. |
| delForwarding | - Deletes a specific Forwarding from your Account. |
| delIVR | - Deletes a specific IVR from your Account. |
| delPhonebook | - Deletes a specific Phonebook 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| Voicemail | |
| createVoicemail | - Adds a new Voicemail entry to your Account |
| delMessages | - Deletes all messages in all servers from a specific Voicemail 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. |
| 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
- 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_not_enabled | API has not been enabled or has been disabled |
| did_in_use | DID Number is already in use |
| 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_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_position_frequency | This is nota a valid Announce position frequency |
| invalid_announce_round_seconds | This is nota a valid Announce round seconds |
| invalid_attachmessage | this is not a valid AttachMessage Should be: yes/no |
| 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_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_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_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_contact | This is not a valid Contact Number |
| invalid_country | This is not a valid country Examples: US / CA |
| 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_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_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 Digits
|
| invalid_digit_timeout | This is not a valid DigitTimeOut |
| invalid_disa | This is not a valid DISA |
| invalid_dst | This is not a valid Destination Number |
| invalid_dtmf_digits | This is no a valid DTMF digit |
| invalid_dtmfmode | This is no a valid DTMF Mode |
| 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_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_file | This is not a valid File |
| invalid_filter | This is not a valid Filter |
| invalid_forward_enable | This is not a valid forward enable value |
| invalid_forwarding | This is not a valid forwarding |
| invalid_forwarding_did | Forwarding to the same did is not allowed |
| invalid_frequency_announcement | This is nota a valid Frequency announce |
| invalid_id | This is not a valid ID |
| invalid_if_announce_position_enabled_report_estimated_hold_time | 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_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_join_empty_type | This is not a valid 'JoinWhenEmpty' Type for a Queue |
| invalid_join_announcement | This is not a valid 'Join Announcement' Type for a Queue |
| invalid_language | This is not a valid Language Should be: es/en/fr |
| 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_method | This is not a valid Method |
| invalid_member | This is not a valid Member |
| invalid_member_delay | This is not a valid Member Delay |
| invalid_minute | This is not a valid Minute Rate |
| invalid_monthly | This is not a valid Montly Fee |
| invalid_musiconhold | This is not a valid Music on Hold |
| invalid_name | This is not a valid name, Alphanumeric Only |
| invalid_nat | This is not a valid NAT |
| invalid_note | This is not a valid Note, lenght should be less than 50 chars |
| invalid_number | This is not a valid Number |
| invalid_package | This is not a valid Package |
| invalid_password | This is not a valid password
|
| invalid_password_auth | Do not provide a Password for IP Authentication |
| invalid_password_lessthan_8characters_long | This is not a valid password (Less than 8 characters long) |
| invalid_password_missing_uppercase | This is not a valid password (Missing upper case character) |
| invalid_password_missing_lowercase | This is not a valid password (Missing lower case character) |
| invalid_password_ilegal_characters | This is not a valid password (Allowed characters: Alphanumeric and ! # $ % & / ( ) = ? * [ ] _ : . , { } + -) |
| invalid_password_missing_number | This is not a valid password (Missing a number) |
| invalid_pause | This is not a valid Pause |
| invalid_payment | This is not a valid Payment |
| invalid_phonebook | This is not a valid Phonebook |
| invalid_phonenumber | This is not a valid Phone Number |
| invalid_pin | This is not a valid PIN |
| invalid_playinstructions | This is not a valid PlayInstructions Should be: u/su |
| invalid_priority | This is not a valid Priority |
| invalid_protocol | This is not a valid Protocol |
| invalid_province | This is not a valid Province |
| invalid_quantity | This is not a valid quantity |
| invalid_query | This is not a valid Query |
| invalid_queue | This is not a valid Queue |
| invalid_recording | This is not a valid recording |
| invalid_report_hold_time_agent | This is not a valid Report hold time agent |
| invalid_resellerclient | This is not a valid Reseller Client |
| invalid_resellernextbilling | This is not a valid Reseller Next Billing date, date should not be set in the past. |
| invalid_resellerpackage | This is not a valid Reseller Package |
| invalid_response_timeout | This is not a valid ResponseTimeOut |
| invalid_retry_timer | This is not a valid Retry timer |
| invalid_ringgroup | This is not a valid Ring group |
| invalid_ring_inuse | This is not a valid Ring in use value |
| invalid_route | This is not a valid Route |
| invalid_routing_header | This is not a valid Routing header Should be: account/vm/fwd |
| invalid_saycallerid | This is not a valid SayCallerID Should be: yes/no |
| invalid_saytime | This is not a valid SayTime Should be: yes/no |
| invalid_serverpop | This is not a valid Server POP |
| invalid_setup | This is not a valid Setup Fee |
| invalid_sipuri | This is not a valid SIPURI |
| invalid_sms | This is not a valid SMS |
| invalid_sms_forward | |
