Avaya Client Services API Reference (iOS)
|
Variables | |
NSString *const | CSErrorDomain |
The Avaya Client Services error domain. More... | |
NSString *const | CSProtocolErrorCodeKey |
The error code from the underlying signaling protocol as an NSNumber. More... | |
NSString *const | CSProtocolErrorStringKey |
The error string from the underlying signaling protocol. More... | |
NSString *const | CSProtocolWarningCodeKey |
The warning code from the underlying signaling protocol as an NSNumber. More... | |
NSString *const | CSProtocolWarningStringKey |
The warning string from the underlying signaling protocol. More... | |
NSString *const | CSSecondsUntilRetryKey |
The number of seconds until a retry is attempted automatically as an NSNumber. More... | |
enum CSErrorCode |
Error codes used by Avaya Client Services.
Enumerator | |
---|---|
CSErrorUnknown |
An unknown error occurred. If this error code is received it is a bug and should be reported. |
CSErrorNone |
Operation completed successfully. |
CSErrorFailed |
Operation has failed. |
CSErrorInternal |
Operation has failed due to an internal error. |
CSErrorInProgress |
Operation has failed because another operation is in progress. |
CSErrorTimeout |
Reported when the send of a network message timed out locally, or a response to the message was not received from the server in time. |
CSErrorInvalidState |
Reported when the request cannot be supported at this time due to the current state of the call. |
CSErrorNotSupported |
Reported when a requested operation cannot be supported locally, because the state of the underlying resource does not allow the operation at this time. |
CSErrorAuthenticationFailure |
Reported when local user's authentication with the network has failed. |
CSErrorClientShutDown | |
CSErrorCancelled |
The operation was cancelled. |
CSErrorInvalidDomain | |
CSErrorCellularCallInProgress |
Reported when a local VoIP/video call creation has failed because of an on-going cellular call. |
CSErrorNotLicensed |
Reported when an operation is denied because user does not have the license to perform the operation. |
CSErrorNotAuthorized |
Reported when an operation is denied because user does not have the privileges to perform the operation. |
CSErrorNoCredentialProvider |
Reported when there is no credential provider provided in the service configuration data. |
CSErrorConfigurationError |
Reported when there is an error discovered in the service configuration data. |
CSErrorNoAnswer |
Reported there is no answer from far end. |
CSErrorNotAllowed |
Reported when the request operation is not allowed at all. |
CSErrorIncorrectPasscodeTryAgain |
Reported when provided passcode for conference is not valid, indicates that there could be one more attempt to provide passcode. |
CSErrorIncorrectPasscodeDisconnecting |
Reported when provided passcode for conference is not valid, indicates that there will be no more attempts to provide passcode. |
CSErrorPendingApproval |
Reported when conference is in pending approval state. |
CSErrorLayoutNotAvailable |
Reported when the conference server is unable to support the selected video layout. |
CSErrorCapabilityDenied |
User is not allowed to perform operation. |
CSErrorConferenceSocketFailed |
Reported when UCCP web socket connection fails. |
CSErrorConferenceCertificateFailed |
Reported when UCCP web socket certificate fails. |
CSErrorConferenceFeatureNegotiationFailed |
Reported when UCCP handshake fails. |
CSErrorHTTPUACertificateFailed |
Reported when Service Gateway certificate fails. |
CSErrorWrongCurrentConference |
Reported if conference id is incorrect. |
CSErrorIncorrectInput |
Reported if user input is incorrect. |
CSErrorGuestAccessDenied |
Reported if user is guest and guest access disabled. |
CSErrorValidationFailed |
Reported if the name of the user did not pass validation. |
CSErrorOneTimePinRequired |
Reported if user is owner and one time pin is required. |
CSErrorForbiddenOneTimePinRequired |
Reported if oneTimePin required, but given user isn't owner of room. |
CSErrorLockedConference |
Reported if conference is locked and the user is not allowed to knock to it. |
CSErrorInitiateNonVirtualRoomMeetingDisallowed |
Reported if a user tries to create a meeting outside a virtual room. |
CSErrorWebCollaborationDisabled |
Reported if web collaboration is disabled. |
CSErrorIViewNotConnected |
Reported if iView is not available. |
CSErrorVirtualRoomNotFound |
Reported if provided conference id is not found. |
CSErrorTenantDoesNotExist |
Reported if provided tenant alias does not exist. |
CSErrorProxyAuthenticationError |
The authentication credentials provided for logging into the proxy were rejected. |
CSErrorVirtualRoomDoesNotAllowInstantMeeting |
Reported if virtual room does not allow creation of instant meeting. An instant meeting is a meeting that was not scheduled beforehand. |
CSErrorVirtualRoomDisabled |
Reported if virtual room is disabled. |
CSErrorCallInProgress |
Reported if any operation can not be completed because a call is already in progress. |
CSErrorUnauthorizedParticipantId |
Reported if unauthorized user tries to join virtual room protected by participant-id. |
CSErrorPinIsTooShort |
Reported if user enters PIN which is shorter than the minimum length configured. |
CSErrorSelfUnmuteNotAllowed |
Reported if the server did not approve user's unmute request. |
CSErrorConnectionFailure | |
CSErrorServerUntrusted | |
CSErrorSendFailure |
Reported when a network message could not be sent due to a network connection error. |
CSErrorUnrecognizedServer | |
CSErrorSSLFatalAlert | |
CSErrorWifiUnavailable |
Reported when a VoIP/video call cannot be set up because there is no Wifi network available to initiate a call and the local policy restricts VoIP/video calls to Wifi networks only. |
CSErrorUnsupportedLocalNetwork |
Registration has failed because the device is currently connected to an unsupported network type. |
CSErrorProxyConnectionError |
A connection could not be established to the proxy server. |
CSErrorInvalidParameter |
Reported when an invalid parameter is used for the request. |
CSErrorSIPInvalidDomain | |
CSErrorSIPInvalidUserId | |
CSErrorSIPInvalidAddressOfRecord | |
CSErrorSIPEmptyServerList | |
CSErrorSIPInvalidServer | |
CSErrorSIPUserExists | |
CSErrorSIPInvalidCredentialProvider | |
CSErrorInvalidDataDirectory | |
CSErrorHTTPInvalidUserId | |
CSErrorHTTPInvalidCredentialProvider | |
CSErrorHTTPUserExists | |
CSErrorUnsupportedConnectionPolicy | |
CSErrorInvalidSessionRefreshInterval | |
CSErrorEmptyCipherSuitesList |
Reported when all supported cipher suites are blacklisted in client configuration. |
CSErrorNotRegistered |
Reported when an operation fails because the server believes the user is not registered. |
CSErrorServerFailure |
Reported when the request has failed due to an internal server error. |
CSErrorServerEnded | |
CSErrorMaximumRegistrationsExceeded | |
CSErrorRejected |
Reported when the request is rejected by the server due to a permission error. |
CSErrorBusy |
Reported when the request is rejected by the server due to resource being busy. |
CSErrorRedirected |
Network re-directed the request. |
CSErrorCodecMismatch |
Reported when a VoIP session cannot be established due to incompatible codecs between the local and remote parties. |
CSErrorUserNotFound |
Reported when the called party address is not known to the server. |
CSErrorUserTemporarilyUnavailable |
Reported when the called party has no device registered on his/her behalf, making call setup not possible at this point in time. |
CSErrorNoAvailableCallAppearance |
Reported when the local user's call initiation attempt fails because the Avaya Communication Manager has no idle line appearance available for the call. |
CSErrorLineReservationFailure |
Reported when a line reservation attempt is failed by the server. |
CSErrorRemoteCallNoLongerAlerting |
Reported when an attempt to locally answer an incoming call at a remote extension (e.g., at a bridged line appearance extension) has failed because the call was already answered remotely. |
CSErrorRetryLimitExceeded | |
CSErrorInvalidResponse | |
CSErrorConferenceAddressNotValid |
Reported when an ad-hoc conference creation attempt fails because the provisioned network address used for ad-hoc conference creation is not valid. |
CSErrorCallTerminated |
Reported when outgoing call request is terminated or canceled by user action. |
CSErrorConfigurationDataNotAvailable |
Reported when the configuration data for the user is not available at the server. |
CSErrorOneTimePINRequiredForVirtualRoomAccess |
Reported when one time pin is required and user is not owner of the room. |
CSErrorOneTimePINRequiredForOwnerVirtualRoomAccess |
Reported when one time pin is required and user is owner of the room. |
CSErrorUnAuthorizedUserCannotJoinVirtualRoom |
Reported if unauthorized user tries to join virtual room protected by participant-id. |
CSErrorCallFailedAnsweredCoveredDropped |
Reported if the call is answered by another user, dropped by the caller or sent to voice mail. |
CSErrorMediaCreationFailure |
Reported when local audio and/or video resources cannot be initialized successfully. |
CSErrorMediaStartFailure |
Reported when local audio and/or video resources cannot be started successfully. |
CSErrorRemoteMediaProcessingFailure |
Reported when the application tries to accept an incoming call, but this attempt fails because the remote audio and/or video information could not be applied to local audio/video resources. |
CSErrorVideoDenied |
Reported when a mid-call video add request was denied by the remote party. |
CSErrorFeatureCancelled | |
CSErrorContactProviderPictureNotAvailable |
Contact doesn't have a picture or specific contact provider uses LDAP as a source for pictures and it is not configured / available at the time. |
CSErrorContactProviderContactIdInvalid |
Missing or invalid provider contact ID. |
CSErrorContactProviderDatabaseNoAccess |
Provider cannot access the database for reading or writing. |
CSErrorContactProviderDuplicateContact |
This error can occur when trying to add a new contact with the same. |
CSErrorContactProviderContactNotIMUser |
|
CSErrorContactProviderContactAddressNULL |
Address field is empty. |
CSErrorContactProviderInvalidContact |
Provided data failed a validation step. |
CSErrorContactProviderRequiredDataMissing |
Required fields are missing. |
CSErrorContactProviderInvalidValue |
Invalid contact field value. |
CSErrorContactProviderDatabaseNotAccessible |
Problem with the database accessibility. |
CSErrorContactProviderContactDoesNotExists |
Name field is empty or not present. |
CSErrorContactProviderNoProfile |
An internal contact does not have a communication profile. |
CSErrorContactProviderConfigurationMismatch |
Value exceeded server limit, typically maximum of 70 data items. As of SM 6.2 Feature Pack 1 this limit is increased to 100 data items. |
CSErrorContactProviderRetry |
Server is busy. Provider is retrying the operation. |
CSErrorContactProviderDeleteContactNotSupported |
Provider does not support deletion of contacts operation. |
CSErrorContactProviderAddContactNotSupported |
Provider does not support creation of new contacts operation. |
CSErrorContactProviderUpdateContactNotSupported |
Provider does not support updating contacts operation. |
CSErrorContactProviderRetrievePictureNotSupported |
Provider does not support retrieving contact picture operation. |
CSErrorContactProviderNotMatch |
No provider matches the contact source. |
CSErrorContactNotFound |
Contact not found. |
CSErrorContactProviderDigestMismatch |
Digest Authentication failed. |
CSErrorContactProviderMultipleWorkEmailNotSupported |
The server rejected the request due to multiple work e-mails. Request should have only one work email. |
CSErrorNoParticipants | |
CSErrorParticipantAddressInvalid | |
CSErrorMessageNotFound | |
CSErrorSubjectLengthExceeded | |
CSErrorAttachmentSizeExceeded | |
CSErrorThumbnailSizeExceeded | |
CSErrorFailedToOpenDestinationFile | |
CSErrorFailedToOpenFileToAttach | |
CSErrorWrongAttachmentPath | |
CSErrorUnsupportedMediaTypeForAttachmentThumbnail | |
CSErrorMaxNumberOfAttachmentsLimitExceeded | |
CSErrorBodyLengthExceeded | |
CSErrorAttachmentNotFound | |
CSErrorMessageEmpty | |
CSErrorAttachmentEmpty | |
CSErrorConversationAlreadyExists | |
CSErrorConversationNotFound |
Requested conversation could not be found. |
CSErrorParticipantsMismatch |
The message recipients do not match the conversation participants. |
CSErrorForcedLogout |
The server has forcibly logged the session out. |
CSErrorHtmlBodyLengthExceeded |
The HTML body length exceeded. |
CSErrorCertificateUntrusted |
Reported when certificate chain cannot be trusted. This is often a generic error. |
CSErrorCertificateTrusted |
Reported when certificate chain is trusted. |
CSErrorCertificateHasExpired |
Reported when one or more certificates in the chain are expired. |
CSErrorCertificateNotYetValid |
Reported when one or more certificates in the chain are yet to commence. |
CSErrorCertificateRevoked |
Reported when one or more certificates in the chain are revoked. |
CSErrorCertificateInvalidServerIdentity |
Reported when identity presented by the server does not match the hostname to which client is connecting to. |
CSErrorCertificateInvalidEncoding |
Reported when one or more certificates in the chain has unsupported encoding. |
CSErrorCertificateParsingFailed |
Reported when one or more certificates in the chain is corrupted. |
CSErrorCertificateRevocationStatusUnknown |
Reported when one or more certificate's revocation information cannot be retrieved. |
CSErrorInvalidCertificateUsage |
Reported when certificate or certificate chain is not valid for its intended usage. |
CSErrorCertificateInvalidExtension |
Reported when one of the certificate in the chain has extension which is not valid. |
CSErrorCertificateUntrustedRoot |
Reported when CA certificates that form a complete chain cannot be trusted. |
CSErrorCertificateInvalidSignature |
Reported when one or more certificate has invalid signature. |
CSErrorCertificateInvalidServiceDomain |
Reported when service identity presented by the server does not match the service identity to which client is connecting to. |
CSErrorCertificateInvalidSIPDomain |
Reported when SIP service identity presented by the server does not match the SIP domain to which client is connecting to. |
CSErrorCertificateStoreExists |
Reported when an attempt to create private trust store when it already exists. |
CSErrorCertificateStoreError |
Reported when an error is encountered while creating the private trust store. |
CSErrorCertificateStoreCreateFailed |
Reported when private trust store cannot be created due to security policy. |
CSErrorServerCertificateChainRevoked |
Reported when one or more certificates in the chain are revoked. |
CSErrorCertificateRequestCanceled |
Reported when ongoing certificate validation request was canceled. |
CSErrorBadPrivateKey |
Reported when supplied private key is corrupt. |
CSErrorPrivateKeyContainerFailure |
Reported when Keychain cannot be accessed to retrieve private key. |
CSErrorPrivateKeyStoreFailure |
Reported when a private key storage failed. |
CSErrorPrivateKeyExportFailure |
Reported when a private key is failed to retrieve from client identity stored in keychain. |
CSErrorMissingCertificateStore |
Reported when a client identity is missing from the Keychain. |
CSErrorClientIdentityStoreFailure |
Reported when a client identity cannot be stored in the Keychain. |
CSErrorEncryptionFailure |
Unsupported for iOS and macOS. |
CSErrorDecryptionFailure |
Unsupported for iOS and macOS. |
CSErrorUnsupportedCertificateStore |
Unsupported for iOS and macOS. |
CSErrorClientIdentityCertificateUnknownCA |
Reported when registration has failed because the client identity presented by the client applicatio is issued by unknown CA. |
CSErrorClientIdentityCertificateAccessDenied |
Reported when registration has failed because server has disallowed the connection for this client application in spite of trusted client certificates. |
CSErrorClientIdentityCertificateBad |
Reported when registration has failed due to bad (sometimes acts as generic error) client certificate. |
CSErrorClientIdentityCertificateUnsupported |
Reported when registration has failed because the client identity certificate presented by the client application is not supported by the server. |
CSErrorClientIdentityCertificateNoCertificate |
Reported when registration has failed because the client identity certificate presented by the client application is missing. This error is code is used for SSLv3 connections only. |
CSErrorClientIdentityCertificateRevoked |
Reported when registration has failed because the client identity certificate presented by the client application is revoked. |
CSErrorClientIdentityCertificateExpired |
Reported when registration has failed because the client identity certificate presented by the client application is expired. |
CSErrorClientIdentityCertificateUnknown |
Reported when registration has failed because an unknown error has occurred on the server while validating the presented client identity certificate. |
CSErrorSSLHandshakeFailure |
Reported when registration has failed because client application is unable to negotiate an acceptable set of security parameters. |
CSErrorPrivateTrustStoreError |
Reported when registration has failed because client application has configured to use the private trust store via CSSecurityPolicyConfiguration but it is unavailable. |
CSErrorCertificateEnrollmentFailed |
Reported when certificate enrollment has failed. |
CSErrorCertificateEnrollmentNotConnected |
Reported when connection to SCEP server failed. |
CSErrorCertificateEnrollmentCaCertificateIsInvalid |
Reported when connection to SCEP server failed because of invalid CA issue or CA doesn't exist. |
CSErrorCertificateEnrollmentWrongConfiguration |
Reported when enrollment failed because of wrong configuration. |
CSErrorCertificateEnrollmentCertificateAlreadyEnrolled |
Reported when SCEP enrollment failed because the certificate was already enrolled. |
CSErrorCertificateEnrollmentWrongPassword |
Reported when SCEP password is incorrect. |
CSErrorKeyLengthTooSmall |
Reported when key length is too small to be acceptable for current security policy. |
CSErrorInvalidIdentityCertificate |
Reported when client identity certificate is rejected by the server. |
CSErrorCertificateEnrollmentRequestPending |
Reported when the enrollment request is failed due to pending response (manual approvement is enabled on SCEP server). |
CSErrorCertificateEnrollmentFailedToSetIdentity |
Reported when the identity certificate cannot be applied. |
CSErrorCertificateEnrollmentInProgress |
Reported when the enrollment request is already in progress. |
CSErrorInvalidDigestAlgorithm |
Reported when digest algorithm is unsupported or it is disabled in security policy. |
CSErrorInvalidAsymmetricEncryptionAlgorithm |
Reported when asymmetric encryption algorithm is unsupported or it is disabled in security policy. |
CSErrorIncompatiblePrivateKeyFormat | |
CSErrorSharedControlInvalidError | |
CSErrorSharedControlLocallyDisconnected | |
CSErrorSharedControlControlledEndpointEnded | |
CSErrorSharedControlLinkDownError | |
CSErrorSharedControlAuthenticationError | |
CSErrorSharedControlConnectionError | |
CSErrorSharedControlInvalidStateError | |
CSErrorSharedControlServerError | |
CSErrorSharedControlServerEndedError | |
CSErrorSharedControlGeneralError | |
CSErrorSharedControlControlLinkLocalError | |
CSErrorSharedControlControlLinkRemoteError | |
CSErrorSharedControlControllingEndpointEnded | |
CSErrorDirectorySearchProviderUnknownReason | |
CSErrorDirectorySearchProviderInternalError | |
CSErrorDirectorySearchProviderBackendSourceNotConnectable | |
CSErrorDirectorySearchProviderAuthenticationFailed | |
CSErrorDirectorySearchProviderCertificateError | |
CSErrorDirectorySearchProviderSecureConnection_failed | |
CSErrorDirectorySearchProviderRequestTimeout | |
CSErrorDirectorySearchProviderUserCancel | |
CSErrorDirectorySearchProviderConfigChange | |
CSErrorDirectorySearchProviderNoPicture | |
CSErrorDirectorySearchProviderInvalidSearchRequestId | |
CSErrorDirectorySearchProviderInvalidSearchCriteria | |
CSErrorDirectorySearchProviderInvalidSearchType | |
CSErrorDirectorySearchProviderMaxSearchLimitCrossed | |
CSErrorDirectorySearchProviderInvalidChunksize | |
CSErrorDirectorySearchProviderDatabaseError | |
CSErrorDirectorySearchProviderRetry | |
CSErrorDirectorySearchProviderRegularExpression | |
CSErrorDirectorySearchProviderLdapConnectFailed | |
CSErrorDirectorySearchProviderLdapSearchFailed | |
CSErrorDirectorySearchProviderLdapRetrieveResultsFailed | |
CSErrorDirectorySearchProviderProvisioningError | |
CSErrorDirectorySearchProviderDigestMismatch | |
CSErrorDirectorySearchProviderRetrievePictureNotSupported | |
CSErrorDirectorySearchProviderSearchTerminalNotSupported | |
CSErrorDirectorySearchProviderInvalidSearchRequest | |
CSErrorAutodialDatabaseNotAccessible | |
CSErrorAutodialDatabaseReadWriteFailure | |
CSErrorAutodialConfigurationMismatch | |
CSErrorAutodialNotIMUser | |
CSErrorAutodialInvalidValue | |
CSErrorAutodialNoListAvailable | |
CSErrorAutodialNoButtonFound | |
CSErrorAutodialHandleInvalid | |
CSErrorAutodialDigestMismatch | |
CSErrorAutodialUpdateInProgress | |
CSErrorCollaborationCannotEdit | |
CSErrorCollaborationOperationInProgress | |
CSErrorCollaborationInternalError | |
CSErrorCollaborationHTTPStatusCodeError | |
CSErrorCollaborationPermissionDenied | |
CSErrorCollaborationCanceled | |
CSErrorCollaborationNotSupported | |
CSErrorCollaborationTimeout | |
CSErrorCollaborationNotConnectable | |
CSErrorCollaborationProtocolError | |
CSErrorCollaborationAuthenticationFailed | |
CSErrorCollaborationInvalidCertificate | |
CSErrorCollaborationServerError | |
CSErrorCollaborationMeetingNotFound | |
CSErrorCollaborationTargetNotFound | |
CSErrorCollaborationUnavailable | |
CSErrorCollaborationCollaborationAlreadyCreated | |
CSErrorCollaborationConfigurationError | |
CSErrorCollaborationCapabilityRejectedByServer | |
CSErrorCollaborationInsufficientBandwidth | |
CSErrorNetworkNotAvailable | |
CSErrorInvalidCertificate | |
CSErrorConferenceConnectionFailedToRecover |
Attempts to recover connection to conference server have failed. The SDK will not be able to support conference call features for the conference call. |
CSErrorDownloadConnectionFailure | |
CSErrorDownloadInvalidDestinationDirectory | |
CSErrorDownloadUnsupportedProtocol | |
CSErrorDownloadErrorWritingFile | |
CSErrorDownloadInvalidContentType | |
CSErrorDownloadBinaryDataExceedsMaxSize |
Max size of the downloaded binary data is exceeded. |
CSErrorMobileLinkSpeakerMuted |
Reported when Sonic detected that the speaker is muted. |
CSErrorMobileLinkHeadsetConnected |
Reported when Sonic detected that headset is connected. |
CSErrorMobileLinkSonicSignalGenerationFailed |
Reported when Sonic fails to generate the signal. |
CSErrorFeatureLabelDatabaseNotAccessible |
Reported for database access problem. |
CSErrorFeatureLabelDatabaseReadWriteFailure |
Reported for database access failure for reading or writing. |
CSErrorFeatureLabelConfigurationMismatch |
Reported when the handle indicated in request not found in database. |
CSErrorFeatureLabelNotIMUser |
Reported when requesting user does not exist in the database. |
CSErrorFeatureLabelInvalidValue |
Reported when invalid field value OR string length exceeds maximum. |
CSErrorFeatureLabelNoListAvailable |
Reported when the request from the endpoint did not contain any data. |
CSErrorFeatureLabelNoButtonFound |
Reported when the request is for a button that has been deleted on CM. |
CSErrorFeatureLabelHandleInvalid |
Reported for missing or invalid provider handle. |
CSErrorFeatureLabelDigestMismatch |
Reported for digest authentication failure. |
CSErrorFeatureLabelUpdateInProgress |
Reported when device data update already in progress. |
CSErrorPushNotificationServiceShutdown |
The operation failed because the client has been or is in the process of being shut down. |
CSErrorPushNotificationServiceRequestCancelled | |
CSErrorPushNotificationServiceInvalidState | |
CSErrorPushNotificationServiceInternalError | |
CSErrorPushNotificationServiceConnectionError |
The notification cannot be processed due to no server connectivity. |
CSErrorPushNotificationServiceDialogNotFound |
No matching remote dialog found for the notification after dialog subscription refresh. |
CSErrorPushNotificationServiceConfigurationError |
The notification cannot be processed due to configuration. |
CSErrorPushNotificationServiceConnectionSecurityFault |
The connection could not be established securely. |
CSErrorPushNotificationServiceAuthenticationError |
The credentials provided were not accepted by the server. |
CSErrorIncompatiblePushNotificationServerError |
An error indicating that the push notification service cannot be activated, because the push notification server is incompatible with this client's release. For example, this error can be reported if the iOS 13SDK (or later) compiled client application tries to activate push service with an old telephony push notification server. This is not allowed because the old server may report voice mail status updates to the client over Apple's VoIP push notification network, causing the iOS to no longer deliver VoIP push notifications to the client. |
CSErrorGroupLimitExceeded | |
CSErrorGroupAlreadyExists |
Group count has reached maximum. |
CSErrorGroupContactsLimitExceeded |
Group with specified name already exists. |
CSErrorGroupCreateNotSupported |
Group contacts count has reached maximum. |
CSErrorGroupDeleteNotSupported |
Contact group provider does not support operation. |
CSErrorGroupRenameNotSupported |
Contact group provider does not support operation. |
CSErrorGroupNameInvalid |
Contact group provider does not support operation. |
CSErrorGroupNotFound |
Missing or Invalid Provider contact group name. |
CSErrorGroupAddContactsNotSupported |
Contact group not found. |
CSErrorGroupRemoveContactsNotSupported |
Add contacts to a group isn't supported. |
CSErrorGroupNameExceedsMaxLength |
Remove contacts from a group isn't supported. |
CSErrorInvalidCharactersInGroupName |
Contact group name is too long. |
CSErrorAgentGenericFailure |
Contact group name contains invalid characters. |
CSErrorAgentFeatureNotSupported |
Generic error message. |
CSErrorAgentTemporaryFailure |
Unsupported agent feature. |
CSErrorAgentPermissionDenied |
Temporary failure on the server side. |
CSErrorWrongAgent |
Generic permission error. |
CSErrorAgentGenericLoginFailure |
Wrong agent id or agent extension id. |
CSErrorMaxNumBCMSAgentsLoggedIn |
Agent generic login failure. |
CSErrorAgentLoginElsewhere |
Maximum number of BCMS logins exceeded. |
CSErrorMaxNumEASAgentsLoggedIn |
Agent logged in at another location. |
CSErrorStationAlreadyLoggedIn |
Maximum number of SIP EAS logins exceeded. |
CSErrorMaxNumACDAgentsLoggedIn |
Physical station extension already has an agent logged in. |
CSErrorInvalidEASLoginPassword |
Maximum number of ACD logins exceeded. |
CSErrorInvalidEASLogin |
Invalid loginID password entered. |
CSErrorInvalidEASReasonCode |
Invalid loginID entered. |
CSErrorMaxNumAdvocateAgentsLoggedIn |
Invalid Reson Code entered. |
CSErrorCMInternalAgentLogoutFailure |
Maximum number of advocate logins exceeded. |
CSErrorCMInternalAgentLoginFailure |
CM internal agent logout failure. |
CSErrorSkillConfigProblem |
CM internal agent login failure. |
CSErrorWrongSkill |
Skill configuration problem. |
CSErrorInvalidReasonCode |
Agent add/remove wrong skill. |
CSErrorAgentBusy |
Invalid reason code was provided. |
CSErrorAgentNotLoggedIn |
Add/remove skill while agent is busy. When agent tries to change work mode while not logged in. |
CSErrorAgentAutoAvailable |
Permission denied when agent tries to change work mode. |
CSErrorAgentBurnOut |
Work mode changes denied because agent is in maximum agent occupancy or burn-out mode. |
CSErrorRequireCallerWorkCodeOrStrokeCountCode |
Permission denied due to caller work code or stroke count code is not provided. |
CSErrorResourceIdNotAllowed |
Permission denied due to invalid resource id. |
CSErrorAgentNotAdministered |
Permission denied because agent is not administered on signalling server. |
CSErrorSkillNotAdministered |
Permission denied because skill is not administered on signalling server. |
CSErrorTrunkNotAdministered |
Permission denied because trunk is not configured on signalling server. |
CSErrorVectorDirectoryNumberNotAdministered |
Permission denied because said Vector Directory Number (VDN) is not administered on signalling server. |
CSErrorAgentNotMeasured |
View Status information is not available because agent is not administered on signalling server for status monitoring (configurable by flag - measured = y/n) |
CSErrorSkillNotMeasured |
View Status information is not available because skill is not administered on signalling server for status monitoring (configurable by flag - measured = y/n) |
CSErrorTrunkNotMeasured |
View Status information is not available because trunk is not administered on signalling server for status monitoring (configurable by flag - measured = y/n) |
CSErrorVectorDirectoryNumberNotMeasured |
View Status information is not available because Vector Directory Number (VDN) is not administered on signalling server for status monitoring. (configurable by flag - measured = y/n) |
CSErrorFormatNotDefined |
Provided format for view status is not defined on signalling server. |
CSErrorSupervisorNotAdministered |
Supervisor (type of agent) is not administered on signalling server. |
CSErrorSupervisorNotAvailable |
Supervisor (type of agent) is either or not available. |
CSErrorFeatureReferralNotSupported |
Permission denied because feature referral is not supported. |
CSErrorFeatureInvalidExtension |
Entered extension invalid. |
CSErrorFeatureAllowServiceObservingClassOfRestriction |
Service Observing denied due to allow Service Observing COR for SIP station extension being used not set to yes. |
CSErrorFeatureReceiveServiceObservingClassOfRestriction |
Service Observing denied due to receive Service Observing COR for entity to observe not set to yes. |
CSErrorFeatureServiceObservingClassOfRestrictionMismatch |
Observing COR cannot observe COR of entered entity (COR Service Observing permissions mismatch). |
CSErrorFeatureObserveeAgentNotLoggedIn |
Entered to observe Logical agent ID not logged in. |
CSErrorFeaturePhysicalStationAlreadyObserved |
Activation to logical with physical being observed. |
CSErrorFeatureLogicalIdAlreadyObserved |
Activation to physical with logical ID being observed. |
CSErrorFeatureDataRestrictionActive |
Extension has Data Restriction. |
CSErrorFeatureExclusionActive |
Extension has Exclusion Active. |
CSErrorFeatureDataPrivacyActive |
Extension has Data Privacy Active on call. |
CSErrorFeatureMaxObserversReached |
Station/logical agentID extension already observed (or two observers already observing extension with Allow Two Observers active). |
CSErrorFeatureExtensionIsObserver |
Extension is an observer. |
CSErrorFeatureExtensionBeingBusyVerified |
Extension being busy-verified. |
CSErrorFeatureExtensionHasSixPartyConf |
Extension has a 6-party conference. |
CSErrorFeatureVectorDirectoryNumberNotOptioned |
Observe VDNs not optioned. |
CSErrorFeatureMaxVectorDirectoryNumberObserved |
Maximum VDNs being observed. |
CSErrorFeatureServiceObservingByLocationInvalidVectorDirectoryNumber |
Service Observing VDN By location entered VDN extension not a valid VDN. |
CSErrorFeatureServiceObservingByLocationInvalidLocation |
Service Observing VDN By location entered location number not valid. |
CSErrorFeatureMissingInfo |
One or more required entries missing. |
CSErrorFeatureListenOnlyOptionActive |
Cannot change to listen-talk because station option is set to listen-only. |
CSErrorFeatureNoTalkOrNoConnectionAvail |
Cannot change to coach mode because there is no observed connection or the No-Talk So type has been selected. |
CSErrorFeatureNoAvailIdleCa |
No idle call appearance to connect to observed connection. |
CSErrorFeatureTransferDialtone |
The observer is dropped from an observed connection when an attendant transfers the observed call to the ARS dial tone. |
CSErrorFeatureTransferNotObservable |
The observer is dropped from an observed connection when the observee starts to do a transfer (presses the transfer button). |
CSErrorFeatureDestinationNotObservable |
The observer is dropped from an observed connection (to extension or VDN) when the connection reaches an unobservable destination (e.g., not allowed to observe COR. |
CSErrorFeatureCanNotContinueObserving |
Observing session cancelled because of a not allowed action (e.g., hold of Service Observing CA) or CM cancelled a logged in agent session (forced log out or Interruptible Aux notification, etc.) |
CSErrorFeatureNoDisconnectSupervision |
Attempted to initiate service observing from a trunk that does not have disconnect supervision. [remote service observing error?] |
CSErrorFeatureBeingObserved |
Attempted to initiate service observing from a station that is being observed by someone else. |
CSErrorFeatureAttendantCannotObserve |
An attendant is not allowed to activate service observing. |
CSErrorFeatureBridgedAppeatance |
A bridged appearance is not allowed to activate service observing. |
CSErrorFeatureDataModule |
A data module is not allowed to activate service observing. |
CSErrorFeatureAlreadyObserved |
An observer is not allowed to activate service observing for a second observe. |
CSErrorFeatureCannotObserveYourself |
Attempting to service observe your own extension or agent-loginID. |
CSErrorFeatureMeetMeVectorDirectoryNumber |
Cannot observe a meet-me VDN. |
CSErrorFeatureInternalError |
Internal error try again. |
CSErrorFeatureNotAUX |
Agent not in AUX Work. |
CSErrorFeatureOnCall |
Agent connected to a call. |
CSErrorFeatureCallOnHold |
Agent has calls on hold. |
CSErrorFeatureInvalidSoActivation |
Invalid Service Observing activation. |
CSErrorFeatureAgentBeingCoached |
Agent already being coached. |
CSErrorFeatureCoachingCanceledAlreadyCoachedConnection |
Agent connected to already coached agent. |
CSErrorFeatureNotObservingAgent |
Not observing a local agent. |
CSErrorFeatureWrongMode |
Wrong Service Observing mode. |
CSErrorFeatureAgentStateNotCoachable |
Wrong observed agent state. |
CSErrorFeatureCoachingCanceledAgentStatenotCoachable |
Wrong observed agent state. |
CSErrorFeatureCoachingCanceledAgentLoggedOut |
Agent logged out. |
CSErrorFeatureMediaPreservation |
Denied mode change. |
CSErrorFeatureSystemError |
System error. |
CSErrorFeatureInvalidAgentId |
Invalid Agent Id. |
CSErrorFeatureOutOfRangeSkillNumber |
Out Of Range Skill Number. |
CSErrorFeatureAgentBusyOnSkill |
Agent Busy on Skill. |
CSErrorFeatureInvalidEASSkill |
Invalid Expert Agent Selection (EAS) skill. |
CSErrorFeatureMaxAgentSkillsReached |
Max Agent Skills Reached. |
CSErrorFeatureExpertAgentSelectionDisabled |
Expert Agent Selection Disabled. |
CSErrorFeatureEASSkillsDisabled |
Expert Agent Selection (EAS) Skills Disabled. |
CSErrorFeatureInvalidClassOfRestriction |
Invalid Class Of Restriction. |
CSErrorFeatureInvalidUser |
Invalid User. |
CSErrorFeatureAgentTenantNumberIssue |
Agent Tenant Number Issue. |
CSErrorFeatureSkillTenantNumberIssue |
Skill Tenant Number Issue. |
CSErrorFeatureInvalidSkillLevel |
Invalid Skill Level. |
CSErrorFeatureSendStationServerFailure |
Send to Station Server Failure. |
CSErrorFeatureSkillChangeSaveFailure |
Skill Change Save Failed. |
CSErrorFeatureSend |
Send request failed. |
CSErrorButtonCustomizationUpdateInProgress |
Reported when device data update operation is in progress already. |
CSErrorButtonCustomizationDatabaseNotAccessible |
Reported when there is some problem with the database. |
CSErrorButtonCustomizationDatabaseReadWriteFailure |
Reported when provider cannot access the database for reading or writing. |
CSErrorButtonCustomizationConfigurationMismatch |
Reported when requesting user does not exist in the database. |
CSErrorButtonCustomizationNotIMUser |
Reported when requesting user does not exist in the database. |
CSErrorButtonCustomizationInvalidValue |
Reported for invalid field value. |
CSErrorButtonCustomizationNoListAvailable |
Reported when the request from the endpoint did not contain any data. |
CSErrorButtonCustomizationNoButtonFound |
Reported when the request is for a button that has been deleted on CM. |
CSErrorButtonCustomizationHandleInvalid |
Reported for missing or invalid provider handle. |
CSErrorButtonCustomizationDigestMismatch |
Reported for digest authentication failure. |
NSString* const CSErrorDomain |
The Avaya Client Services error domain.
Error codes in this domain are defined in the CSErrorCode enumeration.
NSString* const CSProtocolErrorCodeKey |
The error code from the underlying signaling protocol as an NSNumber.
For SIP, this is the response code.
NSString* const CSProtocolErrorStringKey |
The error string from the underlying signaling protocol.
For SIP, this is the reason phrase.
NSString* const CSProtocolWarningCodeKey |
The warning code from the underlying signaling protocol as an NSNumber.
For SIP, this is the code provided in the Warning header.
NSString* const CSProtocolWarningStringKey |
The warning string from the underlying signaling protocol.
For SIP, this is the text provided in the Warning header.
NSString* const CSSecondsUntilRetryKey |
The number of seconds until a retry is attempted automatically as an NSNumber.