Web Service Errors

Error CodesError Responses

Error Codes

This page lists the error codes that can be returned by the webservice, click the error code for more information and potential solutions to common issues

0001 : A mandatory parameter has not been specified. The missing parameter will be mentioned in the error string.

HTTP Error code

400

Remedy

Include the parameter in the web service request.

0002 : The parameter is malformed. This error will be produced if the string sent fails a sanity check of the data that is sent to the web service. For example, specifying a country with numbers will produce this error.

HTTP Error code

400

Remedy

Check the string you're sending to the web service.

0003 : Multiple versions of the same named parameter have been passed to the web service, where only one is required.

HTTP Error code

400

Remedy

Check the data being sent to the web service.

0004 : The parameter type is numeric, but with a value of zero. This is not allowed.

HTTP Error code

400

Remedy

You must specify a value of one or more.

0005 : No regulation address has been specified when attempting to buy a number, but this country requires one to be associated with the purchased numbers.

HTTP Error code

400

Remedy

If you haven't already done so, you must first create a valid address on the Cloud website. Then, pass the name given to the address when attempting to purchase the number.

0006 : The named regulation address is not compatible with the country and region being used. There are three types of addresses that can be required: Local, National and Worldwide. A Local address means the regulation address supplied must be located in the same region and country as the number you're trying to purchase. National means any regulation address can be used, as long as it is located within the country the numbers are trying to be purchased from. Finally, Worldwide means any address in the world can be used for a regulation address.

HTTP Error code

400

Remedy

Check the error message being reported by the web service. This will let you know which type of address is required.

0007 : A boolean parameter must be specified as either 'True', 'T' or '1' for true, or 'False', 'F' or '0' for false. Sending anything else will result in this error message.

HTTP Error code

400

Remedy

Check the data being sent to the web service.

0008 : The server doesn't know the country with the specified DID type.

HTTP Error code

400

Remedy

Check the data being sent to the web service. If it looks correct, make sure it matches exactly the country name from tel_get_supported_countries with the appropriate DID type.

0009 : The region is unknown to the server.

HTTP Error code

400

Remedy

Check the data being sent to the web service. If it looks correct, make sure it matches exactly the region name from tel_get_supported_regions when passing the same country and, if required, state as parameters.

0010 : The state is unknown to the server.

HTTP Error code

400

Remedy

Check the data being sent to the web service. If it looks correct, make sure it matches exactly the state name from tel_get_supported_states using the same country as a parameter.

0011 : You've supplied a state, but numbers with the DID type and in the country supplied are not associated with states. Perhaps the country doesn't have states.

HTTP Error code

400

Remedy

If the DID type and country you supplied are correct, remove the state. Note that, if you do want to purchase a number in a particular state, the DID type must be geographic.

0012 : The supplied regulation address does not exist under your account.

HTTP Error code

400

Remedy

Check the regulation address is correct. You can call tel_list_regulation_address to get a list of the addresses under your account.

0013 : Data within this call needs to be conducted over HTTPS as it contains personal information.

HTTP Error code

403

Remedy

Use HTTPS, rather than HTTP.

0014 : The request method you have specified is not allowed.

HTTP Error code

405

Remedy

Use a method that is allowed (The allowed methods will be mentioned in the JSON error response).

0015 : The Cloud ID given in the request was invalid, it must be in the form Region-Layer-Cloud. See https://www.aculab.com/cloud/guides/cloud-regions for more information.

HTTP Error code

400

0016 : This operation requires a filename to be passed, which is missing.

HTTP Error code

400

Remedy

Pass a filename into the operation.

0017 : The filename supplied can't be found on the server.

HTTP Error code

404

Remedy

Check the filename you're sending to the web service.

0018 : The server had a problem when accessing storage.

HTTP Error code

504

Remedy

Retry the request in a few minutes. If the problem persists, please contact us.

0019 : The POST request to the server is empty.

HTTP Error code

400

Remedy

Check the POST you're sending the web service. It must not be empty.

0020 : No content length has been supplied to the server.

HTTP Error code

411

Remedy

Check the options you are sending the web service. Supply a Content-Length header in your HTTP request.

0021 : The request could not be decoded. This error occurs when either the request body does not match the specified content type and content encoding, or the query contains invalid characters.

HTTP Error code

400

Remedy

Ensure the Content-Type and Content-Encoding headers match the body encoding and that any query string escape sequences contain valid UTF-8 encoded characters.

0022 : Basic HTTP authentication of your request failed because the Username or API Access Key/outbound service password you provided was incorrect. See https://www.aculab.com/cloud/web-services/overview for information on how to set them, unless you're requesting service_start in which case see https://www.aculab.com/cloud/web-services/starting-outbound-services instead.

HTTP Error code

401

Remedy

Check the data you're sending the web service. If you provided a service where none was allowed, remove it.

0023 : A mandatory parameter has been specified, but its contents is empty.

HTTP Error code

400

Remedy

Check the data you're sending the web service.

0024 : A parameter has been specified as a list, but one or more of its elements are empty.

HTTP Error code

400

Remedy

Check the parameter being sent to the web service.

0025 : The reference ID parameter is malformed. The ID consists of three parts, seperated by a dot. The first is hexidecimal, the other two purely decimal. Ensure that every ID you pass is one that was returned from the web services API. If you need to provide more than one, separate with a forward slash.

HTTP Error code

400

Remedy

Ensure you are sending the correct ID to the web service.

0026 : There must be at least a minute gap between conference manipulation requests.

HTTP Error code

400

Remedy

Leave at least the required gap.

0027 : The API service to use is unknown to the server.

HTTP Error code

400

Remedy

Check your spelling of the web service page.

0028 : States are only used by geographic numbers in limited countries. They are not required in national or toll-free numbers.

HTTP Error code

400

0029 : A parameter has been specified which is not recognised by this API.

HTTP Error code

400

Remedy

Check your spelling or remove the parameter.

0030 : The parameters specified are incompatible with one another.

HTTP Error code

400

Remedy

Specify one or the other of the specified parameters.

0031 : The specified parameter is required to be unique, but the supplied value already exists in the system.

HTTP Error code

409

Remedy

Check to see if you have accidentally duplicated a call, or change the id.

0032 : The HTTP request did not contain a Content-Type header or contained a Content-Type header that was invalid.

HTTP Error code

400

Remedy

Set the Content-Type header to a valid type (The valid types will be mentioned in the JSON error response).

0100 : You're using a Developer account, but need a Production or Premium account to perform this operation.

HTTP Error code

400

Remedy

Upgrade to a Production account - while logged in, click Account then Upgrade.

0101 : The account has insufficient funds to perform the operation. The error message will tell you how much credit is required to allow the operation.

HTTP Error code

403

Remedy

Add sufficient credit - while logged in, click Account then Add funds.

0102 : The operation cannot be performed because it is forbidden. You've supplied an unknown based_on parameter.

HTTP Error code

403

Remedy

Check the data being sent to the web service, ensuring that you have the specified Inbound Service in your account.

0103 : The username supplied is invalid.

HTTP Error code

404

Remedy

Please check you are sending the correct username, and then retry .

0104 : The application instance ID supplied does not exist.

HTTP Error code

403

Remedy

Please check you are sending the correct application instance ID, and then retry.

0105 : A request to interrupt a REST application has been received, but the application has already completed.

HTTP Error code

403

0106 : Your account has been deactivated and it is no longer possible to make any web service requests. If this message is a suprise to you, please contact support.

HTTP Error code

403

0107 : Your account has not been enabled for access to VoiSentry. If you think this is incorrect, please contact support.

HTTP Error code

403

0200 : There isn't sufficient stock of inbound numbers in the required area to complete this request. Consider purchasing stock in another areas. Alternatively, let us know, and we might be able to increase stocks.

HTTP Error code

403

Remedy

If appropriate, use the allow_partial flag. This will allow you to buy as many as possible of the requested numbers, rather than the full amount.

0201 : did_type must be one of geographic, national, tollfree or mobile.

HTTP Error code

400

Remedy

Specify a valid did_type.

0202 : You can choose which phone types can call your toll-free number, the cost-per-minute depending on which options you pick. Your API call had no allowable types. At least one must be allowed.

HTTP Error code

400

Remedy

Set ordinary_cpc, cellular_cpc or payphone_cpc to true.

0203 : Calls from phones of the supplied type to toll free numbers with the supplied country and region (prefix) are not allowed.

HTTP Error code

400

Remedy

Either set this type to False, or choose another region (prefix) which does allow this type.

0300 : The telephone number to delete does not belong to your account, so it cannot be deleted.

HTTP Error code

400

Remedy

Check the data being sent to the web service. If in doubt, use the tel_list_numbers function to get a list of your numbers.

0301 : The telephone number either does not exist, or does not belong to your account.

HTTP Error code

400

Remedy

Check the data being sent to the web service. If in doubt, use the tel_list_numbers function to get a list of your numbers.

0302 : The telephone number has not been found in the whitelist for your account.

HTTP Error code

400

Remedy

Check that the number in whitelisted on your account.

0401 : The filename supplied is illegal on the Aculab Cloud. Either one or more characters were invalid, there was problem with the file extension or there was a problem with the file path.

HTTP Error code

400

Remedy

Check the online documentation for the web service that has triggered this error, refer to the Media File Names and Extensions character restrictions guide and retry the request with a valid filename.

0402 : The format of the WAV or TIFF file you're uploading is not supported by Aculab Cloud. See https://www.aculab.com/cloud/guides/sending-and-receiving-faxes for more information about which WAV formats are supported, and https://www.aculab.com/cloud/guides/sending-and-receiving-faxes/supported-fax-formats for TIFF specifications.

HTTP Error code

415

Remedy

If using a WAV file, change the sampling rate or codec so they're suitable for use by Acualb Cloud. If using a TIFF file, re-process the image.

0403 : The from parameter is missing.

HTTP Error code

400

Remedy

Specify a valid from file.

0404 : The to parameter is missing.

HTTP Error code

400

Remedy

Specify a valid to file.

0405 : The token provided is either invalid, lapsed, or otherwise unidentified. Note that tokens returned by media_delete are stored for only four hours after delete completion.

HTTP Error code

404

Remedy

Try again with a valid token.

0406 : A valid MEDIA filetype has been supplied. However, MEDIA filetypes cannot operate with the requested function.

HTTP Error code

400

0407 : A valid REST filetype has been supplied. However, REST filetypes cannot operate with the requested function.

HTTP Error code

400

0408 : The supplied filetype must be one of the types given in the error message.

HTTP Error code

400

Remedy

Use a correct filetype.

0409 : The number of hours to live is greater than the maximum specified in the error message.

HTTP Error code

400

Remedy

Specify a lower number of hours.

0410 : The number of days to live is greater than the maximum specified in the error message.

HTTP Error code

400

Remedy

Specify a lower number of days.

0411 : The number of minutes to live is greater than the maximum specified in the error message.

HTTP Error code

400

Remedy

Specify a lower number of minutes.

0412 : The time to live specification is invalid. This should be in the format n[d|h|m], which n is the unit, and [d|h|m] specifies days, hours or minutes.

HTTP Error code

400

Remedy

Use a correct time to live specification.

0413 : You cannot specify a time to live for this filetype. Time to live can only be specified for MEDIA files.

HTTP Error code

400

Remedy

Change the filetype to MEDIA.

0414 : You cannot upload encrypted MSG_MEDIA files. You can only upload encrypted MEDIA files.

HTTP Error code

400

Remedy

Decrypt the file and upload without the encrypted argument.

0415 : The prefix paramater can not contain a / character.

HTTP Error code

400

Remedy

The folder should be specified in the foldername argument, the prefix should be the prefix within the specified folder.

0500 : The supplied report type is unsupported. Valid report types are: 'adr', 'cdr', 'fdr', 'msg' and 'err'.

HTTP Error code

400

Remedy

Use one of the valid report types.

0501 : The report file type is unsupported. Valid report file types are: csv and json.

HTTP Error code

400

Remedy

Use a valid report file type.

0503 : When generating a full report, a json report file type must be requested.

HTTP Error code

400

Remedy

Specify json when generating a full report.

0504 : The specified date and time are in the incorrect format. Format must be YYYY-MM-DD_hh:mm:ss, with the date and time in UTC.

HTTP Error code

400

Remedy

Change the date and time to the required format.

0505 : The supplied from date and time must come before the to date and time.

HTTP Error code

400

Remedy

Check the parameters you are sending to the web service, making sure the date and time order are correct.

0506 : You've requested a report convering more days that the two month maximum allowed.

HTTP Error code

400

Remedy

Reduce the number of days the report must cover.

0507 : You've already requested an identical report, which is still being generated.

HTTP Error code

409

Remedy

Wait for the previous report to finish rather than resubmitting. If you think the other report is stuck, cancel it before resubmitting.

0508 : The from date is too far in the past, data is only stored for 6 months, including the current month.

HTTP Error code

400

Remedy

Resubmit your request with a from date no more than 6 months ago.

0509 : You currently have the maximum number of reports in progress. You must wait for existing reports to complete before you can start more.

HTTP Error code

429

Remedy

Please wait for some of your existing reports to complete before starting a new one.

0510 : Your report cannot be started at this time due to capacity restrictions on the cloud. In order to maintain quality of the cloud as a whole we limit the total number of active reports across the cloud.

HTTP Error code

429

Remedy

Please wait a short while and submit your report again.

0600 : The supplied number of participants is invalid. It needs to be between a range as specified by the web service, inclusive.

HTTP Error code

400

Remedy

Supply a valid number of participants.

0601 : The start time supplied is invalid. Time must be UTC in the format YYYY-MM-DD-HH-MM, all integers. It must be at least five minutes away and not more than 24 hours away.

HTTP Error code

400

Remedy

Supply a valid start time.

0602 : The supplied conference duration is invalid. It must be in minutes and in the range specified in the error text.

HTTP Error code

400

Remedy

Supply a valid duration.

0603 : A conference with this name is already reserved.

HTTP Error code

400

Remedy

Use a different conference name. Try adding some time-related or random characters to the start of the conference name to make it unique.

0604 : The reservation_token is not valid.

HTTP Error code

400

Remedy

Supply a reservation_token returned by conference_reservation_create.

0605 : This conference can't be modified, as it's already been cancelled.

HTTP Error code

400

Remedy

To modify a conference, you must use a reservation_token from an existing conference reservation. Call conference_list to get these.

0606 : The request would increase the total conference duration to above 480 minutes.

HTTP Error code

400

Remedy

Supply a shorter duration.

0607 : This conference has already finished.

HTTP Error code

400

Remedy

Supply a reservation_token for a conference which hasn't yet finished.

0608 : This conference is due to start in less that five minutes, so it's too late to cancel it.

HTTP Error code

400

Remedy

Supply a reservation_token for a conference which is due to start later.

0609 : The conference has already started, and you can't cancel a conference while it's running.

HTTP Error code

400

Remedy

Supply a reservation_token for a conference which has not yet started.

0610 : This conference is due to finish in less than five minutes, so it's too late to extend its duration.

HTTP Error code

400

Remedy

Supply a reservation_token for a conference which isn't close to ending.

0611 : The conference start time must be after the current time.

HTTP Error code

400

Remedy

Check the time being sent to the web service is after the current time, UTC.

0612 : You've tried to reserve a conference with more participants than are allowed on your account.

HTTP Error code

400

Remedy

Either supply a smaller number of participants, or contact us to request that we increase the limit.

0613 : No conference of that name is currently known to the system.

HTTP Error code

404

Remedy

Check what conference currently exist using conference_list.

0614 : No participant of that name is currently known to the system.

HTTP Error code

404

Remedy

Check what participants currently exist in the conference using conference_participant_list.

0615 : The conference is not currently in the running state.

HTTP Error code

400

Remedy

The conference may have not yet started, call again when it has.

0616 : Both the conference_name and reservation_token parameters have been supplied rather than just one or the other.

HTTP Error code

400

Remedy

Use either the conference_name or the reservation_token to reference your conference, but not both at once.

0617 : At least one of the participant options must be specified.

HTTP Error code

400

Remedy

Try again with at least one of the participant options defined.

0700 : You've supplied a "from" number which is not one you've purchased on your Aculab Cloud account, so the message could not be sent.

HTTP Error code

400

Remedy

Try again using a "from" number which you purchased on your account.

0701 : The mobile phone with number "to" has previously sent an opt-out message to stop further messages from your "from" number. It's not since then sent an opt-in message, so your message could not be sent.

HTTP Error code

403

Remedy

Please stop sending such messages to this mobile phone.

0702 : Delivery reporting has been requested, but this is not supported to this "to" number by the carrier used to send messages from your "from" number, so your message could not be sent.

HTTP Error code

400

Remedy

Please don't request delivery reporting when you send messages to this "to" number from this "from" number.

0703 : The content can't be encoded into a form we can send to the carrier, so your message could not be sent.

HTTP Error code

400

Remedy

Please submit messages with content which is encoded as UTF-8.

0704 : The content is too long for us to split into individual messages we can send to the carrier, so your message could not be sent.

HTTP Error code

400

Remedy

Please submit messages with content which is encoded as UTF-8 and has a length of 1200 characters or less.

0705 : The content is too long for us to send as a single message to a non multipart capable carrier, so your message could not be sent.

HTTP Error code

400

Remedy

Please submit messages with content which is encoded as UTF-8 and, if ASCII encodeable, with a length of 140 characters or fewer, else with a length of 70 characters or fewer.

0706 : The type is unhandled, so your message could not be sent. Please check to documentation to see which types are supported.

HTTP Error code

400

0707 : The status_method is unhandled. We support POST and GET only, so your message could not be sent. Please try again using an allowed status_method.

HTTP Error code

400

0708 : Messages are not enabled on this "from" number, so your message could not be sent. To enable messages on this number, click Account, Purchases and ensure a green envelope is displayed for the number. If a red envelope is displayed, click to change to green. Note that, to send messages, this number must have been purchased from Aculab Cloud.

HTTP Error code

400

0709 : Either "to" or "from" is missing. One or the other parameter must be supplied.

HTTP Error code

400

0710 : Either the 'to' or "from" field must be presented. You cannot present both.

HTTP Error code

400

0711 : This would exceed the maximum number of messages for this phone number in the message queue, so the message could not be sent.

HTTP Error code

429

0712 : You've supplied a "to" number which is invalid or has a country code which Aculab Cloud cannot send to, so the message could not be sent.

HTTP Error code

400

Remedy

Try again using a valid "to" number with a country code Aculab Cloud can send to.

0713 : Your account must be configured to use flash SMS. Please contact support.

HTTP Error code

400

0714 : Your account must be configured to use alphanumeric sender IDs. Please contact support.

HTTP Error code

400

0718 : Your account must be configured to allow sending SMS to US telephone numbers.

HTTP Error code

400

Remedy

Please contact support to discuss your requirements.

0719 : Messages of the type requested do not support using the named parameter.

HTTP Error code

400

Remedy

Send the message with a different type or without the named parameter.

0720 : Messages of the type requested require the use of the named parameter.

HTTP Error code

400

Remedy

Send the message with a different type or with the named parameter.

0721 : There was a problem with at least one message media file.

HTTP Error code

400

Remedy

Check the message media files exist and are suitable for sending using the message type.

0722 : US SMS requires a campaign registration ID recorded against all numbers used for sending A2P SMS messages.

HTTP Error code

400

Remedy

Please contact support for assistance in registering with the campaign registry.

0723 : This 'from' number has a campaign registration ID, but the campaign registration has expired.

HTTP Error code

400

Remedy

Please contact support for assistance with updating your campaign registration.

0724 : SMS must contain visible characters.

HTTP Error code

400

Remedy

Ensure your message content contains non-whitespace characters.

0725 : MMS must have media file attachments.

HTTP Error code

400

Remedy

Specify at least one media file to send as an attachment.

0726 : SMS cannot have file attachments.

HTTP Error code

400

Remedy

Remove the msg_media or send as an MMS.

0727 : The message type requested is not currently supported on this number.

HTTP Error code

400

Remedy

Use a number that is enabled for the message type or contact support for assistance.

0728 : Your account must be configured to allow sending SMS.

HTTP Error code

400

Remedy

Please contact support to discuss your requirements.

0729 : You cannot send a message to the same number it originates from.

HTTP Error code

400

Remedy

Change the 'From' or 'To' number

0800 : A token must provide permission for at least one usage, but none were specified.

HTTP Error code

400

Remedy

Supply at least one permitted usage.

0801 : Developer accounts are limited to 1000 tokens per month for testing.

HTTP Error code

400

Remedy

Upgrade to a production account.

0802 : Convert job not found. Token is invalid, lapsed, or otherwise or otherwise unidentified. Please note that file convert job status is stored for a limited time only. Please refer to the documentation for more details.

HTTP Error code

404

Remedy

Try again using a valid token.

0900 : Your trial account period has expired.

HTTP Error code

400

Remedy

Upgrade to a production account, you can still access the Aculab Cloud Console. Or contact support for assistance.

0901 : Trial accounts are only able to purchase telephone numbers in the country where the account is registered.

HTTP Error code

400

Remedy

Purchase a number in your registered country, or upgrade to a production account.

0902 : Trial accounts are only able to purchase geographic and mobile numbers in the country where the account is registed.

HTTP Error code

400

Remedy

Purchase a geographic or mobile number, or upgrade to a production account.

0903 : Trial accounts are limited in the number of telephone numbers they can own and you have reached that limit.

HTTP Error code

400

Remedy

Upgrade to a production account to purchase more numbers.

0904 : Trial accounts are limited in the number of concurrent outbound services they can run.

HTTP Error code

429

Remedy

Upgrade to a production account.

1001 : An internal error has occured. The web service is still available, but this may indicate a fault with our server.

HTTP Error code

500

Remedy

Try the web service call again. If it continues to fail, please contact us about the problem.

1002 : The web service has been unable to communicate with it's backend server, meaning the operation cannot continue. This is usually a temporary error message.

HTTP Error code

503

Remedy

Try again in a few moments. If it continues, please contact us.

1003 : You are using this web service at too high a rate, meaning the operation you requested cannot continue. Please use it at a lower rate.

HTTP Error code

429

Remedy

Please retry at a lower rate. If it continues, please contact us.

1004 : The web service has been unable to communicate with it's backend server, meaning the operation cannot continue. This is usually a temporary error message.

HTTP Error code

502

Remedy

Try again in a few moments. If it continues, please contact us.

1005 : The web services are used at a too high a rate, meaning the operation you requested cannot continue. Please use it to finish processing.

HTTP Error code

429

Remedy

Please retry in a short period of time. If it continues, please contact us.

1006 : The account is using the web services at too high a rate, meaning the operation you requested cannot continue. Please use it at a lower rate.

HTTP Error code

429

Remedy

Please retry at a lower rate. If it continues, please contact us.

1007 : The outbound service is being used at a too high a rate, meaning the operation you requested cannot be handled. Please allow outstanding requests to finish processing.

HTTP Error code

429

Remedy

Please retry at a lower rate. If it continues, please contact us.

1100 : Unsupported or missing Content-Type header. Expected application/pdf.

HTTP Error code

415

Remedy

Change the Content-Type header of the request to application/pdf.

1101 : Could not find a PDF attached in the request body.

HTTP Error code

400

Remedy

Please include a PDF in the request body.

2001 : Your UAS connected to the Cloud, but failed to authenticate successfully. This is almost certainly because the Cloud, username and API Access Key supplied to the UAS doesn't match those of your account. Note that this can occur if you generate a new API Access Key on the Cloud Console - in that case, you need to re-enter your credentials in the UAS.

HTTP Error code

400

Remedy

Ensure the Cloud, username and API Access Key supplied to your UAS match those on your Cloud account.

2002 : Your UAS connected to the Cloud and authenticated successfully, but subsequent handshaking failed.

Remedy

Please contact us.

2004 : The Cloud wanted to start one of your applications, found a UAS which had it loaded, but the application failed to start.

Remedy

The error text will give a status value. If the status is -4, the application contains an error which prevented its main function being called - please check your application code. If status is -6, the application is written for one direction (e.g. inbound) but the servicve using it is the other direction (e.g. outbound) - ensure the application's direction matches that of all services which use it. If status is -7, the UAS was not accepting new application requests and another UAS will be tried - if this error occurs often, you need to increase your UAS capacity. If status is any other value, please contact us.

2005 : A REST application could not be started, due to invalid or missing data in either the service settings or application parameters.

Remedy

The REST logs will typically give more information on the nature of the problem. REST logs can be found at https://cloud.aculab.com/home/files?path=/&file_type=rest_logs.

2007 : An incoming call to the DDI noted in the text was hung up because, while it matches one of your inbound services, there was no UAS available that could run the application used by that service.

Remedy

If your UAS wasn't running or you'd asked it to stop accepting application requests, then this error shows that, as a result, a call couldn't be answered. If you didn't have the application loaded on your UAS, load the application. Otherwise, if this error occurs often, increase your UAS capacity.

2008 : The UAS or its application with the Application Instance Id and Application Parameters noted in the text started but, on completion, returned the failure code noted. Results from -1 to -99 are created by the UAS system, and -100 below are user created. For system specific Python UAS errors, see https://cloud.aculab.com/documents/api/python/latest/adr.html#adr-info. For .NET UAS system specific errors, see https://cloud.aculab.com/documents/api/dotnet/latest/UASCSharpWritingApplications.html under Application Rules.

Remedy

Check the your application code to see why it returned a negative value.

2009 : The REST application with the Application Instance Id and Application Parameters noted in the text started but, on completion, returned the failure code noted. Results from -1 to -104 are reserved for the REST system, and -105 below are user created.

Remedy

Check the your application code to see why it returned a negative value.

2011 : Your UAS connected with the Cloud and authenticated successfully, but subsequent handshaking failed due to a mismatch in its significant version number.

Remedy

Your UAS is very old. Please download the latest version from the web site or, if that's not possible, contact us.

2013 : An incoming call to the DDI noted in the text was hung up due to there being no credit on the account.

Remedy

Add sufficient credit - while logged in, click Account then Add funds.

2014 : A call with the DDI noted in the text was hung up due to there being no credit on the account.

Remedy

Add sufficient credit - while logged in, click Account then Add funds.

2016 : One or more running applications were stopped due to there being no credit on the account.

Remedy

Add sufficient credit - while logged in, click Account then Add funds.

2017 : One or more running applications were stopped due to the account being on administrative hold.

Remedy

Please contact us.

2018 : An incoming call to the DDI noted in the text was hung up due to the account being on administrative hold.

Remedy

Please contact us.

2019 : A call with the DDI noted in the text was hung up due to the account being on administrative hold.

Remedy

Please contact us.

2024 : An incoming call to the DDI noted in the text was hung up due to the developer account having exceeded their monthly usage limit.

Remedy

Please contact us.

2025 : A call with the DDI noted in the text was hung up due to the developer account having exceeded their monthly usage limit.

Remedy

Please contact us.

2026 : A call with the CLI noted in the text was hung up due to the numer not being on the account's whitelist.

Remedy

Please contact us.

2027 : A call with the DDI noted in the text was hung up due to the number not being on the account's allowed numbers list.

Remedy

Please contact us.

Error Responses

All web service API's can respond with JSON objects, however some legacy API's return XML/HTML error responses by default.

Api's will return JSON errors if a request contains the "Accept" header with a valid json content type, "application/json" or "text/json"

We strongly recommend the use of the "Accept: application/json" on all web service requests to ensure that all error responses are returned in a consistent format.

JSON Error Response

The JSON response object always contains the two parameters, error and request. These objects are further detailed below.

error

Parameter	Value	Availability	Description
code	string	always	Either an Error Code, or an HTTP status code
text	string	always	A text description of the error
details	string	optional	When multiple validation errors occur this contains a list of individual error descriptions. Only present if there are multiple errors
datetime	string	always	The timestamp for when the error occurred
link	string	always	A link to either the API documentation or documentation for a specific error code

request

Parameter	Value	Availability	Description
url	string	always	The url that was called
datetime	string	always	The timestamp for when the request was received

Examples:

Single HTTP status code

{
    "error": {
        "code": "HTTP 400",
        "text": "Bad Request: user_id 'Bob' is already present",
        "datetime": "2021-01-15_08:56:24",
        "link": "https://www.aculab.com/cloud/web-services/voice-biometrics/users?target=service_action_tabs&amp;tab-id=register"
    },
    "request": {
        "url": "/voice_biometrics/v1/user/register",
        "datetime": "2021-01-15_08:56:23"
    }
}

Single error code

{
    "error": {
        "code": "0405",
        "text": "Invalid token; token is either invalid, lapsed, or otherwise unidentified.",
        "datetime": "2022-12-12_11:32:41",
        "link": "https://www.aculab.com/cloud/web-services/web-service-errors?error=0405"
    },
    "request": {
        "datetime": "2022-12-12_11:32:41",
        "url": "/file_delete_progress"
    }
}

Multiple validation errors

{
    "error": {
        "code": "HTTP 400",
        "text": "Failed to validate configuration, see details for the specific failures.",
        "details": [
            "uas.application_name 16 is not of type 'null' or 'string'.",
            "rest.first_page.address 'woiern' is too short.",
            "rest.first_page.method 'haha' is not one of ['GET', 'POST'].",
            "service_password None is not of type 'string'. For UAS, you must provide an application_name and service_password.",
            "uas.application_name 16 is not of type 'string'. For UAS, you must provide an application_name and service_password.",
            "fax.send.enabled False was expected. You can only enable fax when extra_channels is set to zero."
        ],
        "datetime": "2021-01-15_08:56:24",
        "link": "https://www.aculab.com/cloud/web-services/services/outbound?target=service_action_tabs&tab-id=Create"
    },
    "request": {
        "url": "/service/v1/outbound/new_service_1",
        "datetime": "2021-01-15_08:56:23"
    }
}