Web Service Errors

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

Error	Description
`0001`	A mandatory parameter has not been specified. The missing parameter will be mentioned in the error string.
`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.
`0003`	Multiple versions of the same named parameter have been passed to the web service, where only one is required.
`0004`	The parameter type is numeric, but with a value of zero. This is not allowed.
`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.
`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.
`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.
`0008`	The server doesn't know the country with the specified DID type.
`0009`	The region is unknown to the server.
`0010`	The state is unknown to the server.
`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.
`0012`	The supplied regulation address does not exist under your account.
`0013`	Data within this call needs to be conducted over HTTPS as it contains personal information.
`0014`	The request method you have specified is not allowed.
`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.
`0016`	This operation requires a filename to be passed, which is missing.
`0017`	The filename supplied can't be found on the server.
`0018`	The server had a problem when accessing storage.
`0019`	The POST request to the server is empty.
`0020`	No content length has been supplied to the server.
`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.
`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/other-apis/web-services/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/other-apis/web-services/starting-outbound-services instead.
`0023`	A mandatory parameter has been specified, but its contents is empty.
`0024`	A parameter has been specified as a list, but one or more of its elements are empty.
`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.
`0026`	There must be at least a minute gap between conference manipulation requests.
`0027`	The API service to use is unknown to the server.
`0028`	States are only used by geographic numbers in limited countries. They are not required in national or toll-free numbers.
`0029`	A parameter has been specified which is not recognised by this API.
`0030`	The parameters specified are incompatible with one another.
`0031`	The specified parameter is required to be unique, but the supplied value already exists in the system.
`0032`	The HTTP request did not contain a Content-Type header or contained a Content-Type header that was invalid.
`0100`	You're using a Developer account, but need a Production or Premium account to perform this operation.
`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.
`0102`	The operation cannot be performed because it is forbidden. You've supplied an unknown based_on parameter.
`0103`	The username supplied is invalid.
`0104`	The application instance ID supplied does not exist.
`0105`	A request to interrupt a REST application has been received, but the application has already completed.
`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.
`0107`	Your account has not been enabled for access to VoiSentry. If you think this is incorrect, please contact support.
`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.
`0201`	did_type must be one of geographic, national, tollfree or mobile.
`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.
`0203`	Calls from phones of the supplied type to toll free numbers with the supplied country and region (prefix) are not allowed.
`0300`	The telephone number to delete does not belong to your account, so it cannot be deleted.
`0301`	The telephone number either does not exist, or does not belong to your account.
`0302`	The telephone number has not been found in the whitelist for 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.
`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.
`0403`	The from parameter is missing.
`0404`	The to parameter is missing.
`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.
`0406`	A valid MEDIA filetype has been supplied. However, MEDIA filetypes cannot operate with the requested function.
`0407`	A valid REST filetype has been supplied. However, REST filetypes cannot operate with the requested function.
`0408`	The supplied filetype must be one of the types given in the error message.
`0409`	The number of hours to live is greater than the maximum specified in the error message.
`0410`	The number of days to live is greater than the maximum specified in the error message.
`0411`	The number of minutes to live is greater than the maximum specified in the error message.
`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.
`0413`	You cannot specify a time to live for this filetype. Time to live can only be specified for MEDIA files.
`0414`	You cannot upload encrypted MSG_MEDIA files. You can only upload encrypted MEDIA files.
`0415`	The prefix paramater can not contain a / character.
`0500`	The supplied report type is unsupported. Valid report types are: 'adr', 'cdr', 'fdr', 'msg' and 'err'.
`0501`	The report file type is unsupported. Valid report file types are: csv and json.
`0503`	When generating a full report, a json report file type must be requested.
`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.
`0505`	The supplied from date and time must come before the to date and time.
`0506`	You've requested a report convering more days that the two month maximum allowed.
`0507`	You've already requested an identical report, which is still being generated.
`0508`	The from date is too far in the past, data is only stored for 6 months, including the current month.
`0509`	You currently have the maximum number of reports in progress. You must wait for existing reports to complete before you can start more.
`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.
`0600`	The supplied number of participants is invalid. It needs to be between a range as specified by the web service, inclusive.
`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.
`0602`	The supplied conference duration is invalid. It must be in minutes and in the range specified in the error text.
`0603`	A conference with this name is already reserved.
`0604`	The reservation_token is not valid.
`0605`	This conference can't be modified, as it's already been cancelled.
`0606`	The request would increase the total conference duration to above 480 minutes.
`0607`	This conference has already finished.
`0608`	This conference is due to start in less that five minutes, so it's too late to cancel it.
`0609`	The conference has already started, and you can't cancel a conference while it's running.
`0610`	This conference is due to finish in less than five minutes, so it's too late to extend its duration.
`0611`	The conference start time must be after the current time.
`0612`	You've tried to reserve a conference with more participants than are allowed on your account.
`0613`	No conference of that name is currently known to the system.
`0614`	No participant of that name is currently known to the system.
`0615`	The conference is not currently in the running state.
`0616`	Both the conference_name and reservation_token parameters have been supplied rather than just one or the other.
`0617`	At least one of the participant options must be specified.
`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.
`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.
`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.
`0703`	The content can't be encoded into a form we can send to the carrier, so your message could not be sent.
`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.
`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.
`0706`	The type is unhandled, so your message could not be sent. Please check to documentation to see which types are supported.
`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.
`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.
`0709`	Either "to" or "from" is missing. One or the other parameter must be supplied.
`0710`	Either the 'to' or "from" field must be presented. You cannot present both.
`0711`	This would exceed the maximum number of messages for this phone number in the message queue, so the message could not be sent.
`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.
`0713`	Your account must be configured to use flash SMS. Please contact support.
`0714`	Your account must be configured to use alphanumeric sender IDs. Please contact support.
`0718`	Your account must be configured to allow sending SMS to US telephone numbers.
`0719`	Messages of the type requested do not support using the named parameter.
`0720`	Messages of the type requested require the use of the named parameter.
`0721`	There was a problem with at least one message media file.
`0722`	US SMS requires a campaign registration ID recorded against all numbers used for sending A2P SMS messages.
`0723`	This 'from' number has a campaign registration ID, but the campaign registration has expired.
`0724`	SMS must contain visible characters.
`0725`	MMS must have media file attachments.
`0726`	SMS cannot have file attachments.
`0727`	The message type requested is not currently supported on this number.
`0728`	Your account must be configured to allow sending SMS.
`0800`	A token must provide permission for at least one usage, but none were specified.
`0801`	Developer accounts are limited to 1000 tokens per month for testing.
`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.
`0900`	Your trial account period has expired.
`0901`	Trial accounts are only able to purchase telephone numbers in the country where the account is registered.
`0902`	Trial accounts are only able to purchase geographic and mobile numbers in the country where the account is registed.
`0903`	Trial accounts are limited in the number of telephone numbers they can own and you have reached that limit.
`0904`	Trial accounts are limited in the number of concurrent outbound services they can run.
`1001`	An internal error has occured. The web service is still available, but this may indicate a fault with our server.
`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.
`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.
`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.
`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.
`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.
`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.
`1100`	Unsupported or missing Content-Type header. Expected application/pdf.
`1101`	Could not find a PDF attached 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.
`2002`	Your UAS connected to the Cloud and authenticated successfully, but subsequent handshaking failed.
`2004`	The Cloud wanted to start one of your applications, found a UAS which had it loaded, but the application failed to start.
`2005`	A REST application could not be started, due to invalid or missing data in either the service settings or application parameters.
`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.
`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.
`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.
`2011`	Your UAS connected with the Cloud and authenticated successfully, but subsequent handshaking failed due to a mismatch in its significant version number.
`2013`	An incoming call to the DDI noted in the text was hung up due to there being no credit on the account.
`2014`	A call with the DDI noted in the text was hung up due to there being no credit on the account.
`2016`	One or more running applications were stopped due to there being no credit on the account.
`2017`	One or more running applications were stopped due to the account being on administrative hold.
`2018`	An incoming call to the DDI noted in the text was hung up due to the account being on administrative hold.
`2019`	A call with the DDI noted in the text was hung up due to due to the account being on administrative hold.

Error Responses

All web service API's can response 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 error

{
    "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&tab-id=register"
	},
	"request": {
		"url": "/voice_biometrics/v1/user/register",
		"datetime": "2021-01-15_08:56:23"
	}
}

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"
	}
}

Cloud documentation

Web Service Errors

Error Codes

Error Responses

JSON Error Response

Examples:

Contact Aculab