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 | This is not a valid SMS forward |
| invalid_skippassword | This is not a valid skippassword Should be: 1/0 - or - yes/no |
| invalid_speed_dial | This is not a valid Speed Dial |
| invalid_starthour | This is not a valid Start Hour |
| invalid_startminute | This is not a valid Start Minute |
| invalid_state | This is not a valid State |
| invalid_strategy | This is not a valid Ring Strategy |
| invalid_thankyou_for_your_patience | This is not a valid Thankyou for your patience value |
| Invalid_threshold | This is not a valid Threshold Amount. The Threshold Amount should be between 1 and 250 |
| invalid_timecondition | This is not a valid Time Condition |
| invalid_timeout | This is not a valid timeout |
| invalid_timerange | This is not a valid Timer Range |
| invalid_timezone | This is not a valid Timezone
|
| invalid_type | This is not a valid Type |
| invalid_username | This is not a valid Username |
| invalid_voice_announcement | This is not a valid Voice announce |
| invalid_voicemailsetup | This is not a valid voicemail |
| invalid_wrapup_time | This is not a valid Wrapup time |
| invalid_weekdayend | This is not a valid Week End |
| invalid_weekdaystart | This is not a valid Week Start |
| invalid_priority_weight | This is not valid weight/priority value |
| ip_not_enabled | This IP is not enabled for API use |
| limit_reached | You have reached the maximum number of SMS messages allowed per day using the API (100 Messages) |
| max_phonebook | Your account is limited to 8 SIP, IAX or SIP URI members |
| members_exceeded | You have reached the maximum allowed entries for the Phonebook |
| method_maintenance | This API method is under maintenance |
| mismatch_email_confirm | e-mail confirm does not match with e-mail |
| mismatch_password_confirm | Pasword confirm does not match with Password |
| missing_account | Account was not provided |
| missing_address | Address was not provided |
| missing_agent_ring_timeout | Agent ring time out was not provided |
| missing_allowedcodecs | Allowed Codecs were not provided |
| missing_attachmessage | AttachMessage was not provided |
| missing_authtype | Auth Type was not provided |
| missing_balancemanagement | BalanceManagemente was not provided |
| missing_billingtype | Billing Type was not provided |
| missing_callback | Callback was not provided |
| missing_callerid | CallerID was not provided |
| missing_carrier | Carrier was not provided |
| missing_charge | Charge was not provided. |
| missing_choices | Choices was not provided |
| missing_city | City was not provided |
| missing_client | Client was not provided |
| missing_cnam | CNAM was not provided |
| missing_codec | Codec was not provided |
| missing_country | Country was not provided |
| missing_countryid | Country ID was not provided |
| missing_credentials | Username or Password was not provided |
| missing_delay_before | DelayBefore was not provided |
| missing_deletemessage | DeleteMessage was not provided |
| missing_description | Description was not provided |
| missing_devicetype | Device Type was not provided |
| missing_dialtime | Dialtime was not provided |
| missing_did | DID was not provided |
| missing_digits | Digits were not provided |
| missing_digit_timeout | DigitTimeOut was not provided |
| missing_disa | DISA was not provided |
| missing_dtmfmode | DTMF Mode was not provided |
| missing_email | e-mail was not provided |
| missing_email_confirm | e-mail confirm was not provided |
| missing_enable | Enable was not provided |
| missing_endhour | End Hour was not provided |
| missing_endminute | End Minute was not provided |
| missing_failover_busy | Failover Busy was not provided |
| missing_failover_noanswer | Failover NoAnswer was not provided |
| missing_failover_unreachable | Failover Unreachable was not provided |
| missing_file | File was not provided |
| missing_filter | Filter was not provided |
| missing_firstname | Firstname was not provided |
| missing_forwarding | Forwarding was not provided |
| missing_id | ID was not provided |
| missing_if_announce_position_enabled_report_estimated_hold_time | 'If announce position enabled report estimated hold time' type was not provided |
| missing_internationalroute | International Route was not provided |
| missing_ip | You need to provide an IP if you select IP Authentication Method |
| missing_ip_h323 | You must enter an IP Address for H.323 |
| missing_ivr | IVR was not provided |
| missing_join_when_empty | 'JoinWhenEmpty' type was not provided |
| missing_language | Language was not provided |
| missing_lastname | Lastname was not provided |
| missing_leave_when_empty | 'LeaveWhenEmpty' type was not provided |
| missing_location | Location was not provided |
| missing_lockinternational | Lock International was not provided |
| missing_mailbox | Mailbox was not provided |
| missing_members | You need at least 1 member to create a ring group |
| missing_member | Member was not provided |
| missing_method | Method must be provided when using the REST/JSON API |
| missing_minute | Minute Rate was not provided |
| missing_monthly | Monthly Fee was not provided |
| missing_musiconhold | Music on Hold was not provided |
| missing_name | Name was not provided |
| missing_nat | NAT was not provided |
| missing_number | Number was not provided |
| missing_package | Package was not provided |
| missing_password | Password was not provided |
| missing_password_confirm | Password Confirm was not provided |
| missing_payment | Payment was not provided. |
| missing_phonebook | Phonebook was not provided |
| missing_phonenumber | Phone Number was not provided |
| missing_pin | PIN was not provided |
| missing_playinstructions | PlayInstructions was not provided |
| missing_priority | Priority was not provided |
| missing_protocol | Protocol was not provided |
| missing_province | Province was not provided |
| missing_query | Query was not provided |
| missing_recording | Recording was not provided |
| missing_report_hold_time_agent | Report hold time agent was not provided |
| missing_resellerclient | Provide a Reseller Client or don't provide a Reseller Package |
| missing_resellerpackage | Provide a Reseller Package or don't provide a Reseller Client |
| missing_response_timeout | ResponseTimeOut was not provided |
| missing_ringgroup | Ring group was not provided |
| missing_ring_inuse | Ring in use was not provided |
| missing_ring_strategy | Ring strategy was not provided |
| missing_route | Route was not provided |
| missing_routing | Routing was not provided |
| missing_saycallerid | SayCallerID was not provided |
| missing_saytime | SayTime was not provided |
| missing_serverpop | Server POP was not provided |
| missing_setup | Setup Fee was not provided |
| missing_sipuri | SIPURI was not provided |
| missing_sms | SMS was not provided |
| missing_skippassword | SkipPassword was not provided |
| missing_speed_dial | Speed Dial was not provided |
| missing_starthour | Start Hour was not provided |
| missing_startminute | Start Minute was not provided |
| missing_state | State was not provided |
| missing_thankyou_for_your_patience | Thankyou for your patience was not provided |
| missing_timecondition | Time Condition was not provided |
| missing_timeout | Timeout was not provided |
| missing_timezone | Timezone was not provided |
| missing_type | Type was not provided |
| missing_uri | URI was not provided |
| missing_username | Username was not provided |
| missing_voicemailsetup | Voice mail setup was not provided |
| missing_weekdayend | Week End was not provide |
| missing_weekdaystart | Week Start was not provided |
| missing_priority_weight | Priority/Weight was not provided |
| missing_zip | Zip Code was not provided |
| non_sufficient_funds | Your account does not have sufficient funds to proceed |
| no_account | There are no accounts |
| no_base64file | File not encoded in base64 |
| no_callback | There are not Callbacks |
| no_callstatus | No Call Status was provided. One of the following parameters needs to be set to "1": answered, noanswer, busy, failed |
| no_cdr | There are no CDR entries for the filter |
| no_change_billingtype | Imposible change DID billing plan |
| no_client | There are no Clients |
| no_did | There are no DIDs |
| no_disa | There are no DISAs |
| no_filter | There are no Filters |
| no_forwarding | There was no Forwarding |
| no_ivr | There are no ivr |
| no_mailbox | There are no Mailboxes |
| no_member | There are no Static Members |
| no_package | there are no Packages |
| no_phonebook | There are no Phonebook entries |
| no_queue | There are no Queue entries |
| no_rate | There are no Rates |
| no_recording | There are no recordings |
| no_ringgroup | There are no Ring groups |
| no_sipuri | There are no SMS messages |
| no_sms | There are no SIP URIs |
| no_timecondition | There are no Time Conditions |
| provider_outofservice | One of our providers is out of service |
| recording_in_use_did | You have a DID using this Recording |
| recording_in_use_queue | You have a Calling Queue using this Recording |
| recording_in_use_ivr | You have an IVR using this Recording |
| recording_in_use_caller_id_filtering | You have a Caller ID Filtering using this Recording |
| recording_in_use_caller_timecondition | You have a Time Condition using this Recording |
| repeated_ip | You already have a Subaccount using this IP and Protocol |
| reserved_ip | This is a reserved IP used by VoIP.ms or other Companies |
| same_did_billingtype | The Billing Type provided and DID billing type are the same |
| sipuri_in_phonebook | This SIPURI can't be deleted, it is mapped in the phonebook |
| sms_toolong | The SMS message exceeds 160 characters |
| sms_failed | The SMS message was not sent |
| Unable_to_purchase | Unable to purchase DIDs |
| unavailabl | |
