Product
VOICE
VIDEO
MESSAGING
Solutions
Industries
Documentation
GETTING STARTED
PLATFORM REFERENCE
TUTORIALS
Showcase
Pricing
Blog
Help
FAQ
DEVELOPER COMMUNITY
CONTACT SUPPORT
About
VOXIMPLANT IN PRESS
STATUS PAGE
LEGAL INFO
CONTACT SALES
SIGN UP
BLOG
HELP
SIGN IN
PRODUCT
SOLUTIONS
INDUSTRIES
PRICING
SHOWCASE
DOCS
HELP
CONTACT SALES
SIGN UP
Navigation
Quickstart
Voximplant basics
Apps, Scenarios, Rules and Users
Receiving and handling calls in the cloud
Making outbound calls from the cloud
Using HTTP API to make calls
Using Voximplant SDKs
HowTo's
VoxEngine
Tutorials
Debugging scenarios
Global
base64_decode
base64_encode
bytes2hex
bytes2str
hex2bytes
md5
sha1
sha256
str2bytes
uuidgen
Namespaces
Crypto
md5
sha1
Logger
write
Net
HttpRequestOptions
headers
method
params
postData
rawOutput
timeout
HttpRequestResult
code
data
error
headers
raw_headers
text
SendMailOptions
bcc
cc
html
login
password
port
SendMailResult
code
error
httpRequest
httpRequestAsync
sendMail
sendMailAsync
PhoneNumber
Info
error
isPossibleNumber
isValidNumber
isValidNumberForRegion
number
numberType
region
getInfo
VoxEngine
AnswerParameters
maxVideoBitrate
scheme
ConferenceParameters
hd_audio
RecorderParameters
dict
expire
format
hd_audio
labels
language
lossless
name
secure
stereo
transcribe
transcriptionThreshold
video
TTSOptions
pitch
rate
volume
callSIPParameters
authUser
callerid
displayName
extraHeaders
outProxy
password
regId
video
addEventListener
callConference
callPSTN
callSIP
callUser
callUserDirect
customData
easyProcess
forwardCallToPSTN
forwardCallToSIP
forwardCallToUser
forwardCallToUserDirect
playSoundAndHangup
removeEventListener
sendMediaBetween
stopMediaBetween
terminate
Language
Language.Premium
RecordExpireTime
Modules
ACD
ACDEvents
Error
error
request
Offline
request
OperatorFailed
operatorUserName
request
statusCode
OperatorReached
operatorCall
request
QueueFull
request
Queued
request
Waiting
ewt
request
ACDEnqueueParams
headers
priority
ACDRequest
addEventListener
cancel
getStatus
id
removeEventListener
VoxEngine.enqueueACDRequest
Return
callerid
params
queueName
AI
DialogflowSsmlVoiceGender
FEMALE
MALE
NEUTRAL
UNSPECIFIED
Events
DialogflowError
cause
dialogflow
DialogflowPlaybackFinished
dialogflow
error
DialogflowPlaybackMarkerReached
dialogflow
offset
DialogflowPlaybackStarted
dialogflow
duration
DialogflowResponse
dialogflow
response
DialogflowStopped
cause
dialogflow
VoicemailDetected
call
confidence
VoicemailNotDetected
call
DialogflowEventInput
languageCode
name
parameters
DialogflowInstance
addEventListener
addMarker
removeEventListener
sendQuery
setOutputAudioConfig
setPhraseHints
setQueryParameters
stop
DialogflowOutputAudioConfig
synthesizeSpeechConfig
DialogflowQueryInput
event
text
DialogflowQueryParameters
contexts
geoLocation
payload
resetContexts
sessionEntityTypes
timeZone
DialogflowResponse
queryResult
recognitionResult
responseId
webhookStatus
DialogflowResult
action
allRequiredParamsPresent
diagnosticInfo
fulfillmentMessages
fulfillmentText
intent
intentDetectionConfidence
languageCode
parameters
queryText
DialogflowSettings
lang
outputAudioConfig
phraseHints
queryParameters
singleUtterance
DialogflowStreamingRecognitionResult
confidence
isFinal
messageType
transcript
DialogflowSynthesizeSpeechConfig
effectsProfileId
pitch
speakingRate
voice
volumeGainDb
DialogflowTextInput
languageCode
text
DialogflowVoiceSelectionParams
name
ssmlGender
createDialogflow
Return
params
detectVoicemail
Return
call
DialogflowLanguage
ASR
ASREvents
ASRError
asr
error
CaptureStarted
asr
InterimResult
asr
text
Result
asr
confidence
text
SpeechCaptured
asr
Started
asr
Stopped
asr
cost
duration
ASR
addEventListener
removeEventListener
stop
ASRParameters
dict
interimResults
lang
singleUtterance
VoxEngine.createASR
Return
params
levenshtein_distance
Return
str1
str2
ASRDictionary
ASRLanguage
CallList
reportError
Return
error
whenDone
reportProgress
Return
progress
whenDone
reportResult
Return
result
whenDone
Conference
ConferenceEvents
ConferenceError
code
conference
endpointId
error
EndpointAdded
conference
direction
endpoint
endpointId
mode
EndpointRemoved
conference
direction
endpoint
endpointId
mode
Started
conference
Stopped
conference
cost
duration
Conference
add
addEventListener
get
getList
removeEventListener
sendMediaTo
stop
stopMediaTo
Endpoint
getDirection
getMode
id
setDisplayName
EndpointOptions
call
direction
displayName
mode
scheme
VoxEngine.createConference
Return
params
IVR
IVRPrompt
lang
play
say
IVRSettings
inputLength
inputValidator
nextState
nextStates
prompt
terminateOn
timeout
type
IVRState
enter
input
settings
reset
Return
Player
PlayerEvents
PlaybackFinished
error
player
PlaybackMarkerReached
offset
player
PlaybackReady
player
Started
player
Stopped
player
Player
addEventListener
addMarker
pause
removeEventListener
resume
sendMediaTo
stop
stopMediaTo
VoxEngine.createTTSPlayer
Return
language
text
ttsoptions
VoxEngine.createToneScriptPlayer
Return
loop
script
VoxEngine.createURLPlayer
Return
loop
onPause
url
Recorder
RecorderEvents
RecorderError
error
recorder
Started
recorder
url
Stopped
cost
duration
recorder
Recorder
addEventListener
mute
removeEventListener
stop
VoxEngine.createRecorder
Return
options
Events
AppEvents
CallAlerting
HttpRequest
Started
Terminated
Terminating
CallEvents
AudioStarted
Connected
Disconnected
Failed
FirstVideoPacket
InfoReceived
MessageReceived
MicStatusChange
OffHold
OnHold
PlaybackFinished
PlaybackReady
ReInviteAccepted
ReInviteReceived
ReInviteRejected
RecordError
RecordStarted
RecordStopped
Ringing
Statistics
ToneDetected
ToneReceived
TransferComplete
VideoTrackCreated
VoicemailToneDetected
VoicemailToneNotDetected
Classes
Call
addEventListener
answer
callerid
customData
decline
detectProgressTone
detectVoicemailTone
displayName
handleMicStatus
handleTones
hangup
id
incoming
number
playProgressTone
record
reject
removeEventListener
ring
say
sendDigits
sendInfo
sendMediaTo
sendMessage
startEarlyMedia
startPlayback
state
stopMediaTo
stopPlayback
toString
vad
HTTP API
Tutorials
HTTP API callbacks
Auth parameters
Structures
ACDLock
ACDLockedOperatorStateType
ACDOperatorAggregationGroupType
ACDOperatorCall
ACDOperatorStatisticsType
ACDQueueOperatorInfoType
ACDQueueStateType
ACDQueueStatisticsServiceLevelType
ACDQueueStatisticsType
ACDReadyOperatorStateType
ACDServicingCallStateType
ACDSessionEventInfoType
ACDSessionInfoType
ACDStateType
ACDStatisticsItemType
ACDWaitingCallStateType
API_Error
AccountCallback
AccountCallbacks
AccountDocumentUploadedCallback
AccountDocumentVerifiedCallback
AccountInfoType
AccountIsFrozenCallback
AccountIsUnfrozenCallback
AccountVerificationDocument
AccountVerificationType
AccountVerifications
ActivateSuccessfulCallback
AdminRoleType
AdminUserType
ApplicationInfoType
AttachedPhoneInfoType
AuditLogInfoType
AuthorizedAccountIPType
BankCardErrorType
BankCardType
CalculatedCallHistoryDataType
CalculatedTransactionHistoryDataType
CallHistoryReportCallback
CallInfoType
CallListDetailType
CallListType
CallSessionInfoType
CallerIDInfoType
CardExpiredCallback
CardExpiresInMonthCallback
CardPaymentCallback
CardPaymentFailedCallback
ChargeAccountResult
ChargedPhoneType
ClonedACDQueueType
ClonedACDSkillType
ClonedAccountType
ClonedAdminRoleType
ClonedAdminUserType
ClonedApplicationType
ClonedRuleType
ClonedScenarioType
ClonedUserType
ContactInfoType
ContractInfoType
ContractorInfoType
ContractorInvoiceServiceType
ContractorInvoiceType
DialogflowKey
DialogflowKeyInfo
ExchangeRates
GetMoneyAmountToChargeResult
HistoryReportType
InboundSmsCallback
InboundSmsCallbackItem
JSFailCallback
MinBalanceCallback
NewAttachedPhoneInfoType
NewPhoneInfoType
PhoneNumberCountryCategoryInfoType
PhoneNumberCountryInfoType
PhoneNumberCountryRegionInfoType
PhoneNumberCountryStateInfoType
PriceGroup
PstnBlackListInfoType
PushCredentialContent
PushCredentialInfo
RecordType
RegulationAddress
RegulationAddressUploadedCallback
RegulationAddressVerifiedCallback
RegulationCountry
RegulationRegionRecord
RenewedSubscriptionsCallback
RenewedSubscriptionsCallbackItem
ResetAccountPasswordRequestCallback
ResourceParams
ResourcePrice
ResourceUsageType
RobokassaPaymentCallback
RuleInfoType
SIPRegistrationFailCallback
SIPRegistrationType
ScenarioInfoType
ShortAccountInfoType
SipWhiteListInfoType
SkillInfoType
StagnantAccountCallback
SubscriptionIsDetachedCallback
SubscriptionIsDetachedCallbackItem
SubscriptionIsFrozenCallback
SubscriptionIsFrozenCallbackItem
SubscriptionTemplateType
SubscriptionsToChargeType
TransactionHistoryReportCallback
TransactionInfoType
TranscriptionCompleteCallback
TranscriptionCompleteCallbackItem
UnchargedTariffCallback
UnverifiedSubscriptionDetachedCallback
UnverifiedSubscriptionDetachedCallbackItem
UserInfoType
WireTransferCallback
ZipCode
Account's authentication
Logon
Parameters
auth parameters
Request examples
Response examples
Returns
account_email
account_id
account_name
api_address
api_key
balance
credit_limit
frozen
result
Logout
Parameters
account_id
session_id
Request examples
Response examples
Returns
result
Managing Accounts
AddAccount
Parameters
account_custom_data
account_email
account_first_name
account_last_name
account_name
account_notifications
account_password
active
credit_limit
currency
init_balance
is_trial
language_code
location
min_balance_to_notify
news_notifications
parent_account_api_key
parent_account_email
parent_account_id
parent_account_name
parent_account_password
session_id
tariff_changing_notifications
tariff_id
Request examples
Response examples
Returns
account_id
active
api_key
result
ChargeAccount
Parameters
auth parameters
phone_id
phone_number
Request examples
Response examples
Returns
account_info
result
CloneAccount
Parameters
account_custom_data
account_email
account_first_name
account_id
account_last_name
account_name
api_key
language_code
location
new_account_email
new_account_name
new_account_password
parent_account_api_key
parent_account_password
session_id
Request examples
Response examples
Returns
result
ConfirmAccountPasswordChange
Parameters
account_email
account_id
account_name
code
new_account_password
Request examples
Response examples
Returns
result
GetAccountDocuments
Parameters
auth parameters
child_account_id
children_verifications_only
from_unverified_hold_until
to_unverified_hold_until
verification_name
verification_status
with_details
Request examples
Response examples
Returns
result
GetAccountInfo
Parameters
auth parameters
return_live_balance
Returns
api_address
result
GetChildrenAccounts
Parameters
active
auth parameters
brief_output
child_account_email
child_account_id
child_account_name
count
frozen
ignore_invalid_accounts
medium_output
offset
order_by
return_live_balance
Request examples
Returns
count
result
total_count
GetCurrencyRate
Parameters
currency
date
Request examples
Response examples
Returns
result
GetMoneyAmountToCharge
Parameters
auth parameters
charge_date
currency
Request examples
Response examples
Returns
result
GetResourcePrice
Parameters
auth parameters
price_group_id
price_group_name
resource_param
resource_type
Request examples
Response examples
Returns
result
GetSubscriptionPrice
Parameters
auth parameters
count
offset
subscription_template_id
subscription_template_name
subscription_template_type
Request examples
Response examples
Returns
result
SendAccountPasswordChangeRequest
Parameters
account_email
api_key
confirm_url
Request examples
Response examples
Returns
result
SetAccountDocument
Parameters
account_document
auth parameters
individual_birth_date
individual_full_name
individual_passport_issue_date
individual_passport_issued_by
individual_passport_number
individual_passport_series
individual_registration_address
inn
is_individual
legal_entry_actual_address
legal_entry_address
legal_entry_full_name
legal_entry_phone
ogrn
verification_name
Request examples
Response examples
Returns
account_document_id
result
SetAccountInfo
Parameters
account_custom_data
account_first_name
account_last_name
account_notifications
auth parameters
billing_address_address
billing_address_country_code
billing_address_name
billing_address_phone
billing_address_zip
callback_salt
callback_url
language_code
location
min_balance_to_notify
mobile_phone
new_account_email
new_account_password
news_notifications
send_js_error
tariff_changing_notifications
Request examples
Response examples
Returns
result
SetChildAccountInfo
Parameters
account_notifications
active
auth parameters
can_use_restricted
child_account_email
child_account_id
child_account_name
language_code
location
min_balance_to_notify
new_child_account_email
new_child_account_password
news_notifications
support_bank_card
support_invoice
support_robokassa
tariff_changing_notifications
Request examples
Response examples
Returns
result
TransferMoneyToChildAccount
Parameters
amount
auth parameters
check_duplicate_reference_from
child_account_id
child_transaction_description
currency
parent_transaction_description
payment_reference
strict_mode
Request examples
Response examples
Returns
balance
result
Managing Admin Roles
AddAdminRole
Parameters
admin_role_active
admin_role_name
allowed_entries
auth parameters
denied_entries
like_admin_role_id
like_admin_role_name
Request examples
Response examples
Returns
admin_role_id
result
DelAdminRole
Parameters
admin_role_id
admin_role_name
auth parameters
Request examples
Response examples
Returns
result
GetAdminRoles
Parameters
admin_role_active
admin_role_id
admin_role_name
auth parameters
count
excluded_admin_user_id
full_admin_users_matching
included_admin_user_id
offset
showing_admin_user_id
with_account_roles
with_entries
with_parent_roles
with_system_roles
Request examples
Response examples
Returns
count
result
total_count
GetAvailableAdminRoleEntries
Parameters
auth parameters
Request examples
Response examples
Returns
result
SetAdminRoleInfo
Parameters
admin_role_active
admin_role_id
admin_role_name
allowed_entries
auth parameters
denied_entries
entry_modification_mode
like_admin_role_id
like_admin_role_name
new_admin_role_name
Request examples
Response examples
Returns
result
Managing Admin Users
AddAdminUser
Parameters
admin_role_id
admin_role_name
admin_user_active
admin_user_display_name
auth parameters
new_admin_user_name
new_admin_user_password
Request examples
Response examples
Returns
admin_user_api_key
admin_user_id
result
AttachAdminRole
Parameters
admin_role_id
admin_role_name
auth parameters
mode
required_admin_user_id
required_admin_user_name
Request examples
Response examples
Returns
result
DelAdminUser
Parameters
auth parameters
required_admin_user_id
required_admin_user_name
Request examples
Response examples
Returns
result
GetAdminUsers
Parameters
admin_user_active
admin_user_display_name
auth parameters
count
offset
required_admin_user_id
required_admin_user_name
with_access_entries
with_roles
Request examples
Response examples
Returns
count
result
total_count
SetAdminUserInfo
Parameters
admin_user_active
admin_user_display_name
auth parameters
new_admin_user_name
new_admin_user_password
required_admin_user_id
required_admin_user_name
Request examples
Response examples
Returns
result
Managing Applications
AddApplication
Parameters
application_name
auth parameters
Request examples
Response examples
Returns
application_id
application_name
result
DelApplication
Parameters
application_id
application_name
auth parameters
Request examples
Response examples
Returns
result
GetApplications
Parameters
application_id
application_name
auth parameters
count
excluded_user_id
offset
showing_user_id
user_id
with_rules
with_scenarios
Request examples
Response examples
Returns
count
result
total_count
SetApplicationInfo
Parameters
application_id
application_name
auth parameters
required_application_name
Request examples
Response examples
Returns
application_name
result
Managing Authorized IPs
AddAuthorizedAccountIP
Parameters
allowed
authorized_ip
auth parameters
Request examples
Response examples
Returns
result
CheckAuthorizedAccountIP
Parameters
authorized_ip
auth parameters
Request examples
Response examples
Returns
authorized_ip
result
DelAuthorizedAccountIP
Parameters
allowed
authorized_ip
auth parameters
contains_ip
Request examples
Response examples
Returns
result
GetAuthorizedAccountIPs
Parameters
allowed
authorized_ip
auth parameters
contains_ip
count
offset
Request examples
Response examples
Returns
count
result
total_count
Managing Call Lists
AppendToCallList
Parameters
auth parameters
delimiter
encoding
file_content
list_id
list_name
Request examples
Response examples
Returns
count
list_id
result
CreateCallList
Parameters
auth parameters
avg_waiting_sec
delimiter
encoding
file_content
interval_seconds
max_simultaneous
name
num_attempts
priority
queue_id
reference_ip
rule_id
Request examples
Response examples
Returns
count
list_id
result
CreateManualCallList
Parameters
auth parameters
delimiter
encoding
file_content
interval_seconds
max_simultaneous
name
num_attempts
priority
reference_ip
rule_id
Request examples
Response examples
Returns
count
list_id
result
GetCallListDetails
Parameters
auth parameters
count
delimiter
encoding
list_id
offset
output
Request examples
Response examples
Returns
count
result
GetCallLists
Parameters
auth parameters
count
from_date
is_active
name
offset
to_date
type_list
Request examples
Response examples
Returns
count
result
total_count
RecoverCallList
Parameters
auth parameters
list_id
Request examples
Response examples
Returns
count_recovery
result
StartNextCallTask
Parameters
auth parameters
custom_params
list_id
Request examples
Response examples
Returns
list_id
result
StopCallListProcessing
Parameters
auth parameters
list_id
Request examples
Response examples
Returns
msg
result
Managing Dialogflow credentials
AddDialogflowKey
Parameters
auth parameters
external_app_name
json_credentials
Request examples
Response examples
Returns
dialogflow_key_id
result
BindDialogflowKeys
Parameters
application_id
auth parameters
bind
dialogflow_key_id
Request examples
Response examples
Returns
result
DelDialogflowKey
Parameters
auth parameters
dialogflow_key_id
Request examples
Response examples
Returns
result
GetDialogflowKeys
Parameters
application_id
application_name
auth parameters
dialogflow_key_id
external_app
with_secret_info
Request examples
Response examples
Returns
result
Managing History
DeleteRecord
Parameters
auth parameters
record_id
record_url
Request examples
Response examples
Returns
result
DownloadHistoryReport
Parameters
auth parameters
history_report_id
Request examples
Returns
unknown
GetACDHistory
Parameters
acd_queue_id
acd_request_id
acd_session_history_id
auth parameters
count
desc_order
from_date
min_waiting_time
offset
operator_hangup
output
rejected
to_date
unserviced
user_id
with_events
with_header
Request examples
Response examples
Returns
count
result
total_count
GetAuditLog
Parameters
advanced_filters
audit_log_id
auth parameters
count
desc_order
filtered_admin_user_id
filtered_cmd
filtered_ip
from_date
is_async
offset
output
timezone
to_date
with_header
with_total_count
Request examples
Response examples
Returns
count
history_report_id
result
timezone
total_count
GetCallHistory
Parameters
application_id
application_name
auth parameters
call_session_history_custom_data
call_session_history_id
child_account_id
children_calls_only
count
desc_order
from_date
is_async
local_number
offset
output
remote_number
rule_name
timezone
to_date
user_id
with_calls
with_header
with_other_resources
with_records
with_total_count
Request examples
Response examples
Returns
count
history_report_id
result
timezone
total_count
GetHistoryReports
Parameters
auth parameters
count
created_from
created_to
desc_order
history_report_id
history_type
is_completed
offset
Request examples
Response examples
Returns
count
result
total_count
GetTransactionHistory
Parameters
auth parameters
child_account_id
children_transactions_only
count
desc_order
from_date
is_async
offset
output
payment_reference
timezone
to_date
transaction_id
transaction_type
user_id
users_transactions_only
Request examples
Response examples
Returns
count
end_balance
history_report_id
result
start_balance
timezone
total_count
Managing PSTN blacklist
AddPstnBlackListItem
Parameters
auth parameters
pstn_blacklist_phone
Request examples
Response examples
Returns
pstn_blacklist_id
result
DelPstnBlackListItem
Parameters
auth parameters
pstn_blacklist_id
Request examples
Response examples
Returns
result
GetPstnBlackList
Parameters
auth parameters
count
offset
pstn_blacklist_id
pstn_blacklist_phone
Request examples
Response examples
Returns
count
result
total_count
SetPstnBlackListItem
Parameters
auth parameters
pstn_blacklist_id
pstn_blacklist_phone
Request examples
Response examples
Returns
result
Managing Phone Numbers
AttachPhoneNumber
Parameters
auth parameters
country_code
country_state
force_verification
phone_category_name
phone_count
phone_number
phone_region_id
regulation_address_id
Request examples
Response examples
Returns
phone_numbers
result
BindPhoneNumberToApplication
Parameters
application_id
application_name
auth parameters
bind
phone_id
phone_number
rule_id
rule_name
Request examples
Response examples
Returns
result
DeactivatePhoneNumber
Parameters
auth parameters
phone_id
phone_number
Request examples
Response examples
Returns
result
GetActualPhoneNumberRegion
Parameters
auth parameters
country_code
phone_category_name
phone_region_id
Request examples
Response examples
Returns
result
GetNewPhoneNumbers
Parameters
auth parameters
count
country_code
country_state
offset
phone_category_name
phone_region_id
Request examples
Response examples
Returns
count
result
total_count
GetPhoneNumberCategories
Parameters
auth parameters
country_code
sandbox
Request examples
Response examples
Returns
result
GetPhoneNumberCountryStates
Parameters
auth parameters
country_code
country_state
phone_category_name
Request examples
Response examples
Returns
result
GetPhoneNumberRegions
Parameters
auth parameters
country_code
country_state
omit_empty
phone_category_name
phone_region_code
phone_region_id
phone_region_name
Request examples
Response examples
Returns
result
GetPhoneNumbers
Parameters
application_id
application_name
auth parameters
auto_charge
can_be_used
canceled
child_account_id
children_phones_only
count
country_code
deactivated
from_phone_next_renewal
from_phone_purchase_date
from_unverified_hold_until
is_bound_to_application
offset
order_by
phone_category_name
phone_id
phone_template
sandbox
sms_supported
to_phone_next_renewal
to_phone_purchase_date
to_unverified_hold_until
verification_name
verification_status
Request examples
Response examples
Returns
count
result
total_count
SetPhoneNumberInfo
Parameters
auth parameters
auto_charge
phone_id
phone_number
Request examples
Response examples
Returns
result
Managing Queues
AddQueue
Parameters
acd_queue_name
acd_queue_priority
application_id
application_name
auth parameters
auto_binding
average_service_time
max_queue_size
max_waiting_time
service_probability
Request examples
Response examples
Returns
acd_queue_id
result
DelQueue
Parameters
acd_queue_id
acd_queue_name
auth parameters
Request examples
Response examples
Returns
result
GetACDOperatorStatistics
Parameters
abbreviation
acd_queue_id
aggregation
auth parameters
from_date
group
report
to_date
user_id
Request examples
Returns
result
GetACDQueueStatistics
Parameters
abbreviation
acd_queue_id
aggregation
auth parameters
from_date
report
to_date
Request examples
Returns
result
GetACDState
Parameters
acd_queue_id
auth parameters
Request examples
Response examples
Returns
result
GetQueues
Parameters
acd_queue_id
acd_queue_name
application_id
auth parameters
count
excluded_skill_id
offset
showing_skill_id
skill_id
with_skills
Request examples
Response examples
Returns
count
result
total_count
SetQueueInfo
Parameters
acd_queue_id
acd_queue_name
acd_queue_priority
application_id
auth parameters
auto_binding
average_service_time
max_queue_size
max_waiting_time
new_acd_queue_name
service_probability
Request examples
Response examples
Returns
result
Managing Rules
AddRule
Parameters
application_id
application_name
auth parameters
rule_name
rule_pattern
rule_pattern_exclude
scenario_id
scenario_name
video_conference
Request examples
Response examples
Returns
result
rule_id
DelRule
Parameters
application_id
application_name
auth parameters
rule_id
rule_name
Request examples
Response examples
Returns
result
GetRules
Parameters
application_id
application_name
auth parameters
count
offset
rule_id
rule_name
template
video_conference
with_scenarios
Request examples
Response examples
Returns
count
result
total_count
ReorderRules
Parameters
auth parameters
rule_id
Request examples
Response examples
Returns
result
SetRuleInfo
Parameters
auth parameters
rule_id
rule_name
rule_pattern
rule_pattern_exclude
video_conference
Request examples
Response examples
Returns
result
Managing SIP Registration
BindSipRegistration
Parameters
application_id
application_name
auth parameters
bind
rule_id
rule_name
sip_registration_id
user_id
user_name
Request examples
Response examples
Returns
result
CreateSipRegistration
Parameters
application_id
application_name
auth_user
auth parameters
is_persistent
outbound_proxy
password
proxy
rule_id
rule_name
sip_username
user_id
user_name
Request examples
Response examples
Returns
account_info
result
sip_registration_id
DeleteSipRegistration
Parameters
auth parameters
sip_registration_id
Request examples
Response examples
Returns
result
GetSipRegistrations
Parameters
application_id
application_name
auth parameters
deactivated
is_persistent
rule_id
rule_name
sip_registration_id
sip_username
successful
user_id
user_name
Request examples
Response examples
Returns
count
result
UpdateSipRegistration
Parameters
application_id
application_name
auth_user
auth parameters
outbound_proxy
password
proxy
rule_id
rule_name
sip_registration_id
sip_username
user_id
user_name
Request examples
Response examples
Returns
result
Managing SIP white list
AddSipWhiteListItem
Parameters
auth parameters
sip_whitelist_network
Request examples
Response examples
Returns
result
sip_whitelist_id
DelSipWhiteListItem
Parameters
account_id
api_key
sip_whitelist_id
Request examples
Response examples
Returns
result
GetSipWhiteList
Parameters
auth parameters
count
offset
sip_whitelist_id
Request examples
Response examples
Returns
count
result
total_count
SetSipWhiteListItem
Parameters
auth parameters
sip_whitelist_id
sip_whitelist_network
Request examples
Response examples
Returns
result
Managing SMS
ControlSms
Parameters
command
phone_number
Request examples
Response examples
Returns
result
SendSmsMessage
Parameters
destination
sms_body
source
Request examples
Response examples
Returns
fragments_count
result
Managing Scenarios
AddScenario
Parameters
auth parameters
rewrite
scenario_name
scenario_script
Request examples
Response examples
Returns
result
scenario_id
BindScenario
Parameters
application_id
application_name
auth parameters
bind
rule_id
rule_name
scenario_id
scenario_name
Request examples
Response examples
Returns
result
DelScenario
Parameters
auth parameters
scenario_id
Request examples
Response examples
Returns
result
GetScenarios
Parameters
auth parameters
count
offset
scenario_id
with_script
Request examples
Response examples
Returns
count
result
total_count
ReorderScenarios
Parameters
auth parameters
rule_id
rule_name
scenario_id
Request examples
Response examples
Returns
result
SetScenarioInfo
Parameters
auth parameters
required_scenario_name
scenario_id
scenario_name
scenario_script
Request examples
Response examples
Returns
result
StartConference
Parameters
auth parameters
conference_name
reference_ip
rule_id
script_custom_data
user_id
user_name
Request examples
Response examples
Returns
media_session_access_secure_url
media_session_access_url
result
StartScenarios
Parameters
auth parameters
reference_ip
rule_id
script_custom_data
user_id
user_name
with_check_url
Request examples
Response examples
Returns
media_session_access_secure_url
media_session_access_url
result
Managing Skills
AddSkill
Parameters
auth parameters
skill_name
Request examples
Response examples
Returns
result
skill_id
BindSkill
Parameters
acd_queue_id
acd_queue_name
auth parameters
bind
skill_id
skill_name
user_id
user_name
Request examples
Response examples
Returns
result
DelSkill
Parameters
auth parameters
skill_id
skill_name
Request examples
Response examples
Returns
result
GetSkills
Parameters
auth parameters
count
offset
skill_id
skill_name
Request examples
Response examples
Returns
count
result
total_count
SetSkillInfo
Parameters
auth parameters
new_skill_name
skill_id
skill_name
Request examples
Response examples
Returns
result
Managing Users
AddUser
Parameters
application_id
application_name
auth parameters
mobile_phone
parent_accounting
two_factor_auth_required
user_active
user_custom_data
user_display_name
user_name
user_password
Request examples
Response examples
Returns
result
user_id
BindUser
Parameters
application_id
application_name
auth parameters
bind
user_id
user_name
Request examples
Response examples
Returns
result
DelUser
Parameters
application_id
application_name
auth parameters
user_id
user_name
Request examples
Response examples
Returns
result
GetUsers
Parameters
acd_queue_id
acd_status
application_id
application_name
auth parameters
count
excluded_application_id
excluded_application_name
excluded_skill_id
offset
order_by
return_live_balance
showing_application_id
showing_skill_id
skill_id
user_active
user_display_name
user_id
user_name
with_applications
with_queues
with_skills
Request examples
Response examples
Returns
count
result
total_count
SetUserInfo
Parameters
auth parameters
mobile_phone
new_user_name
parent_accounting
two_factor_auth_required
user_active
user_custom_data
user_display_name
user_id
user_name
user_password
Request examples
Response examples
Returns
result
Managing callerIDs
ActivateCallerID
Parameters
auth parameters
callerid_id
callerid_number
verification_code
Request examples
Response examples
Returns
result
AddCallerID
Parameters
auth parameters
callerid_number
Request examples
Response examples
Returns
callerid_id
result
verification_code_callin
DelCallerID
Parameters
auth parameters
callerid_id
callerid_number
Request examples
Response examples
Returns
result
GetCallerIDs
Parameters
active
auth parameters
callerid_id
callerid_number
count
offset
order_by
Request examples
Response examples
Returns
count
result
total_count
VerifyCallerID
Parameters
auth parameters
callerid_id
callerid_number
Request examples
Response examples
Returns
result
Managing push credentials
AddPushCredential
Parameters
auth parameters
cert_content
cert_file_name
cert_password
credential_bundle
external_app_name
is_dev_mode
push_provider_id
push_provider_name
sender_id
server_key
Request examples
Response examples
Returns
push_credential_id
result
BindPushCredential
Parameters
application_id
auth parameters
bind
push_credential_id
Request examples
Response examples
Returns
result
DelPushCredential
Parameters
auth parameters
push_credential_id
Request examples
Response examples
Returns
result
GetPushCredential
Parameters
application_id
application_name
auth parameters
external_app
push_credential_id
push_provider_id
push_provider_name
with_cert
with_secret_info
Request examples
Response examples
Returns
result
SetPushCredential
Parameters
auth parameters
cert_content
cert_password
external_app_name
is_dev_mode
push_credential_id
sender_id
server_key
Request examples
Response examples
Returns
result
Managing regulation address
CreateRegulationAddress
Parameters
auth parameters
destination_country_code
phone_category_name
phone_owner_building_letter
phone_owner_building_number
phone_owner_city
phone_owner_company
phone_owner_country_code
phone_owner_first_name
phone_owner_last_name
phone_owner_salutation
phone_owner_street
phone_owner_zip_code
phone_region_code
proof
Request examples
Response examples
Returns
regulation_address_id
result
GetAvailableRegulations
Parameters
auth parameters
country_code
phone_category_name
phone_region_code
Request examples
Response examples
Returns
available_address
count_in_progress
result
GetCountries
Parameters
auth parameters
country_code
Request examples
Response examples
Returns
count
result
GetRegions
Parameters
auth parameters
city_name
count
country_code
offset
phone_category_name
Request examples
Response examples
Returns
count
result
GetRegulationsAddress
Parameters
auth parameters
country_code
in_progress
phone_category_name
phone_region_code
regulation_address_id
verification_id
verified
with_region_code
Request examples
Response examples
Returns
count
result
GetZIPCodes
Parameters
auth parameters
count
country_code
offset
phone_region_code
Request examples
Response examples
Returns
count
result
LinkregulationAddress
Parameters
auth parameters
phone_id
phone_number
regulation_address_id
Request examples
Response examples
Returns
result
UploadProofOfAddress
Parameters
auth parameters
proof
regulation_address_id
Request examples
Response examples
Returns
result
Errors
Web SDK
Tutorials
Quickstart
Changelog
Voximplant
EventHandlers
AuthResult
code
displayName
key
result
tokens
AuthTokenResult
code
result
tokens
CallEvent
call
CallEventWithHeaders
call
headers
ConnectionFailed
message
Disconnected
call
headers
params
EndpointHandler
call
endpoint
EndpointMediaHandler
call
endpoint
mediaRenderer
Failed
call
code
headers
reason
IncomingCall
call
headers
video
InfoReceived
body
call
headers
mimeType
MediaElementCreated
call
element
type
MessageReceived
call
text
MicAccessResult
result
stream
NetStatsReceived
stats
SDKReady
version
SIPRegistrationResult
id
reason
sipuri
status
Updated
call
result
Hardware
AudioDeviceManager
get
getCallAudioSettings
getDefaultAudioSettings
getInputDevices
getOutputDevices
prepareAudioContext
setCallAudioSettings
setDefaultAudioSettings
CameraManager
get
getCallVideoSettings
getDefaultVideoSettings
getInputDevices
loadResolutionTestResult
setCallVideoSettings
setDefaultVideoSettings
testResolutions
StreamManager
get
getLocalMediaRenderers
hideLocalVideo
off
on
showLocalVideo
AudioParams
autoGainControl
echoCancellation
inputId
noiseSuppression
outputId
strict
CameraParams
cameraId
facingMode
frameHeight
frameRate
frameWidth
strict
videoQuality
HardwareEvents
VideoQuality
Messaging
MessengerEventsCallbacks
ConversationEvent
conversation
messengerAction
messengerEventType
sequence
userId
ConversationServiceEvent
conversationUUID
messengerAction
messengerEventType
sequence
timestamp
userId
ErrorEvent
code
description
messengerAction
messengerEventType
userId
MessageEvent
message
messengerAction
messengerEventType
sequence
userId
MessengerEvent
messengerAction
messengerEventType
userId
RetransmitEvent
events
messengerAction
messengerEventType
userId
StatusEvent
messengerAction
messengerEventType
userId
userStatus
SubscriptionEvent
messengerAction
messengerEventType
userId
users
UserEvent
messengerAction
messengerEventType
user
userId
Conversation
addModerators
addParticipants
editParticipants
markAsDelivered
markAsRead
remove
removeModerators
removeParticipants
retransmitEvents
sendMessage
setCustomData
setDistinct
setPublicJoin
setTitle
toCache
typing
update
createdAt
customData
distinct
lastRead
lastSeq
lastUpdate
moderators
participants
publicJoin
title
uuid
Message
remove
toCache
update
conversation
payload
sender
seq
text
uuid
Messenger
createConversation
createConversationFromCache
createMessageFromCache
editUser
getConversation
getConversations
getMe
getUser
getUsers
joinConversation
leaveConversation
off
on
removeConversation
setStatus
subscribe
unsubscribe
ConversationParticipant
canManageParticipants
canWrite
userId
RetransmittedEvent
conversation
message
name
onIncomingEvent
seq
userId
SerializedConversation
createdAt
customData
distinct
lastRead
lastUpdate
moderators
participants
publicJoin
seq
title
uberConversation
uuid
SerializedMessage
conversation
payload
sender
seq
text
uuid
User
conversationsList
customData
privateCustomData
userId
UserStatus
online
timestamp
userId
MessengerAction
MessengerError
MessengerEvents
Call
active
answer
decline
displayName
getCallDuration
getEndpoints
hangup
headers
id
muteMicrophone
mutePlayback
number
off
on
reject
sendInfo
sendMessage
sendTone
sendVideo
setActive
shareScreen
state
stopSharingScreen
unmuteMicrophone
unmutePlayback
rearangeCodecs
Client
call
callConference
clearSilentLog
config
connect
connected
disconnect
enableSilentLogging
getClientState
getOperatorACDStatus
getSilentLog
init
isRTCsupported
login
loginWithOneTimeKey
loginWithToken
off
on
playToneScript
requestOneTimeLoginKey
screenSharingSupported
setLoggerCallback
setOperatorACDStatus
setVideoBandwidth
showLocalVideo
stopPlayback
tokenRefresh
transferCall
Endpoint
off
on
useAudioOutput
displayName
id
mediaRenderers
sipUri
userName
MediaRenderer
render
setVolume
useAudioOutput
element
id
isLocal
kind
stream
AudioParams
autoGainControl
echoCancellation
inputId
noiseSuppression
outputId
strict
AudioSourceInfo
group
id
name
CallSettings
H264first
customData
extraHeaders
number
video
CallstatsIoParams
AppID
AppSecret
applicationVersion
disableBeforeUnloadHandler
CodecSorterUserCodecList
sections
CodecSorterUserSections
codec
kind
Config
H264first
callstatsIoParams
localVideoContainerId
micRequired
progressTone
progressToneCountry
remoteVideoContainerId
rtcStatsCollectionInterval
serverIp
showDebugInfo
showWarnings
videoConstraints
videoContainerId
DisconnectingFlags
answeredElsewhere
LogRecord
category
formattedText
label
level
message
LoginOptions
receiveCalls
LoginTokens
accessExpire
accessToken
refreshExpire
refreshToken
VideoFlags
receiveVideo
sendVideo
VideoSourceInfo
group
id
name
getInstance
getMessenger
version
CallEvents
ClientState
EndpointEvents
Events
OperatorACDStatuses
Android SDK
Tutorials
Push Notifications
Using Android SDK
Changelog
Legacy API
VoxImplantClient
VoxImplantClientConfig
enableDebugLogging
enableHWAcceleration
enableVideo
packageName
provideLocalFramesInByteBuffers
answerCall
closeConnection
connect
createCall
declineCall
disconnectCall
getMissingPermissions
handlePushNotification
instance
login
loginUsingAccessToken
loginUsingOneTimeKey
refreshToken
registerForPushNotifications
requestOneTimeKey
sendDTMF
sendInfo
sendMessage
sendVideo
setAndroidContext
setCallback
setCamera
setCameraResolution
setLocalPreview
setMute
setRemoteView
setUseLoudspeaker
startCall
unregisterFromPushNotifications
VoxImplantCallback
LoginTokens
getAccessToken
getAccessTokenTimeExpired
getRefreshToken
getRefreshTokenTimeExpired
NetworkInfo
packetLoss
onCallAudioStarted
onCallConnected
onCallDisconnected
onCallFailed
onCallRinging
onConnectionClosed
onConnectionFailedWithError
onConnectionSuccessful
onIncomingCall
onLoginFailed
onLoginSuccessful
onMessageReceivedInCall
onNetStatsReceived
onOneTimeKeyGenerated
onRefreshTokenFailed
onRefreshTokenSuccess
onSIPInfoReceivedInCall
LoginFailureReason
com.voximplant.sdk
call
CallException
getErrorCode
CallStats
toString
audioBytesReceived
audioBytesSent
audioLoss
audioPacketsLost
audioPacketsReceived
audioPacketsSent
availableOutgoingBitrate
endpointStats
localAudioStats
localVideoStats
timestamp
totalBytesReceived
totalBytesSent
totalLoss
totalPacketsLost
totalPacketsReceived
totalPacketsSent
videoBytesReceived
videoBytesSent
videoLoss
videoPacketsLost
videoPacketsReceived
videoPacketsSent
EndpointStats
toString
audioBytesReceived
audioPacketsLost
audioPacketsReceived
remoteAudioStats
remoteVideoStats
timestamp
totalBytesReceived
totalPacketsReceived
videoBytesReceived
videoPacketsLost
videoPacketsReceived
InboundAudioStats
toString
bytesReceived
codec
loss
packetsLost
packetsReceived
timestamp
InboundVideoStats
toString
bytesReceived
codec
frameHeight
frameWidth
loss
packetsLost
packetsReceived
timestamp
OutboundAudioStats
toString
bytesSent
codec
packetsSent
timestamp
OutboundVideoStats
toString
bytesSent
codec
frameHeight
frameWidth
packetsSent
timestamp
VideoFlags
receiveVideo
sendVideo
IAudioStream
getAudioStreamId
ICall
addCallListener
answer
getCallDuration
getCallId
getEndpoints
getLocalAudioStreams
getLocalVideoStreams
hangup
hold
isVideoEnabled
receiveVideo
reject
removeCallListener
sendAudio
sendDTMF
sendInfo
sendMessage
sendVideo
start
useCustomVideoSource
ICallCompletionHandler
onComplete
onFailure
ICallListener
onCallAudioStarted
onCallConnected
onCallDisconnected
onCallFailed
onCallRinging
onCallStatsReceived
onEndpointAdded
onICECompleted
onICETimeout
onLocalVideoStreamAdded
onLocalVideoStreamRemoved
onMessageReceived
onSIPInfoReceived
IEndpoint
getAudioStreams
getEndpointId
getSipUri
getUserDisplayName
getUserName
getVideoStreams
setEndpointListener
IEndpointListener
onEndpointInfoUpdated
onEndpointRemoved
onRemoteVideoStreamAdded
onRemoteVideoStreamRemoved
IVideoStream
addVideoRenderer
getVideoStreamId
getVideoStreamType
removeVideoRenderer
CallError
RejectMode
RenderScaleType
VideoStreamType
client
AuthParams
getAccessToken
getAccessTokenTimeExpired
getRefreshToken
getRefreshTokenTimeExpired
ClientConfig
H264first
enableCameraMirroring
enableDebugLogging
enableHWAccelerationForDecoding
enableHWAccelerationForEncoding
enableLogcatLogging
enableVideo
packageName
provideLocalFramesInByteBuffers
statsCollectionInterval
IClient
callConference
callTo
connect
disconnect
getClientState
handlePushNotification
login
loginWithAccessToken
loginWithOneTimeKey
refreshToken
registerForPushNotifications
requestOneTimeKey
setClientIncomingCallListener
setClientLoginListener
setClientSessionListener
unregisterFromPushNotifications
IClientIncomingCallListener
onIncomingCall
IClientLoginListener
onLoginFailed
onLoginSuccessful
onOneTimeKeyGenerated
onRefreshTokenFailed
onRefreshTokenSuccess
IClientSessionListener
onConnectionClosed
onConnectionEstablished
onConnectionFailed
ILogListener
onLogMessage
ClientState
LogLevel
LoginError
hardware
CameraResolution
toString
height
width
IAudioDeviceEventsListener
onAudioDeviceChanged
onAudioDeviceListChanged
IAudioDeviceManager
addAudioDeviceEventsListener
enableLoudspeaker
getActiveDevice
getAudioDevices
removeAudioDeviceEventsListener
selectAudioDevice
setAudioFocusChangeListener
IAudioFocusChangeListener
onAudioFocusChange
ICameraEventsListener
onCameraDisconnected
onCameraError
onCameraSwitchDone
onCameraSwitchError
ICameraManager
addCameraEventsListener
getCameraDeviceNames
getCameraSupportedResolutions
removeCameraEventsListener
setCamera
ICustomVideoSource
release
sendFrame
setCustomVideoSourceListener
ICustomVideoSourceListener
onStarted
onStopped
AudioDevice
VideoQuality
messaging
ConversationConfig
ConversationConfigBuilder
build
setCustomData
setDistinct
setEnablePublicJoin
setModerators
setTitle
setUberConversation
createBuilder
getCustomData
getModerators
getTitle
isDistinct
isEnablePublicJoin
isUberConversation
ConversationParticipant
canManageParticipants
canWrite
getUserId
setCanManageParticipants
setCanWrite
MessengerException
getErrorCode
Payload
getData
getTitle
getType
setData
setTitle
setType
toString
IConversation
addModerators
addParticipants
editParticipants
getCreatedTime
getCustomData
getLastRead
getLastSequence
getLastUpdateTime
getModerators
getParticipants
getTitle
getUUID
isDistinct
isPublicJoin
isUberConversation
markAsDelivered
markAsRead
remove
removeModerators
removeParticipants
retransmitEvents
sendMessage
setCustomData
setDistinct
setPublicJoin
setTitle
typing
update
IConversationEvent
getConversation
getSequence
IConversationServiceEvent
getConversationUUID
getSequence
getTimestamp
IErrorEvent
getMessengerException
IMessage
getConversation
getPayload
getSender
getSequence
getText
getUUID
remove
update
IMessageEvent
getMessage
getSequence
IMessenger
addMessengerListener
createConversation
editUser
getConversation
getConversations
getMe
getUser
getUsers
joinConversation
leaveConversation
managePushNotifications
recreateConversation
recreateMessage
removeConversation
removeMessengerListener
setStatus
subscribe
unSubscribe
IMessengerEvent
getMessengerAction
getMessengerEventType
getUserId
IMessengerListener
isDelivered
isRead
onCreateConversation
onEditConversation
onEditMessage
onEditUser
onError
onGetConversation
onGetUser
onRemoveConversation
onRemoveMessage
onRetransmitEvents
onSendMessage
onSetStatus
onSubscribe
onTyping
onUnsubscribe
IMessengerPushNotificationProcessing
processPushNotification
IRetransmitEvent
getEvents
getFromSequence
getToSequence
IStatusEvent
getUserStatus
ISubscriptionEvent
getUsers
IUser
getConversationsList
getCustomData
getLeaveConversationList
getMessengerNotifications
getPrivateCustomData
getUserId
IUserEvent
getUser
IUserStatus
getTimestamp
isOnline
MessengerAction
MessengerError
MessengerEventType
MessengerNotifications
Voximplant
getAudioDeviceManager
getCameraManager
getClientInstance
getCustomVideoSource
getMessenger
getMessengerPushNotificationProcessing
getMissingPermissions
setLogListener
iOS SDK
Tutorials
Push Notifications
Using iOS SDK
Changelog
Classes
VIAudioDevice
deviceWithType:
initWithType:
type
VIAudioManager
availableAudioDevices
callKitConfigureAudioSession:
callKitReleaseAudioSession
callKitStartAudio
callKitStopAudio
currentAudioDevice
selectAudioDevice:
sharedAudioManager
delegate
useLoudSpeaker
VICall
addDelegate:
answerWithSendVideo:receiveVideo:customData:headers:
duration
hangupWithHeaders:
rejectWithHeaders:
rejectWithMode:headers:
removeDelegate:
sendDTMF:
sendInfo:mimeType:headers:
sendMessage:
setHold:completion:
setSendVideo:completion:
startReceiveVideoWithCompletion:
startWithHeaders:
stopWithHeaders:
callId
endpoints
localVideoStreams
preferredVideoCodec
sendAudio
stat
videoSource
VICallStat
endpoints
localStreams
streams
video
webrtcOriginalReports
VICameraManager
captureDevices
changeCaptureFormat:
setSupportedDeviceOrientationForIPhone:iPad:
sharedCameraManager
supportedFormatsForDevice:
iPadOrientationMask
iPhoneOrientationMask
shouldMirrorFrontCamera
useBackCamera
videoPreprocessDelegate
VIClient
callToUser:withSendVideo:receiveVideo:customData:
clientVersion
connect
connectWithConnectivityCheck:gateways:
disconnect
handlePushNotification:
initWithDelegateQueue:
initWithDelegateQueue:bundleId:
loginWithUser:oneTimeKey:success:failure:
loginWithUser:password:success:failure:
loginWithUser:token:success:failure:
refreshTokenWithUser:token:result:
registerPushNotificationsToken:imToken:
requestOneTimeKeyWithUser:result:
saveLogToFileEnable
setLogLevel:
unregisterPushNotificationsToken:imToken:
webrtcVersion
callManagerDelegate
calls
clientState
messenger
sessionDelegate
VIConversation
addModerators:
addParticipants:
editParticipants:
markAsDelivered:
markAsRead:
remove
removeModerators:
removeParticipants:
retransmitEventsFrom:to:
sendMessage:payload:
typing
update
createdAt
customData
distinct
isUberConversation
lastRead
lastSeq
lastUpdate
moderators
participants
publicJoin
title
uuid
VIConversationEvent
conversation
VIConversationParticipant
initWithUserId:canWrite:canManageParticipants:
canManageParticipants
canWrite
userId
VIConversationServiceEvent
conversationUUID
seq
timestamp
VICustomVideoSource
initWithVideoFormats:
sendVideoFrame:rotation:
delegate
VIEndpoint
call
delegate
endpointId
remoteVideoStreams
sipURI
stat
user
userDisplayName
VIEndpointStat
remoteStreams
VIErrorEvent
code
descr
VIMessage
remove
update
conversation
payload
sender
seq
text
uuid
VIMessageEvent
message
VIMessenger
addDelegate:
createConversation:moderators:title:distinct:enablePublicJoin:customData:uberConversation:
editUserWithCustomData:privateCustomData:
getConversation:
getConversations:
getMe
getUser:
getUsers:
joinConversation:
leaveConversation:
managePushNotifications:
recreateConversation:title:distinct:enablePublicJoin:customData:uuid:sequence:moderators:lastUpdate:lastRead:createdAt:uberConversation:
recreateMessage:conversation:sender:text:payload:sequence:
removeConversation:
removeDelegate:
setStatus:
subscribe:
unsubscribe:
VIMessengerEvent
eventType
incomingAction
userId
VIMessengerEventSeq
seq
VIMessengerPushNotificationProcessing
processPushNotification:
sharedMessengerPushNotificationProcessing
VIPayload
initWithTitle:type:dataArray:
initWithTitle:type:dataDictionary:
initWithTitle:type:dataString:
data
title
type
VIRetransmitEvent
events
fromSequence
toSequence
VIStreamStat
bytes
codec
dir
jitterBufferMs
jitterMs
packetLossCurrentPercents
packetLossPercents
packets
packetsLost
streamId
type
videoFps
videoFrame
VISubscribeEvent
users
VIUser
conversationList
customData
leaveConversationList
notifications
privateCustomData
userId
VIUserEvent
user
VIUserStatusEvent
online
timestamp
VIVideoFormat
initWithFrame:fps:
initWithFrame:interval:
frame
interval
VIVideoRendererView
initWithContainerView:
resizeMode
VIVideoStat
availableSendBandwidth
retransmitBitrate
transmitBitrate
VIVideoStream
addRenderer:
removeAllRenderers
removeRenderer:
renderers
stat
streamId
VoxImplant
answerCall:withCustomData:headers:
attachAudioTo:
closeConnection
connect
connect:
connectTo:
createCall:withVideo:andCustomData:
declineCall:withHeaders:
disableTLS
disconnectCall:withHeaders:
getCallDuration:
getInstance
getInstanceWithBundleId:
getVideoResizeMode
getVoxDelegate
handlePushNotification:
hasFrontFacingCamera
loginWithUsername:andOneTimeKey:
loginWithUsername:andPassword:
loginWithUsername:andToken:
refreshTokenWithUsername:andToken:
registerPushNotificationsToken:
requestOneTimeKeyWithUsername:
saveLogToFileEnable
sendDTMF:digit:
sendInfo:withType:content:andHeaders:
sendMessage:withText:
sendVideo:
setHold:forCall:
setLocalPreview:
setLogLevel:
setMute:
setRemoteView:
setRemoteView:forCall:
setResolution:andHeight:
setUseLoudspeaker:
setVideoResizeMode:
startCall:withHeaders:
switchToCameraWithPosition:
unregisterPushNotificationsToken:
voxDelegate
Protocols
VIAudioManagerDelegate
audioDeviceChanged:
audioDeviceUnavailable:
audioDevicesListChanged:
VICallDelegate
call:didAddEndpoint:
call:didAddLocalVideoStream:
call:didConnectWithHeaders:
call:didDisconnectWithHeaders:answeredElsewhere:
call:didFailWithError:headers:
call:didReceiveInfo:type:headers:
call:didReceiveMessage:headers:
call:didReceiveStatistics:
call:didRemoveLocalVideoStream:
call:startRingingWithHeaders:
callDidStartAudio:
iceCompleteForCall:
iceTimeoutForCall:
VIClientCallManagerDelegate
client:didReceiveIncomingCall:withIncomingVideo:headers:
VIClientSessionDelegate
client:sessionDidFailConnectWithError:
clientSessionDidConnect:
clientSessionDidDisconnect:
VICustomVideoSourceDelegate
startWithVideoFormat:
stop
VIEndpointDelegate
endpoint:didAddRemoteVideoStream:
endpoint:didRemoveRemoteVideoStream:
endpointDidRemove:
endpointInfoDidUpdate:
VIMessengerDelegate
messenger:didCreateConversation:
messenger:didEditConversation:
messenger:didEditMessage:
messenger:didEditUser:
messenger:didGetConversation:
messenger:didGetUser:
messenger:didReceiveDeliveryConfirmation:
messenger:didReceiveError:
messenger:didReceiveReadConfirmation:
messenger:didReceiveTypingNotification:
messenger:didRemoveConversation:
messenger:didRemoveMessage:
messenger:didRetransmitEvents:
messenger:didSendMessage:
messenger:didSetStatus:
messenger:didSubscribe:
messenger:didUnsubscribe:
VIVideoPreprocessDelegate
preprocessVideoFrame:rotation:
VIVideoRenderer
didStart
didStop
VoxImplantDelegate
onCallAudioStarted:
onCallConnected:withHeaders:
onCallDisconnected:withHeaders:
onCallFailed:withCode:andReason:withHeaders:
onCallRinging:withHeaders:
onConnectionClosed
onConnectionFailedWithError:
onConnectionSuccessful
onIncomingCall:caller:named:withVideo:withHeaders:
onLoginFailedWithErrorCode:
onLoginSuccessfulWithDisplayName:andAuthParams:
onMessageReceivedInCall:withText:withHeaders:
onNetStatsReceivedInCall:withStats:
onOneTimeKeyGenerated:
onPreprocessCameraCapturedVideo:rotation:
onRefreshTokenFailed:
onRefreshTokenSuccess:
onSIPInfoReceivedInCall:withType:andContent:withHeaders:
Enumerations
VIAudioDeviceType
VICallFailErrorCode
VIClientState
VILogLevel
VILogType
VILoginErrorCode
VIMessengerActionType
VIMessengerEventType
VIMessengerNotification
VIRejectMode
VIRotation
VIStreamDirection
VIStreamType
VISupportedDeviceOrientation
VIVideoResizeMode
React Native SDK
Tutorials
Migration Guide
Using React Native SDK
Changelog
Legacy
VoxImplantPreview
VoxImplantRemoteView
VoximplantLegacy
LoginTokens
VoxImplantClientConfig
VoxImplantConnectOptions
CameraType
Events
LogLevel
VideoResizeMode
Voximplant
EventHandlers
AuthResult
AuthTokenResult
CallEvent
CallEventWithHeaders
CallOperationFailed
CameraDisconnected
CameraError
CameraSwitchDone
CameraSwitchError
ConnectionClosed
ConnectionEstablished
ConnectionFailed
DeviceChanged
DeviceListChanged
Disconnected
EndpointAdded
Failed
IncomingCall
InfoReceived
InfoUpdated
LocalVideoStreamAdded
LocalVideoStreamRemoved
MessageReceived
RemoteVideoStreamAdded
RemoteVideoStreamRemoved
Removed
Hardware
AudioDeviceManager
CameraManager
AudioDevice
AudioDeviceEvents
CameraEvents
CameraType
Call
Client
Endpoint
VideoStream
VideoView
CallSettings
ClientConfig
ConnectOptions
LoginTokens
VideoFlags
getInstance
CallError
CallEvents
ClientEvents
ClientState
EndpointEvents
LogLevel
RenderScaleType
Unity SDK
Web SDK /
Voximplant /
EventHandlers /
ConnectionFailed
ConnectionFailed
Properties
(1)
message
Properties
message
message:
string
Failure reason description
D236516B-8638-44B8-A21A-3382374193EB
Created with sketchtool.