Rate this page:

Call

Props

rearangeCodecs

Copy URL
rearangeCodecs: 

Function

Callback for manual rearrangement or setup compatible codec list. If will set unknown/unsupported codec - it will be ignored

Methods

active

Copy URL
active(): 

boolean

Returns 'true' if a call is active, otherwise returns 'false'. A single call (either inbound or outbound) is active by default, all other calls are inactive and should be activated via the setActive method. Only the active call sends and receives an audio/video stream.

Returns

  • type:

    boolean

answer

Copy URL
answer(customData: 

string

,
extraHeaders:

{[id: string]: string}

,
useVideo:

VideoFlags

):

void

Answer the incoming call. There are two methods for an incoming call: answer and decline. Voice can be sended only after the answer method call.

Parameters

  • customData:

    string

    Optional

    Set custom string associated with call session. It can be later obtained from Call History <a href="//voximplant.com/docs/references/httpapi/#toc-getcallhistory">using HTTP API</a>, see the <a href="//voximplant.com/docs/references/httpapi/#struct_CallSessionInfoType">custom_data field in result</a>. Custom data can be retrieved on the part of Voxengine via the <a href="//voximplant.com/docs/references/appengine/VoxEngine.html#VoxEngine_customData">customData</a> method. Maximum size is 200 bytes.

  • extraHeaders:

    {[id: string]: string}

    Optional

    Optional custom parameters (SIP headers) that are sent to another participant after accepting an incoming call. Header names have to begin with the 'X-' prefix. The "X-" headers could be handled only by SIP phones/devices.

  • useVideo:

    VideoFlags

    Optional

    (https://voximplant.com/docs/references/websdk/voximplant/videoflags) defining if sending and receiving video is allowed.

Returns

  • type:

    void

decline

Copy URL
decline(extraHeaders: 

{[id: string]: string}

):

void

Reject incoming call on all devices, where this user logged in.

Parameters

  • extraHeaders:

    {[id: string]: string}

    Optional

    Optional custom parameters (SIP headers) that should be sent after rejecting incoming call. Parameter names must start with "X-" to be processed by application

Returns

  • type:

    void

displayName

Copy URL
displayName(): 

string

Returns display name, i.e. a name of the calling user, that will be displayed to the called user. Normally it's a human-readable version of CallerID, e.g. a person's name.

Returns

  • type:

    string

getCallDuration

Copy URL
getCallDuration(): 

number

Get the call duration

Returns

  • type:

    number

getEndpoints

Copy URL
getEndpoints(): 

Endpoint[]

Get all current Endpoint in the call.

Returns

hangup

Copy URL
hangup(extraHeaders: 

{[id: string]: string}

):

void

Hangup call

Parameters

  • extraHeaders:

    {[id: string]: string}

    Optional

    Optional custom parameters (SIP headers) that should be sent after disconnecting/cancelling call. Parameter names must start with "X-" to be processed by application

Returns

  • type:

    void

headers

Copy URL
headers(): 

{[id: string]: string}

Returns headers

Returns

  • type:

    {[id: string]: string}

id

Copy URL
id(): 

string

Returns call id

Returns

  • type:

    string

muteMicrophone

Copy URL
muteMicrophone(): 

void

Mute microphone

Returns

  • type:

    void

mutePlayback

Copy URL
mutePlayback(): 

void

Mute sound

Returns

  • type:

    void

number

Copy URL
number(): 

string

Returns dialed number or caller id

Returns

  • type:

    string

reject

Copy URL
reject(extraHeaders: 

{[id: string]: string}

):

void

Reject incoming call on the part of Web SDK. If a call is initiated from the PSTN, the network will receive "reject" command; in case of a call from another Web SDK client, it will receive the CallEvents.Failedevent with the 603 code.

Parameters

  • extraHeaders:

    {[id: string]: string}

    Optional

    Optional custom parameters (SIP headers) that should be sent after rejecting incoming call. Parameter names must start with "X-" to be processed by application

Returns

  • type:

    void

sendInfo

Copy URL
sendInfo(mimeType: 

string

,
body:

string

,
extraHeaders:

{[id: string]: string}

):

void

Send Info (SIP INFO) message inside the callYou can get this message via the Voxengine CallEvents.InfoReceivedevent in our cloud.

You can get this message in Web SDK on other side via the CallEvents.InfoReceivedevent; see the similar events for the iOS and Android SDKs.

Parameters

  • mimeType:

    string

    MIME type of the message, e.g. "text/plain", "multipart/mixed" etc.

  • body:

    string

    Message content

  • extraHeaders:

    {[id: string]: string}

    Optional

    Optional headers to be passed with the message

Returns

  • type:

    void

sendMessage

Copy URL
sendMessage(msg: 

string

):

void

Send text message. It is a special case of the sendInfomethod as it allows to send messages only of "text/plain" type.You can get this message via the Voxengine CallEvents.MessageReceivedevent in our cloud.

You can get this message in Web SDK on other side via the CallEvents.MessageReceivedevent; see the similar events for the iOS and Android SDKs.

Parameters

  • msg:

    string

    Message text

Returns

  • type:

    void

sendTone

Copy URL
sendTone(key: 

string

):

void

Send tone (DTMF). It triggers the CallEvents.ToneReceived event in our cloud.

Parameters

  • key:

    string

    Send tone according to pressed key: 0-9 , * , #

Returns

  • type:

    void

sendVideo

Copy URL
sendVideo(flag: 

boolean

):

Promise<Updated>

Start/stop sending video from a call. In case of a remote participant uses a Web SDK client, it will receive either the EndpointEvents.RemoteMediaAddedor EndpointEvents.RemoteMediaRemovedevent accordingly. IMPORTANT: Safari browser for iOS requires a user interface for playing video during a call. It should be interactive element like an HTML "button" with "onclick" handler that calls "play" method on the "video" HTML element.

Parameters

  • flag:

    boolean

Returns

setActive

Copy URL
setActive(flag: 

boolean

):

Promise<Updated>

The method makes a call active, i.e. change the activeflag to 'true'. A single call (either inbound or outbound) is active by default, all other calls are inactive and should be activated.

Parameters

  • flag:

    boolean

Returns

shareScreen

Copy URL
shareScreen(showLocalView: 

boolean

):

Promise<Updated>

Enable screen sharing. Works in Chrome and Firefox. For Chrome, custom extension must be created and installed from this template: "https://github.com/voximplant/voximplant-chrome-extension". "matches" section in the extension's "manifest.json" should be set to app website url(s). Browser will ask user for a window or screen to share. Can be called multiple times to share multiple windows.

Parameters

  • showLocalView:

    boolean

    Defaults on:  false

    if set to true, a screen sharing preview will be displayed locally in the same way as it's done for video calls. It is false by default. IMPORTANT: Safari browser for iOS requires a user interface for playing video during a call. It should be interactive element like an HTML "button" with "onclick" handler that calls "play" method on the "video" HTML element.

Returns

state

Copy URL
state(): 

string

Get the current state of a call. Possible values are: "ALERTING", "PROGRESSING", "CONNECTED", "ENDED".

Returns

  • type:

    string

stopSharingScreen

Copy URL
stopSharingScreen(): 

Promise<Updated>

Stops screen sharing. If 'shareScreen' was called multiple times, this will stop sharing for all windows/screens

Returns

unmuteMicrophone

Copy URL
unmuteMicrophone(): 

void

Unmute microphone

Returns

  • type:

    void

unmutePlayback

Copy URL
unmutePlayback(): 

void

Unmute sound

Returns

  • type:

    void