# Error Codes
This page gives a complete reference for all supported error codes returned from Web Services API operations.
# General Error Codes
Error Code | Error Message | Possible Resolution |
---|---|---|
10000 | An unknown error was encountered when performing the request. | If this error occurs, report it to your Akixi Service Application Administrator or Provider. |
10001 | Web Services API has not been enabled to complete the request. | The Web Services API is not actually enabled on the Akixi Service where the corresponding API request has been made to. Contact your Akixi Service Application Provider to enable the WS API. |
10101 | Invoke ID is not specified within the request. | The InvokeID parameter cannot be empty. Please specify it within the request. |
10102 | Operation is either not specified within the request or the specified operation is not supported. | The Operation attribute must specify a valid supported request type. |
10103 | The requested operation failed because an internal application resource cannot be resolved. To resolve the problem, please report this issue to your application administrator or provider. | This error might be displayed if a required Akixi server-side application resource has not been resolved. If this error reoccurs, please report it to your Akixi Service Administrator or Provider. |
10104 | Cannot perform the requested operation because the application's database data is currently unavailable, probably because maintenance is currently being performed on the application, although this might be indicating a more serious server-side problem. Please try the requested operation again in a few minutes’ time. If the problem persists, please report this error to your application provider. | If this error occurs, report it to your Akixi Service application administrator or provider. |
10105 | Either maintenance is currently being performed on the application or the application's database data is being backed-up. Please try the requested operation again later. | If this error occurs, report it to your Akixi Service application administrator or provider. |
10106 | The application is currently very busy processing user requests. Please try the requested operation again later. | If this error occurs, report it to your Akixi Service application administrator or provider. |
10150 | Unable to set/change the specified password value(s). A server-side error was encountered, please refer this problem to the application administrator or your application provider. | If this error occurs, report it to your Akixi Service application administrator or provider. |
10161 | Entity 'EntityID' already exists. | An existing Akixi Service configuration entry already exists. Please create the new entity with a unique identifier. |
10162 | Entity 'EntityID' not found. | Please provide an identifier of an existing Akixi Service configuration entry. |
10163 | Can't update or delete an inbuilt entity. | You will not be able to modify the inbuilt entity that you have specified on the request. Certain Akixi Service configuration items cannot be updated and/or deleted such as the common devices Partition. Refer to section “The Common Devices Partition” in order to learn more about the common devices Partition. |
10170 | The implicit default system-wide administration user cannot be deleted. | The default system-wide administrative User cannot be deleted via the Web Services API. Please ensure that you are deleting the correct/appropriate account. |
10201 | The specified time zone is either invalid or not supported. | Please provide a correct TimeZone Property value. The list of supported time zone values are shown under sub-heading “TimeZone” within the “Web Services Properties” chapter. |
10210 | Email message definition not found to welcome a new user. | The message text template for sending Welcome e-mail messages to an Akixi Service account User was not found or is not available. If this error reoccurs, please report it to your Akixi Service Administrator or Provider. |
# Session Related Error Codes
Error Code | Error Message | Possible Resolution |
---|---|---|
10301 | Session ID is not specified within the request. | Session Identifier cannot be empty. Please specify it within the request. |
10302 | Unable to validate the session with the specified session ID. The session would have been either expired or the session ID specified is incorrect. | Provide a valid Session Identifier value that is not expired. |
# Authentication Related Error Codes
Error Code | Error Message | Possible Resolution |
---|---|---|
10303 | An empty username was specified, please try again with the correct authentication details. | A username parameter cannot be empty. Please specify it within the request. |
10304 | Cannot sign in again because a user is already logged on. Please create a new session before attempting to log a different user in. | You can’t sign in twice using the same Session Identifier (even if the designated Akixi Application User account supports concurrent authentication from multiple clients via its ConcurrentSignIns Property being set to True). Please create a new session in order to authenticate the User. |
10305 | The resource you attempted to access requires you to be logged in with a valid user. Either you have not logged in yet, or your session was inactive for too long after a previous successful log in, or you have logged in with the same user name on another browser session. Alternatively, you were automatically logged out because you signed-in again using the same user name on another session. | The submitted request requires a User to be authenticated first. Note that authenticated API sessions are automatically signed out when they remain inactive for too long - The session inactivity interval is documented under the section below. |
10306 | The specified username or password is incorrect, please try again with the correct authentication details. | The specified username or password is incorrect. If you believe the authentication details are right, try performing the following: 1. First verify that all values used when programmatically creating the multi-digest hash are correct and use the appropriate character case, encoding rules, and digest/conversion algorithms. Refer to sub-heading “Multi-Digest Password Hash Generation” to learn more about the WS API authentication process. 2. Try signing in manually via Web browser. If you are able to sign in via a browser, but your Web Services Client fails to authenticate due to incorrect credentials, it usually means that your implementation of the multi-digest hash generation procedure does not fully replicate the routine described in this documentation under the sub-heading “Multi-Digest Password Hash Generation”. Please note that whenever an authentication attempt fails, the API session is automatically cleared including the session’s corresponding Nonce value. This is done in order to mitigate against a brute force attack performed using incremental multi- digest password values based on the same underlying Nonce. Therefore, when attempting to perform authentication again, client applications must create a new API session via the CreateSession request. |
10307 | The current user has been locked out, please refer to the application administrator or your application provider. | The corresponding Web Services API request failed because the Akixi Application User account originally utilised to authenticate the current WS API session has been newly locked out by another administrative session, either using the WS API or via the Akixi Service web portal. Contact your Akixi Service Administrator or Application Provider in order to unlock your account. |
10308 | The specified user is temporarily locked out because you have attempted to sign into the application with an invalid password too many times. Please try again later with the correct password. | The corresponding Application User has just temporarily been locked out because the associated Authenticate request failed due to invalid credentials being provided, and the invalid password attempt threshold for temporary lockout has now been reached for that particular User account. You will be able to re-attempt the authentication request when your temporary lockout threshold subsequently expires. Refer the section “Brute Force Attack Prevention” for guidance on the estimated lock-out thresholds. |
10309 | The user authenticated in the specified session has been permanently locked out. Please refer to the application administrator or your application provider. | This error is specifically generated for failed Authenticate requests when the corresponding Application User has already been locked out. This can occur either because a previous Authenticate request failed due to invalid credentials being provided where the maximum allowable number of invalid password attempts was reached, or where the corresponding User has been deliberately locked out by another administrative session (either using the WS API or via the Akixi Service web portal). Contact your Akixi Service Administrator or Provider in order to unlock your account. |
10310 | Your user account has now been permanently locked out because you have attempted to sign into the application with an invalid password too many times. Please refer to the application administrator or your application provider. | This error is specifically generated when the corresponding Application User has just newly been locked out because the associated Authenticate request failed due to invalid credentials being provided, and the maximum allowable number of invalid password attempts has already been reached for that particular User account. Contact your Akixi Service Administrator or Provider in order to unlock your account. |
10311 | Cannot sign in because either maintenance is currently being performed on the application or the application's database data is being backed-up. Please try the requested operation again later. | If this error reoccurs, please report it to your Akixi Service Administrator or Provider. |
10312 | Cannot sign in because the application is currently very busy processing user requests. Please try the requested operation again later. | If this error reoccurs, please report it to your application administrator or provider. |
10313 | The operation you attempted to perform requires you to reauthenticate. Either your administrative permissions have expired, or you were inactive within the administrative area of the application for too long. | The submitted request requires a User to reauthenticate by creating a new session and sending a new authentication request. Users need to reauthenticate when the length of their current authenticated API session reaches a maximum duration. This is to automatically expire access to administrative areas of the Akixi server-side when using a particular session identifier, for the purposes of improving server-side application security. The maximum authenticated session duration is documented under the corresponding section. |
# Permissions Related Error Codes
Error Code | Error Message | Possible Resolution |
---|---|---|
10511 | The currently logged in user has no administration privileges. | Ensure that you specify the request through an authenticated User account with administrative privileges. |
10512 | The currently logged in user has no privileges on the telephony server specified on the request or that the entity in request is associated with. | Ensure that you specify the request via an authenticated User account that has privileges on the specified Telephony Server component or on the Telephony Server component that the entity specified in the corresponding request is associated with. |
10513 | The currently logged in user requires privileges on all telephone server entries. | Ensure that you specify the request through an authenticated User account that has privileges on all Akixi Telephony Server entries. |
10514 | The currently logged in user has no privileges on the partition specified on the request or that the entity in request is associated with. | Ensure that you specify the request via an authenticated User account that has privileges on the specified Partition component or on the Partition component that the entity specified in the corresponding request is associated with. |
10515 | The currently logged in user requires privileges on all partitions. | Ensure that you specify the request through an authenticated User account that has privileges on all Akixi Partition entries within the designated Telephony Server component. |
10516 | The currently logged in user has no privileges on the device specified on the request or that the entity in request is associated with. | Ensure that you specify the request through an authenticated User account that has privileges on the specified Akixi Device configuration entry or on the Device entry that the entity specified in request is associated with. |
10517 | The currently logged in user requires privileges on all devices. | Ensure that you specify the request via an authenticated User account that has privileges on all Akixi Device configuration entries within the specified Partition. |
10518 | The currently logged in user has no privileges on the ACD agent specified on the request or that the entity in request is associated with. | Ensure that you specify the request through an authenticated User account that has privileges on the specified Akixi ACD Agent configuration entry or on the ACD Agent entry that the entity specified in request is associated with. |
10519 | The currently logged in user requires privileges on all ACD agents. | Ensure that you specify the request via an authenticated User account that has privileges on all Akixi ACD Agent configuration entries within the specified Partition. |
10700 | The currently logged in user does not have enough permissions to perform the requested operation. | Make sure if you have valid permission which are related to the requested component. |
10701 | The requested operation might not have valid permissions configured. | Contact your administrator, its possible that the request operation is not configured with right permissions within application. |
10702 | The empty command or operation. | Most probably user forgot to mention the WS operation or it is unrecognised by system. |
# Telephony Server Component Related Error Codes
Error Code | Error Message | Possible Resolution |
---|---|---|
11010 | Invalid or no telephony server type specified. | Specify a correct telephony platform type value. Refer to the TelSysType Property for more information on the supported values. |
11011 | The telephone system identifier value was invalid or out of the allowable range. | Specify a correct Telephony Server identifier value. The value is always a positive integer number. Refer to the TelSysID Property for further information. |
11012 | The telephone system identifier value was not specified or invalid. | Specify a correct Telephony Server identifier value. The value is always a positive integer number. Refer to the TelSysID Property for further information. |
11013 | The telephone system with identifier 'Identifier' not found. | An existing Akixi Telephony Server configuration component could not be found matching the TelSysID Property value given with the corresponding API request. Specify a component identifier value that represents an existing Akixi Telephony Server configuration entry. |
11014 | The telephone system with identifier 'Identifier' already exists. | Specify a unique identifier value for the new Telephony Server component. The value is always a positive integer number and is automatically assigned for newly added Telephony Server entries if the TelSysID Property is left empty. |
11020 | Unable to delete telephone system entry 'Identifier' because it is still configured to be "in service". | Only inactive Telephony Server components can be deleted. Therefore, you must ensure that the CommsEnabled Property of the designated Telephony Server entry is set to False by invoking a TelSysChange operation first. |
11021 | The telephony server type is not allowed by the CME. | The enclosing CME does not allow this type of Telephony Server to be created. Select a different type, or change the restriction in the CME. |
11022 | The telephony server can't be created as it would exceed the maximum count set in the CME. | The enclosing CME imposes a limit on the number of Telephony Servers that can be created within it. Remove obsolete Telephony Servers, if there are any, or change the restriction in the CME. |
# Partition Related Error Codes
Error Code | Error Message | Possible Resolution |
---|---|---|
11110 | The partition with identifier 'Identifier' not found. | Specify a correct Partition identifier value (see the PartitionGUID Property). The value is usually a long text value containing around 40 characters of content length. |
11111 | The partition with identifier 'Identifier' already exists. | This error occurs if the specified PartitionGUID Property value is deliberately specified and a Partition with the same GUID identifier already exists attached to any other Telephony Server component within the Akixi Service. Note that Partition identifier values are automatically generated by the Akixi server-side logic if not specified within PartitionAdd requests. The recommended practice is to only specify this parameter if you have been specifically asked to do so by your Application Provider, when reconstructing an Akixi Service configuration for previously erroneously deleted elements. |
11112 | The partition with identifier 'Identifier' already exists against the same telephone system. | The PartIDInTelSys Property value that is specified in the request is already assigned to a different Partition within the owning Telephony Server component. Specify a new value that is not assigned to any other existing Partition. Note that Partition identifier values are automatically generated by the Akixi server-side logic if not specified within PartitionAdd requests. |
11113 | The partition identifier value within telephone system was invalid or out of the allowable range. | Specify a correct PartIDInTelSys Property value. The value is always a positive integer number. |
11114 | The maximum number of ‘n’ allowed partitions entries has already been reached for the specified Telephony Server. | You cannot add further Partition entries when the maximum number of allowed Partitions has already been reached for the designated Telephony Server component, as defined by its PartitionCountMax setting within the TelSysAdd & TelSysChange requests. When this occurs, you should create a brand-new Telephony Server component entry to add Partitions to. |
11115 | The telephone system component type has not been specified or is invalid. | Specify a correct telephony platform component type mapping within the TelSysComponentType Property. |
11120 | IDOnTelSysOwner value not specified which is mandatory for BroadWorks telephone platform and the field corresponds to an Enterprise ID or a Service Provider ID. | Provide an appropriate IDOnTelSysOwner value, which is required for Cisco BroadWorks telephony platform environments. The value should be set to the identifier of the BroadWorks Enterprise or Service Provider component that the associated Customer telephony environment is configured within the telephony platform itself. Note that the Enterprise or Service Provider identifier should be entered in without the domain name (i.e. unqualified). |
11121 | IDOnTelSys value not specified which is mandatory for BroadWorks telephone platform for "Enterprise Group"/"Service Provider Group" component types. The field corresponds to "Group ID" within BroadWorks telephone platform. | Provide an appropriate IDOnTelSys Property value, which is required for Cisco BroadWorks telephony platform environments when the TelSysComponentType Property is set with the values “BroadWorks Enterprise Group” or “BroadWorks ServiceProvider Group”. The value corresponds to the identifier of BroadWorks Enterprise Group component or Service Provider Group component (respectively) within the underlying telephony platform configuration. |
11122 | There is already an existing partition with an 'IDOnTelSysOwner' field value of 'Value'. This field should match the identifier of the telephone system configuration entity that owns the corresponding partition within the physical telephony platform's configuration. | The same IDOnTelSysOwner Property value is already specified for another Partition within the owning Akixi Telephony Server component. Provide a value that is not specified against any other Partition. |
11123 | There is already an existing partition with an 'IDOnTelSys' field value of 'Value'. This field should match the identifier of the partition within the actual configuration of the physical Telephony Server component but can be empty for some telephony server types. | The same IDOnTelSys Property value is already specified for another Partition within the owning Akixi Telephony Server component. Provide a value that is not specified against any other Partition. |
11124 | There is already an existing partition with an existing 'NameOnTelSys' field value of 'Value'. This field should match the name of the partition within the actual configuration of the physical Telephony Server component but can be empty for some telephony server types. | The same NameOnTelSys Property value is already specified for another Partition within the owning Akixi Telephony Server component. Provide a value that is not specified against any other Partition. |
11130 | Either a valid PartitionGUID value or a valid combination of TelSysID and PartIDInTelSys values must be specified in order to identify a partition. | To identify a Partition, either specify its PartitionGUID value alone, or both Partition’s TelSysID & PartIDInTelSys Properties together. |
11131 | The partition with identifier 'Identifier' not found within the specified telephone system. | Specify a Partition number in the PartIDInTelSys Property that represents an existing entry within the Telephony Server component specifically identified by the TelSysID Property. |
11140 | Unable to delete the specified partition because it is still configured to be "in service". | Only inactive Partitions can be deleted. Therefore, you must ensure that the CommsEnabled parameter of the designated Partition component is set to False by invoking a PartitionChange operation first. |
11141 | Supervisor Permission Synchronisation is not supported by this partition or provided partition config. | The telephony server type or the partition type does not support this property to be set. If you are not providing it in request, try providing a "false" value. |
11142 | Partition license does not support Supervisor Permission Synchronisation. | The partition license level does not allow Supervisor Permissions Synchronisation to be enabled. If you are not providing sypervisor permission sync flag in request, try providing a "false" value. |
11143 | The CME does not allow the partition to be given this license type. | The enclosing CME restricts the types of partition that can be created. Select a different license type, or change the restriction in the CME. |
11144 | Partition license not supported for WebEx TelSys. | The partition license level supported by WebEx TelSys is "Akixi Enterprise" only. |
11150 | A valid TelSysID and PartIDInTelSys must be specified. | Specify both a valid Partition number via the PartIDInTelSys Property as well as its owning Telephony Server component within the TelSysID Property. |
# Device Related Error Codes
Error Code | Error Message | Possible Resolution |
---|---|---|
11160 | A valid TelSysID, PartIDInTelSys along with DeviceNumber or IDOnTelSys (only on applicable telephone system type) must be specified to identify a device. | Specify either a valid combination of TelSysID, PartIDInTelSys and DeviceNumber values together, or alternatively a valid set of TelSysID, PartIDInTelSys and IDOnTelSys values. The latter is applicable only for telephony platform types that support the IDOnTelSys value (see sections “Device Request Parameters” & “DeviceChange Request” for more information on what telephony platform types support retrieving Akixi Device configuration entries by their IDOnTelSys Property). |
11161 | The device with number 'DeviceNumber'notfoundwithin the specified partition. | Specify the DeviceNumber Property value of an existing Device configuration entry within the corresponding Akixi Partition. |
11162 | The device with number '|1' already exists. | The device number value (specified via the DeviceNumber Property) must be unique within the owning Partition component. |
11163 | The device number value was invalid or is not specified. | Specify a device number value which is not empty. |
11164 | A valid device number or IDOnTelSys value must be specified to identify a device. | Specify a valid non-empty DeviceNumber or IDOnTelSys value. The latter is applicable only on the telephony platform types that support the IDOnTelSys value (see sections “Device Request Parameters” & “DeviceChange Request” for more information on what telephony platform types support retrieving Akixi Device configuration entries by their IDOnTelSys Property). |
11165 | Unable to add some of the specified member device(s) 'Member Devices' which could generally be due to either the device not found or the currently logged in user doesn't have permission over device member(s). | One or more of the specified Devices given within the DeviceMembers Property do not exist within the Akixi Device configuration of the corresponding Partition. Alternatively, the Akixi Application User account originally utilised to authenticate the current Web Services API session, no longer has permissions over one of more of the designated member Devices specified. |
11166 | Unable to add some of the specified member ACD agent(s) 'Member Agents' which could generally be due to either the agent not found or the currently logged in user doesn't have permission over ACD agent member(s). | One or more of the specified ACD Agents given within the ACDAgentMembers Property do not exist within the Akixi ACD Agent configuration of the corresponding Partition. Alternatively, the Akixi Application User account originally utilised to authenticate the current Web Services API session, no longer has permissions over one of more of the designated member agents specified. |
11167 | Unable to add some of the specified member device(s) ' | 1' and ACD agent(s) ' |
11168 | A device specified in a DNIS association is not found or is not a DNIS Entry device type, or you don't have permission to access it. | Use the ID of an accessible DNIS entry device. |
11169 | A group specified in a DNIS association is not found or is not an ACD Group, or you do not have permission to access it. | Use the ID of an accessible ACD Group. |
11170 | The device with IDOnTelSys 'Identifier'notfoundwithinthe specified partition. | Specify the correct IDOnTelSys value of an existing Device configuration entry within the corresponding Akixi Partition. |
11171 | The device with IDOnTelSys 'Identifier' already exists. | The IDOnTelSys value must be unique within the owning Partition. |
11172 | The IDOnTelSys 'Identifier' matches multiple devices within the specified partition, so it cannot be used to uniquely identify a device. Please instead use the DeviceNumber field in order to specify the intended device. | Use the DeviceNumber field to specify the intended Device configuration entry within the corresponding Akixi Partition. |
11173 | The chat omnichannel integration entry ID specified does not match any omnichannel integration entry. | Use the ChatIntegrationEntry field to specify the intended chat integration entry. When the device’s owning telephony server supports omnichannel functionality inbuilt into the telephone platform itself (currently applies only to demonstration simulator type telephony servers), then the chat integration should be specified using the name of the chat integration type as seen within the Admin Portal, e.g. “Chat Simulator”, etc. For all other telephony server types, the omnichannel integration entry must be specified using its GUID, as visible when modifying the integration entry within the Admin Portal. |
11174 | The e-mail omnichannel integration entry ID specified does not match any omnichannel integration entry. | Use the EmailIntegrationEntry field to specify the intended e-mail integration entry. When the device’s owning telephony server supports omnichannel functionality inbuilt into the telephone platform itself (currently applies only to demonstration simulator type telephony servers), then the e- mail integration should be specified using the name of the e- mail integration type as seen within the Admin Portal, e.g. “E- mail Simulator”, etc. For all other telephony server types, the omnichannel integration entry must be specified using its GUID, as visible when modifying the integration entry within the Admin Portal. |
11175 | The chat omnichannel integration entry specified does not have a suitable telephony server and/or partition component assignment. | Specify a chat omnichannel integration entry that is in scope for this device. |
11176 | The e-mail omnichannel integration entry specified does not have a suitable telephony server and/or partition component assignment. | Specify an e-mail omnichannel integration entry that is in scope for this device. |
11177 | The type of the chat omnichannel integration entry specified is not supported by the telephony server. | Specify a chat omnichannel integration entry whose type is compatible with the device’s telephony server. |
11178 | The type of the e-mail omnichannel integration entry specified is not supported by the telephony server. | Specify an e-mail omnichannel integration entry whose type is compatible with the device’s telephony server. |
11179 | A device specified in a DNIS association is already associated with a different ACD Group. | Change the association by updating the DNIS device, or remove it from the other group before making this update. |
11260 | There is already a device with IDOnChatSys 'Identifier' associated with the chat omnichannel integration entry. | Specify a different IDOnChatSys value that is not already configured against a device attached to the same chat omnichannel integration entry. |
11261 | There is already a device with EmailSysUserID 'Identifier' associated with the e-mail omnichannel integration entry. | Specify a different EmailSysUserID value that is not already configured against a device attached to the same e-mail omnichannel integration entry. |
11262 | There is already a device with EmailSysEmailAddress 'Identifier' associated with the e-mail omnichannel integration entry. | Specify a different EmailSysEmailAddress value that is not already configured against a device attached to the same e- mail omnichannel integration entry. |
11263 | There is already a device with IDOnEmailSys 'Identifier' associated with the e-mail omnichannel integration entry. | Specify a different IDOnEmailSys value that is not already configured against a device attached to the same e-mail omnichannel integration entry. |
# ACD Agent Related Error Codes
Error Code | Error Message | Possible Resolution |
---|---|---|
11180 | A valid TelSysID, PartIDInTelSys along with AgentNumber or IDOnTelSys (only on applicable telephone system type) must be specified to identify an agent. | Specify a valid combination of TelSysID, PartIDInTelSys and AgentNumber values, or alternatively a valid set of valid TelSysID, PartIDInTelSys and IDOnTelSys values. The latter is applicable only for telephony platform types that support the IDOnTelSys value (see sections “ACD Agent Request Parameters” & “ACDAgentChange Request” for more information on what telephony platform types support retrieving Akixi ACD Agent configuration entries by their IDOnTelSys Property). |
11181 | The agent with identifier 'Identifier' not found within the specified partition. | Specify the AgentNumber of an existing ACD agent configuration entry within the corresponding Akixi Partition. |
11182 | The ACD agent with number 'Agent Number' already exists. | The ACD agent number (specified via the AgentNumber Property) must be unique within the owning Partition component. |
11183 | The ACD agent number value was invalid or is not specified. | Specify a valid non-empty AgentNumber value. |
11184 | A valid ACD agent number or IDOnTelSys value must be specified to identify an agent. | Specify a valid non-empty AgentNumber or IDOnTelSys value. The latter is applicable only on the telephony platform types that support the IDOnTelSys value (see sections “ACD Agent Request Parameters” & “ACDAgentChange Request” for more information on what telephony platform types support retrieving Akixi ACD Agent configuration entries by their IDOnTelSys Property). |
11190 | The agent with IDOnTelSys 'Identifier' not found within the specified partition. | Specify the correct IDOnTelSys value of an existing ACD Agent configuration entry within the corresponding Akixi Partition. |
11191 | The agent with IDOnTelSys 'Identifier' already exists. | The IDOnTelSys value must be unique within the owning Partition. |
11192 | The IDOnTelSys ‘Identifier’ matches multiple ACD agents within the specified partition, so it cannot be used to uniquely identify an agent. Please instead use the AgentNumber field in order to specify the intended ACD agent. | Use the AgentNumber field to specify the intended ACD Agent configuration entry within the corresponding Akixi Partition. |
# User Related Error Codes
Error Code | Error Message | Possible Resolution |
---|---|---|
11200 | A valid Username must be specified within the request. | Please provide a correct value via the Username Property. Note that Akixi Application User name values are case-sensitive. |
11201 | The user with username 'Username' not found. | Please provide a correct value via the Username Property. Note that Akixi Application User name values are case-sensitive. |
11210 | The password cannot be empty - you must enter in a password value that is at least X characters in length. | Specify a non-empty password value that is at least the specified minimum characters in length. Note that password values must be encrypted using the scheme specified under section “Password Property Values”. |
11211 | The specified password value must be at least X characters in length. | Specify a non-empty password that is at least the specified minimum characters in length. Note that password values must be encrypted using the scheme specified under section “Password Property Values”. |
11212 | The strength of the newly specified password value is too weak. Please increase the complexity of the password by using a combination of mixed cases, numbers, and preferably at least one symbol character. Also try to avoid the use of repeat characters throughout. | Specify a password value that is more complex with the combination of mixed cases, numbers and at least one symbol. Note that password values must be encrypted using the scheme specified under section “Password Property Values”. |
11213 | New password must be specified to give user administrative privileges. | Specify a new password value when changing the User from non-administrative User to an administrative User. Note that password values must be encrypted using the scheme specified under section “Password Property Values”. |
11215 | A valid non-empty TelSysID must be specified within the Permissions container. | Specify a TelSysID – Permissions Container Property with either the value of “All”, or a NonNegativeInteger value which corresponds to an existing Telephony Server component entry. |
11216 | A valid non-empty PartIDInTelSys must be specified within Permissions the container. | Specify a PartIDInTelSys – Permissions Container Property with either the value of “All”, or a NonNegativeInteger value that corresponds to an existing Partition component entry within the Telephony Server component specifically indicated via the provided TelSysID – Permissions Container Property value. |
11217 | The user must have Akixi 2000 or higher reporting access for enhanced mobile reporting features to be enabled. | Either specify an EnhancedMobileReporting Property with the value of False, or specify a ReportingAccess value of "Akixi 2000" or higher. |
11220 | The user has no privileges on the telephony server ‘Identifier’ that is specified on endpoint config. | Specify the endpoint Telephony Server Property (TelSysID – Endpoint Container) to be within the scope privileges assigned on the corresponding Application User. |
11221 | The user has no privileges on the partition that is specified on endpoint config. | Specify the Partition Property (PartIDInTelSys – Endpoint Container) for the corresponding User’s endpoint location to be within the scope privileges assigned on the same User. |
11222 | The user has no privileges on the device that is specified on endpoint config. | Specify the device Property (DeviceNumber – Endpoint Container) for the corresponding User’s endpoint location to be within the scope privileges assigned on the same User. |
11223 | The user has no privileges on the ACD agent that is specified on endpoint config. | Specify the endpoint ACD agent Property (AgentNumber – Endpoint Container) for the corresponding User’s endpoint location to be within the scope privileges assigned on the same User. |
11230 | Unable to send welcome e-mail message to the specified user (‘Error Message’). | If this error occurs, report it to your Akixi Service Administrator or Application Provider. |
11231 | Unable to resolve the default language configured against the corresponding application user. | If this error occurs, report it to your Akixi Service Administrator or Application Provider. |
11232 | You can only send a welcome message to users that you have just set a new temporary password for. | You must set a new Password Property value and also set the PasswordChgRequired Property to True when choosing to automatically send a Welcome e-mail message to the corresponding User. Note that password values must be encrypted using the scheme specified under section “Password Property Values”. |
11233 | You can only send a welcome message to users that are currently configured to change their account password on the next sign in. | You need to also set the PasswordChgRequired Property to True when sending a Welcome e-mail message. |
11234 | You can only send a welcome message to users that are configured with a non-empty 'EmailAddr' field value. | Configure the EmailAddr Property with a valid e-mail address in order to send a Welcome e-mail message. |
11235 | The value configured against the target user's'EmailAddr'field doesn't contain a valid e-mail address. | Configure the EmailAddr field with a valid e-mail address conforming to RFC-822, in order to send a Welcome e-mail message. |
11240 | A valid non-empty TelSysID must be specified within the Endpoint container when the device’s OmniChannelACDAgent property is set to True. | Use the endpoint telephony server field (TelSysID – Endpoint Container) to specify the telephone server of the intended omnichannel ACD agent. |
11241 | A valid non-empty PartIDInTelSys must be specified within the Endpoint container when the device’s OmniChannelACDAgent property is set to True. | Use the endpoint partition field (PartIDInTelSys – Endpoint Container) to specify the partition of the intended omnichannel ACD agent. |
11242 | A valid non-empty AgentNumber must be specified within the Endpoint container when the device’s OmniChannelACDAgent property is set to True. | Use the endpoint ACD agent field (AgentNumber – Endpoint Container) to specify the intended omnichannel ACD agent. |
11243 | An omnichannel ACD agent must be specified within the Endpoint container when the device’s OmniChannelACDAgent property is set to True. | Use the endpoint ACD agent field (AgentNumber – Endpoint Container) to specify the intended omnichannel ACD agent. |
11258 | Invalid permissions found for specified CME access: 'CME Identifier'. | Unselect permissions that require root CME access, or change the user's CME access to the root CME. |
11259 | The user type (reporting access) provided in the request is not allowed by the CME. | The enclosing CME restricts the type of reporting access that can be assigned to users within it. Select a different type, or change the restriction in the CME. |
11280 | The specified Telephone Server in endpoint could not be found. | A valid telephony server has to be configured for Endpoint Telephony Server value. |
11286 | Synchronise Supervisor Permissions requires single partition to be selected for user permissions. | Single partition has to be selected for user to use this feature. |
11287 | Synchronise Supervisor Permissions requires valid endpoint device or agent to be selected. | Endpoint device or agent has to be provided and they must exist. |
11288 | No matching supervisor configuration was found for the selected endpoint. Please check whether the assigned endpoint has supervisor settings in BroadWorks and retry again later. | Related Supervisor super group device was not found. Try the action after partition synchronisation and make sure the selected user (device / agent) is a supervisor within your telephony server. |
11289 | Supervisor Super Group Device permissions can only be set up with matching endpoint device or agent setup. | Set matching endpoint device or agent or change the device permissions to not use supervisor super group. |
10703 | Invalid permission value. | One of the provided user permission value within Permissions container is invalid. Please refer to the section Configuration Specific Properties > Application User Properties > Permissions Container Properties or click here to find right values. |
10704 | User does not have authorisation to assign these permissions. | To assign any of the permissions, current user should himself have that permission. |
# Code Entry Related Error Codes
Error Code | Error Message | Possible Resolution |
---|---|---|
11300 | A valid Code must be specified within the request. | Specify a non-empty code value for the Code Property. |
11301 | The code 'Code' of type 'Code Type' is not found within the scope of telephone system 'Identifier' and partition 'Identifier'. | An Akixi Code configuration entry was not found with the exact matching Code & CodeType Properties within the assignment scope of the designated Telephony Server and/or Partition, as also indicated within the TelSysID & PartIDInTelSys Properties (respectively). |
11302 | The code with identifier 'Code' already exists. | An existing Code configuration entry is already present with the exact matching Code & CodeType Properties within the assignment scope of the designated Telephony Server and/or Partition, as also indicated within the TelSysID & PartIDInTelSys Properties (respectively). |
# Billing Report Related Error Codes
Error Code | Error Message | Possible Resolution |
---|---|---|
11500 | A valid billing report type must be specified within the request. | Specify a valid BillingReportType (note that these values are case sensitive). Valid billing report types include: Summary, CDRs. |
# Omnichannel Integration Related Error Codes
Error Code | Error Message | Possible Resolution |
---|---|---|
12000 | Invalid or no omnichannel integration type specified. | Either specify an omnichannel integration type where one has not been provided, or change the provided type to one that is supported. Valid omnichannel integration types include: POP3SMTP, LiveChat. |
12001 | A valid omnichannel integration GUID must be specified within the request. | Specify a non-empty GUID value for the UniqueID Property. |
12002 | The omnichannel integration entry with GUID '|1' not found. | Specify an omnichannel integration GUID (via the UniqueID Property) that reporesents an existing entry. |
12003 | Unable to delete omnichannel integration entry '|1' because it is still configured to be "in service". You must specifically change its "Communication Enabled" setting to off in order to delete it. | Only inactive omnichannel integrations can be deleted. Therefore, you must ensure that the CommsEnabled parameter of the designated omnichannel integration is set to False by invoking a OmnichannelIntChange operation first. |
12004 | An omnichannel integration entry with GUID '|1' already exists. | Specify a GUID (via the UniqueID Property) that doesn't match the GUID of an existing omnichannel integration entry. |
# Central Management Environment Related Error Codes
Error Code | Error Message | Possible Resolution |
---|---|---|
12100 | CM Environment ID already exists. | Specify different ID. |
12101 | Parent CM Environment specified in the request does not exist. | Specify ID of a valid parent CM Environment. |
12102 | Duplicate domain value. | CM Environment with specified domain already exists. |
12103 | CM Environment ID was not specified. | Specify a valid CM Environment ID. |
12104 | CM Environment with the provided ID was not found. | CM Environment probably does not exist. |
12105 | CM Environment communication setting is still turned on which prevents the action. | Set communication active flag to Off. |
12106 | The specified CM Environment contains child CM environments that prevents the requested action. | Remove all child CM environments before attempting the action. |
12107 | There are telephone servers that belong to the specified CM Environment. | Delete the telephony servers or move them under different CM Environment. |
12108 | Parent CM Environment ID is missing in the request. | Add a valid parent CM Environment ID. |
12109 | The root CM Environment cannot be deleted. | It is never possible to delete the root CM Environment. |
12110 | There are users that belong to the specified CM Environment. | Update related users and move them to different CM Environment. |
12111 | Root CM Environment cannot be created using Web Services API. | If you would like to create a Root CM Environment, please contact your system administrator. |
12112 | The parent CM Environment ID cannot be the same as the ID of the CM environment. | Change parent CM Environment ID to a valid value that does not equal the ID of the CM environment. |
12113 | The root CM Environment cannot have a parent. | It is not possible to specify parent CM Environment for root CM Environment. |
12114 | The provisioning config for this CM Environment cannot be updated by current user. | Either use different user account or extend the permissions of the current user. |
12120 | The requested telephone server count cannot be saved, as there are already more telephone servers in this CME. | The count entered is less than the number of existing Telephony Servers in this CME. Enter a larger number, or remove obsolete Telephony Servers. |
12124 | The requested capabilities cannot be saved, as the CME already contains telephone server(s) that violate the new restrictions. | You cannot disable a Telephony Server type in a CME if there are already Telephony Servers of this type within it, or within one of its child CMEs. Remove the Telephony Server(s), or leave the type enabled in the CME Capabilities. |
12125 | The requested capabilities cannot be saved, as the CME already contains partition(s) that violate the new restrictions. | You cannot disable a License Level in a CME if there are already Partitions of this type within it, or within one of its child CMEs. Remove the partition(s), change their license level(s), or leave the license type enabled in the CME Capabilities. |
12126 | The requested capabilities cannot be saved, as the CME already contains user(s) that violate the new restrictions. | You cannot disable a License Level in a CME if there are already Users with this reporting level within it, or within one of its child CMEs. Remove the user(s), change their reporting access level(s), or leave the license type enabled in the CME Capabilities. |
# Invite Related Error Codes
Error Code | Error Message | Possible Resolution |
---|---|---|
17000 | The provided email address '|1' was already invited to Akixi. | The user has already been invited, so either use the existing token or specify a different email. |
17001 | The provided telephony server '|1' does not belong to the specified CME '|2'. | Specify a telephony server within the chosen CME, or specify the CME containing the telephony server. |
17002 | The provided token is not valid. | Specify a valid invite token |
17003 | The provided token is already expired. Please request a new one or contact your system administrator or service provider. | Acquire a new invite token/link. |
17004 | The provided email address '|1' is already used. | The user already exists, so either change/remove the existing user or specify a different email address. |
17005 | The provided email address '|1' is not valid. | Specify a valid email address. |
# User Role Related Error Codes
Error Code | Error Message | Possible Resolution |
---|---|---|
17100 | A role with same set of permissions already exists. | A role with same set of permission is already there. |
17101 | The role with name *** not found. | Role with the specified role id not found. |
17102 | Role Name was not specified in the request. | Specify the role id in the request. |
17103 | A default role cannot be deleted. | Default role with IsCustomizedRole set to false cannot be deleted. |
17104 | No slot is available for the new customized role. Please contact your system administrator for more details. | Only 5 customized role can be created per instance. |
17105 | Role ID was not specified in the request. | Specify a valid Role ID. |