APIError
Props
code
code: number
The error code
msg
msg: string
The error description
- Getting started
- Guides
- Voice AI
- References
- Avatar API
- AvatarEngine
- Web SDK v5
- Reactnative v2
-
VoxEngine
- ACDEvents
- ASREvents
- AppEvents
- CallEvents
- ConferenceEvents
- PlayerEvents
- RecorderEvents
- SequencePlayerEvents
- SmartQueueEvents
- StreamingAgentEvents
- WebSocketEvents
- AI
- AMD
- ASRModelList
- ASRProfileList
- Agentic
- ApplicationStorage
- CCAI
- CallList
- Cartesia
- Crypto
- Deepgram
- ElevenLabs
- Gemini
- Hush
- IVR
- Inworld
- Logger
- MCP
- MeasurementProtocol
- Net
- OpenAI
- PhoneNumber
- Pipecat
- QwenCloud
- Silero
- Ultravox
- VoiceList
- VoxEngine
- VoxTTS
-
VoximplantAPI
- Client
- A2PGetSmsHistoryRequest
- A2PGetSmsHistoryResponse
- A2PSendSmsRequest
- A2PSendSmsResponse
- A2PSmsHistory
- ACDAfterServiceOperatorState
- ACDLock
- ACDLockedOperatorState
- ACDOperatorCall
- ACDQueueOperatorInfo
- ACDQueueState
- ACDReadyOperatorState
- ACDServicingCallState
- ACDState
- ACDWaitingCallState
- APIError
- AccountInfo
- AccountInvoice
- AccountsInterface
- ActivateOutboundTestPhoneNumberRequest
- ActivateOutboundTestPhoneNumberResponse
- AddApplicationRequest
- AddApplicationResponse
- AddAuthorizedAccountIPRequest
- AddAuthorizedAccountIPResponse
- AddOutboundTestPhoneNumberRequest
- AddOutboundTestPhoneNumberResponse
- AddPstnBlackListItemRequest
- AddPstnBlackListItemResponse
- AddQueueRequest
- AddQueueResponse
- AddSecretRequest
- AddSecretResponse
- AddSecretResult
- AddSipWhiteListItemRequest
- AddSipWhiteListItemResponse
- AddSkillRequest
- AddSkillResponse
- AddUserRequest
- AddUserResponse
- AppendToCallListRequest
- AppendToCallListResponse
- ApplicationInfo
- ApplicationsInterface
- AttachedPhoneInfo
- AuthorizedAccountIP
- AuthorizedIPsInterface
- BankCardBillingLimitInfo
- BillingLimitInfo
- BillingLimits
- BindSipRegistrationRequest
- BindSipRegistrationResponse
- BindSkillRequest
- BindSkillResponse
- BindUserToQueueRequest
- BindUserToQueueResponse
- CallInfo
- CallList
- CallListsInterface
- CallSessionInfo
- CallerIDInfo
- CallerIDsInterface
- CancelCallListBatchRequest
- CancelCallListBatchResponse
- CancelCallListTaskRequest
- CancelCallListTaskResponse
- CheckAuthorizedAccountIPRequest
- CheckAuthorizedAccountIPResponse
- ClientOptions
- ControlSmsRequest
- ControlSmsResponse
- CreateCallListRequest
- CreateCallListResponse
- DelApplicationRequest
- DelApplicationResponse
- DelAuthorizedAccountIPRequest
- DelAuthorizedAccountIPResponse
- DelCallerIDRequest
- DelCallerIDResponse
- DelKeyValueItemRequest
- DelKeyValueItemResponse
- DelOutboundTestPhoneNumberRequest
- DelOutboundTestPhoneNumberResponse
- DelPstnBlackListItemRequest
- DelPstnBlackListItemResponse
- DelQueueRequest
- DelQueueResponse
- DelSecretRequest
- DelSecretResponse
- DelSipWhiteListItemRequest
- DelSipWhiteListItemResponse
- DelSkillRequest
- DelSkillResponse
- DelUserRequest
- DelUserResponse
- DeleteCallListRequest
- DeleteCallListResponse
- DialogflowCredentialsInterface
- DownloadInvoiceRequest
- DownloadInvoiceResponse
- EditCallListRequest
- EditCallListResponse
- EditCallListTasksPriorityRequest
- EditCallListTasksPriorityResponse
- ExchangeRates
- FailedSms
- GetACDStateRequest
- GetACDStateResponse
- GetAccountInfoRequest
- GetAccountInfoResponse
- GetAccountInvoicesRequest
- GetAccountInvoicesResponse
- GetApplicationsRequest
- GetApplicationsResponse
- GetAuthorizedAccountIPsRequest
- GetAuthorizedAccountIPsResponse
- GetBriefCallHistoryRequest
- GetBriefCallHistoryResponse
- GetCallHistoryAsyncRequest
- GetCallHistoryAsyncResponse
- GetCallHistoryRequest
- GetCallHistoryResponse
- GetCallListsRequest
- GetCallListsResponse
- GetCallerIDsRequest
- GetCallerIDsResponse
- GetCurrencyRateRequest
- GetCurrencyRateResponse
- GetKeyValueItemRequest
- GetKeyValueItemResponse
- GetKeyValueItemsRequest
- GetKeyValueItemsResponse
- GetKeyValueKeysRequest
- GetKeyValueKeysResponse
- GetOutboundTestPhoneNumbersRequest
- GetOutboundTestPhoneNumbersResponse
- GetPhoneNumbersAsyncRequest
- GetPhoneNumbersAsyncResponse
- GetPhoneNumbersRequest
- GetPhoneNumbersResponse
- GetPstnBlackListRequest
- GetPstnBlackListResponse
- GetQueuesRequest
- GetQueuesResponse
- GetRecordStoragesRequest
- GetRecordStoragesResponse
- GetRoleGroupsRequest
- GetRoleGroupsResponse
- GetSQAgentsResult
- GetSQQueuesResult
- GetSQSkillsResult
- GetSQStateRequest
- GetSQStateResponse
- GetSecretValueRequest
- GetSecretValueResponse
- GetSecretValueResult
- GetSecretsRequest
- GetSecretsResponse
- GetSipRegistrationsRequest
- GetSipRegistrationsResponse
- GetSipWhiteListRequest
- GetSipWhiteListResponse
- GetSkillsRequest
- GetSkillsResponse
- GetSmartQueueDayHistoryRequest
- GetSmartQueueDayHistoryResponse
- GetSmartQueueRealtimeMetricsRequest
- GetSmartQueueRealtimeMetricsResponse
- GetSmsHistoryRequest
- GetSmsHistoryResponse
- GetTransactionHistoryAsyncRequest
- GetTransactionHistoryAsyncResponse
- GetTransactionHistoryRequest
- GetTransactionHistoryResponse
- GetUsersRequest
- GetUsersResponse
- GetWABPhoneNumbersRequest
- GetWABPhoneNumbersResponse
- HistoryInterface
- InvoicePeriod
- InvoiceSpendingDetails
- InvoiceTaxesDetails
- InvoiceTotalDetails
- InvoicesInterface
- IsAccountPhoneNumberRequest
- IsAccountPhoneNumberResponse
- KeyValueItems
- KeyValueKeys
- KeyValueStorageInterface
- OutboundTestNumbersInterface
- OutboundTestPhonenumberInfo
- PSTNBlacklistInterface
- PhoneNumbersInterface
- PstnBlackListInfo
- QueueInfo
- QueueSkills
- QueueUsers
- QueuesInterface
- Record
- RecordStorageInfo
- RecordStoragesInterface
- RequestSmartQueueHistoryRequest
- RequestSmartQueueHistoryResponse
- ResourceUsage
- RoleGroupView
- RoleSystemInterface
- SIPRegistration
- SIPRegistrationInterface
- SIPWhiteListInterface
- SMSInterface
- SQAddQueueResult
- SQAddSkillResult
- SQ_AddQueueRequest
- SQ_AddQueueResponse
- SQ_AddSkillRequest
- SQ_AddSkillResponse
- SQ_BindAgentRequest
- SQ_BindAgentResponse
- SQ_BindSkillRequest
- SQ_BindSkillResponse
- SQ_DelQueueRequest
- SQ_DelQueueResponse
- SQ_DelSkillRequest
- SQ_DelSkillResponse
- SQ_DeleteAgentCustomStatusMappingRequest
- SQ_DeleteAgentCustomStatusMappingResponse
- SQ_GetAgentCustomStatusMappingRequest
- SQ_GetAgentCustomStatusMappingResponse
- SQ_GetAgentsRequest
- SQ_GetAgentsResponse
- SQ_GetQueuesRequest
- SQ_GetQueuesResponse
- SQ_GetSkillsRequest
- SQ_GetSkillsResponse
- SQ_SetAgentCustomStatusMappingRequest
- SQ_SetAgentCustomStatusMappingResponse
- SQ_SetAgentInfoRequest
- SQ_SetAgentInfoResponse
- SQ_SetQueueInfoRequest
- SQ_SetQueueInfoResponse
- SQ_SetSkillInfoRequest
- SQ_SetSkillInfoResponse
- SQ_UnbindAgentRequest
- SQ_UnbindAgentResponse
- SQ_UnbindSkillRequest
- SQ_UnbindSkillResponse
- ScenariosInterface
- SecretListItem
- SecretsInterface
- SendSmsMessageRequest
- SendSmsMessageResponse
- SetApplicationInfoRequest
- SetApplicationInfoResponse
- SetDialogflowKeyRequest
- SetDialogflowKeyResponse
- SetKeyValueItemRequest
- SetKeyValueItemResponse
- SetPstnBlackListItemRequest
- SetPstnBlackListItemResponse
- SetQueueInfoRequest
- SetQueueInfoResponse
- SetSecretInfoRequest
- SetSecretInfoResponse
- SetSipWhiteListItemRequest
- SetSipWhiteListItemResponse
- SetSkillInfoRequest
- SetSkillInfoResponse
- SetUserInfoRequest
- SetUserInfoResponse
- SipWhiteListInfo
- SkillInfo
- SkillsInterface
- SmartQueueAgentSkill
- SmartQueueInterface
- SmartQueueMetricsGroups
- SmartQueueMetricsGroupsValues
- SmartQueueMetricsResult
- SmartQueueState
- SmartQueueStateAgent
- SmartQueueStateAgentStatus
- SmartQueueStateAgentStatus_
- SmartQueueStateTask
- SmartQueueTaskSkill
- SmsHistory
- SmsTransaction
- StartConferenceRequest
- StartConferenceResponse
- TransactionInfo
- UserInfo
- UsersInterface
- VerifyOutboundTestPhoneNumberRequest
- VerifyOutboundTestPhoneNumberResponse
- WABPhoneInfo
- WABPhoneNumbersInterface
- VoximplantAvatar
- XAI
- Yandex
- ACDRequest
- ASR
- ASRModel
- ASRProfile
- Call
- Conference
- ConferenceRecorder
- Endpoint
- IVRState
- Player
- Recorder
- SequencePlayer
- SmartQueueTask
- StreamingAgent
- Voice
- WebSocket
- ACDEnqueueParameters
- ASRParameters
- CallAnswerParameters
- CallEnableBeepDetectionParameters
- CallMediaStatistics
- CallMediaStatisticsSample
- CallPSTNParameters
- CallRecordParameters
- CallSIPParameters
- CallSayParameters
- CallUserDirectParameters
- CallUserParameters
- CallWhatsappUserParameters
- ChannelParameters
- ClearMediaBufferParameters
- ConferenceParameters
- EndpointParameters
- IVRSettings
- MonitorMediaStatisticsParameters
- ParticipantReceiveParameters
- ReceiveParameters
- RecorderDrawArea
- RecorderGridDefinition
- RecorderLabels
- RecorderParameters
- RecorderVad
- RecorderVideoParameters
- RichContent
- RichContentButtonAction
- RichContentButtonItem
- RichContentButtons
- RichContentContact
- RichContentExternalLink
- RichContentFile
- RichContentLocation
- RichContentMedia
- Scheme
- SendMediaParameters
- SequencePlaybackParameters
- SequencePlayerParameters
- SmartQueueOperatorSettings
- SmartQueueSkill
- SmartQueueTaskParameters
- SmartQueueTaskStatus
- StartPlaybackParameters
- StorageKey
- StoragePage
- StreamingAgentParameters
- StreamingAgentTrack
- TTSOptions
- TTSPlaybackParameters
- TTSPlayerParameters
- TTSPlayerSegment
- TextChannelParameters
- ToneScriptPlayerParameters
- TransferToParameters
- URLPlaybackParameters
- URLPlayerParameters
- URLPlayerRequest
- URLPlayerRequestBody
- URLPlayerRequestHeader
- URLPlayerSegment
- UpdateRecorderVideoParameters
- VoiceChannelParameters
- WebSocketMediaInfo
- WebSocketParameters
- base64_decode
- base64_encode
- bytes2hex
- bytes2str
- clearInterval
- clearTimeout
- getLocalTime
- hex2bytes
- levenshtein_distance
- require
- setInterval
- setTimeout
- str2bytes
- trace
- uuidgen
- ASRDictionary
- ASRLanguage
- CallAudioQuality
- ConferenceDirection
- ConferenceMode
- DTMFType
- DialogflowLanguage
- DialogflowModel
- DialogflowModelVariant
- DialogflowSsmlVoiceGender
- Modules
- RecordExpireTime
- RecorderDirection
- RecorderLabelFont
- RecorderLabelPosition
- RecorderLabelTextAlign
- RecorderLayout
- RecorderObjectFit
- RecorderProfile
- SmartQueueOperatorSettingsMode
- TTSEffectsProfile
- TaskWaitingCode
- TerminationStatus
- TranscriptionProvider
- URLPlayerRequestMethod
- VideoCodecs
- VoxTTSModelList
- VoxTTSVoiceList
- WebSocketAudioEncoding
- WebSocketCloseCode
- WebSocketReadyState
- IVRPrompt
- PlaybackParameters
- RecorderLayoutPriority
- SequencePlaybackSegment
- SequencePlayerSegment
- SmartQueue
- VoxMediaUnit
- Management API
- Web SDK
- Android SDK
- IOS SDK
- React Native SDK
- Flutter SDK
- Android SDK v3
- iOS SDK v3
Rate this page:
Loading...
We got it!
Rate this page:
Loading...
We got it!