SIGN UP

VoximplantLegacy

Deprecated

Use Client instead

Methods

answerCall

Deprecated
answerCall(callId: string, headers: object): void

Use Call.answer instead

Answer incoming call

Parameters

  • callId:

    string

    Id of previously created call

  • headers:

    object
    Optional

    Optional set of headers to be sent with message. Names must begin with "X-" to be processed by SDK

closeConnection

Deprecated
closeConnection(): void

Use Client.disconnect instead

Closes connection with media server

connect

Deprecated
connect(options: VoxImplantConnectOptions): void

Use Client.connect instead

Connect to the Voximplant cloud

Parameters

createCall

Deprecated
createCall(to: string, video: boolean, customData: string, callback: object): void

Use Client.call instead

Create new call

Parameters

  • to:

    string

    SIP URI, username or phone number to make call to. Actual routing is then performed by VoxEngine scenario

  • video:

    boolean

    Enable video support in call

  • customData:

    string

    Optional custom data passed with call. Will be available in VoxEngine scenario

  • callback:

    object

    Callback object

declineCall

Deprecated
declineCall(callId: string, headers: object): void

Use Call.decline or Call.reject instead

Reject incoming alerting call

Parameters

  • callId:

    string

    Id of previously created call

  • headers:

    object
    Optional

    Optional set of headers to be sent with message. Names must begin with "X-" to be processed by SDK

disconnectCall

Deprecated
disconnectCall(callId: string, headers: object): void

Use Call.hangup instead.

Terminate specified call. Call must be either established, or outgoing progressing

Parameters

  • callId:

    string

    Id of previously created call

  • headers:

    object
    Optional

    Optional set of headers to be sent with message. Names must begin with "X-" to be processed by Voximplant

handlePushNotification

Deprecated
handlePushNotification(notification: object): void

Handle incoming push notification

Parameters

  • notification:

    object

    Incoming push notification

init

Deprecated
init(options: VoxImplantClientConfig): void

Initialization of Voximplant SDK

Parameters

login

Deprecated
login(user: string, password: string): void

Use Client.login instead

Login to specified Voximplant application

Parameters

  • user:

    string

    Full user name, including app and account name, like someuser@someapp.youraccount.voximplant.com

  • password:

    string

    User password

loginUsingAccessToken

Deprecated
loginUsingAccessToken(user: string, accessToken: string): void

Perform login using specified username and access token that was obtained in LoginSuccessful callback before

Parameters

  • user:

    string

    Full user name, including app and account name, like someuser@someapp.youraccount.voximplant.com

  • accessToken:

    string

    Access token that was obtained in LoginSuccessful callback

loginUsingOneTimeKey

Deprecated
loginUsingOneTimeKey(user: string, hash: string): void

Perform login using one time key that was generated before

Parameters

  • user:

    string

    Full user name, including app and account name, like someuser@someapp.youraccount.voximplant.com

  • hash:

    string

    Hash that was generated using following formula: MD5(oneTimeKey+"|"+MD5(user+":voximplant.com:"+password)). Please note that here user is just a user name, without app name, account name or anything else after "@". So if you pass myuser@myapp.myacc.voximplant.com as ausername, you should only use myuser while computing this hash

refreshToken

Deprecated
refreshToken(user: string, refreshToken: string): void

Perform refresh of login tokens required for login using access token

Parameters

  • user:

    string

    Full user name, including app and account name, like someuser@someapp.youraccount.voximplant.com

  • refreshToken:

    string

    Refresh token that was obtained in LoginSuccessful callback

registerForPushNotifications

Deprecated
registerForPushNotifications(pushRegistrationToken: string): void

Register for push notifications. Application will receive push notifications from the Voximplant Server after first log in

Parameters

  • pushRegistrationToken:

    string

    Push registration token

requestOneTimeKey

Deprecated
requestOneTimeKey(user: string): void

Generates one time login key to be used for automated login process

Parameters

  • user:

    string

    Full user name, including app and account name, like someuser@someapp.youraccount.voximplant.com

sendDTMF

Deprecated
sendDTMF(callId: string, digit: number): void

Use Call.sendTone instead

Sends DTMF digit in specified call

Parameters

  • callId:

    string

    Id of previously created call

  • digit:

    number

    Digit can be 0-9 for 0-9, 10 for * and 11 for #

sendInfo

Deprecated
sendInfo(callId: string, mimeType: string, content: string, headers: object): void

Use Call.sendInfo instead

Sends info within established call

Parameters

  • callId:

    string

    Id of previously created call

  • mimeType:

    string

    MIME type of info

  • content:

    string

    Custom string data

  • headers:

    object
    Optional

    Optional set of headers to be sent with message. Names must begin with "X-" to be processed by SDK

sendMessage

Deprecated
sendMessage(callId: string, text: string): void

Use Call.sendMessage instead

Sends instant message within established call

Parameters

  • callId:

    string

    Id of previously created call

  • text:

    string

    Message text

sendVideo

Deprecated
sendVideo(doSend: boolean): void

Use Call.sendVideo instead

Start/stop sending video from local camera

Parameters

  • doSend:

    boolean

    Specify if video should be sent

setCameraResolution

Deprecated
setCameraResolution(width: number, height: number): void

Set local camera resolution

Parameters

  • width:

    number

    Camera resolution width

  • height:

    number

    Camera resolution height

setMute

Deprecated
setMute(doMute: boolean): void

Use Call.sendAudio instead.

Mute or unmute microphone. This is reset after audio interruption

Parameters

  • doMute:

    boolean

    Enable/disable flag

setUseLoudspeaker

Deprecated
setUseLoudspeaker(enable: boolean): void

Enable/disable loudspeaker

Parameters

  • enable:

    boolean

    Enable/disable loudspeaker

setVideoResizeMode

Deprecated
setVideoResizeMode(mode: VideoResizeMode): void

Set video display mode. Applies to both incoming and outgoing stream. IOS ONLY

Parameters

startCall

Deprecated
startCall(callId: string, headers: object): void

Use Client.call instead

Send start call request If call with specified id is not found - returns false

Parameters

  • callId:

    string

    Id of previously created call

  • headers:

    object
    Optional

    Optional set of headers to be sent with message. Names must begin with "X-" to be processed by SDK

switchToCamera

Deprecated
switchToCamera(cameraName: Legacy.CameraType): void

Switch camera

Parameters

  • cameraName:

    Legacy.CameraType

    Must be "front" or "back"

unregisterFromPushNotifications

Deprecated
unregisterFromPushNotifications(pushRegistrationToken: string): void

Unregister from push notifications. Application will no longer receive push notifications from the Voximplant server

Parameters

  • pushRegistrationToken:

    string

    Push registration token that was used to register for push notifications