Class VonageClient

VonageClient is the main entry point for the Vonage Client SDK.

Hierarchy

CombinedClientJS
- VonageClient

Index

Accessors

connectionStatus

get connectionStatus(): ConnectionStatus

Whether the client can place and receive calls right now.

CONNECTED means the session is attached to a live socket. It is never reported once the SDK has any evidence the socket is gone — a transport close or error, a missed heartbeat, or nothing heard from the server for 45 s, which every read checks.

reconnecting, reconnection and sessionError fire exactly on this value's transitions.

Returns ConnectionStatus

Overrides vonage.CombinedClientJS.connectionStatus

emergencyCore

get emergencyCore(): any

Returns any

Inherited from vonage.CombinedClientJS.emergencyCore

Methods

clearCallbacks

clearCallbacks<
    T extends
        | "mute"
        | "reconnection"
        | "conversationEvent"
        | "callHangup"
        | "callMediaDisconnect"
        | "legStatusUpdate"
        | "rtcStatsUpdate"
        | "callInvite"
        | "callInviteCancel"
        | "sessionError"
        | "callMediaError"
        | "callMediaWarning"
        | "emergencyCallDisconnected"
        | "emergencyCallHangup"
        | "callTransfer"
        | "earmuff"
        | "dtmf"
        | "callMediaReconnecting"
        | "callMediaReconnection"
        | "reconnecting"
        | "peerConnectionCreated",
>(
    event: T,
): void
Clear all callbacks for an event.
Type Parameters
- T extends
      | "mute"
      | "reconnection"
      | "conversationEvent"
      | "callHangup"
      | "callMediaDisconnect"
      | "legStatusUpdate"
      | "rtcStatsUpdate"
      | "callInvite"
      | "callInviteCancel"
      | "sessionError"
      | "callMediaError"
      | "callMediaWarning"
      | "emergencyCallDisconnected"
      | "emergencyCallHangup"
      | "callTransfer"
      | "earmuff"
      | "dtmf"
      | "callMediaReconnecting"
      | "callMediaReconnection"
      | "reconnecting"
      | "peerConnectionCreated"
Parameters
- event: T
  the event to unregister from (e.g. 'legStatusUpdate')
Returns void
void
Example
```
client.clearCallbacks('sessionError');
```
Remarks
This is useful for cleaning up callbacks when you no longer need them.

createSession

createSession(token: string, sessionId?: string | null): Promise<string>
Create (or reconnect to) a session.

When sessionId is omitted or null, a completely new session is created.

When sessionId is set to the value returned by a previous createSession call, the Conversation Service will replay any pending events into the new session. In particular, an unanswered inbound call invite that arrived before a page refresh will be re-delivered so that onCallInvite fires automatically — no extra API call is needed.

Important: The Conversation Service retains pending events for approximately 30 seconds. Persist the session ID (e.g. in sessionStorage) and pass it back within that window.
Parameters
- token: string
  JWT token of the user.
- OptionalsessionId: string | null
  Optional previous session ID. Omit or pass null for a fresh session.
Returns Promise<string>
The sessionId of the newly established session.
Example
```
const token = 'token';

try {
  const sessionId: string = await client.createSession(token);
  console.log({ sessionId });
} catch (e) {
  console.log({ e });
}
```
Overrides vonage.CombinedClientJS.createSession

getConversation

getConversation(conversationIdOrName: string): Promise<Conversation>
Get a Conversation
Parameters
- conversationIdOrName: string
  the Conversation's id or conversation name
Returns Promise<Conversation>
the Conversation
Example
```
try {
  const conversation: Conversation = await client.getConversation(
    'conversationIdOrName'
  );
  console.log({ conversation });
} catch (e) {
  console.log({ e });
}
```
Overrides vonage.CombinedClientJS.getConversation

off

off<
    T extends
        | "mute"
        | "reconnection"
        | "conversationEvent"
        | "callHangup"
        | "callMediaDisconnect"
        | "legStatusUpdate"
        | "rtcStatsUpdate"
        | "callInvite"
        | "callInviteCancel"
        | "sessionError"
        | "callMediaError"
        | "callMediaWarning"
        | "emergencyCallDisconnected"
        | "emergencyCallHangup"
        | "callTransfer"
        | "earmuff"
        | "dtmf"
        | "callMediaReconnecting"
        | "callMediaReconnection"
        | "reconnecting"
        | "peerConnectionCreated",
>(
    event: T,
    callbackSymbol: symbol,
): boolean
Unregister a callback for an event.
Type Parameters
- T extends
      | "mute"
      | "reconnection"
      | "conversationEvent"
      | "callHangup"
      | "callMediaDisconnect"
      | "legStatusUpdate"
      | "rtcStatsUpdate"
      | "callInvite"
      | "callInviteCancel"
      | "sessionError"
      | "callMediaError"
      | "callMediaWarning"
      | "emergencyCallDisconnected"
      | "emergencyCallHangup"
      | "callTransfer"
      | "earmuff"
      | "dtmf"
      | "callMediaReconnecting"
      | "callMediaReconnection"
      | "reconnecting"
      | "peerConnectionCreated"
Parameters
- event: T
  the event to register for (e.g. 'legStatusUpdate')
- callbackSymbol: symbol
  the callback symbol to unregister
Returns boolean
true if the callback was unregistered, false otherwise
Example
```
client.off('reconnecting', reeconnectingListener);
client.off('reconnection', reeconnectionListener);
client.off('sessionError', sessionErrorListener);
```
Remarks
We recommend deregistering callbacks when you no longer need them.

on

on<
    T extends
        | "mute"
        | "reconnection"
        | "conversationEvent"
        | "callHangup"
        | "callMediaDisconnect"
        | "legStatusUpdate"
        | "rtcStatsUpdate"
        | "callInvite"
        | "callInviteCancel"
        | "sessionError"
        | "callMediaError"
        | "callMediaWarning"
        | "emergencyCallDisconnected"
        | "emergencyCallHangup"
        | "callTransfer"
        | "earmuff"
        | "dtmf"
        | "callMediaReconnecting"
        | "callMediaReconnection"
        | "reconnecting"
        | "peerConnectionCreated",
    P extends
        | ((event: ConversationEvent) => void)
        | (
            (
                callId: string,
                callQuality: RTCQualityJS,
                reason: HangupReason,
            ) => void
        )
        | ((callId: string, reason: "networkChange") => void)
        | ((callId: string, legId: string, legStatus: LegStatus) => void)
        | ((stats: RTCStatsJS, callId: string) => void)
        | ((callId: string, reason: CancelReason) => void)
        | ((callId: string, from: string, channelType: VoiceChannelType) => void)
        | ((reason: SessionErrorReason) => void)
        | ((callId: string, error: VonageError) => void)
        | ((callId: string, warning: VonageError) => void)
        | ((callId: string) => void)
        | ((callId: string) => void)
        | ((callId: string | null, pc: RTCPeerConnection) => void)
        | ((callId: string, legId: string, isMuted: boolean) => void)
        | (() => void)
        | ((callId: string, conversationId: string) => void)
        | ((callId: string, legId: string, earmuffStatus: boolean) => void)
        | ((callId: string, legId: string, digits: string) => void)
        | ((callId: string) => void)
        | ((callId: string) => void)
        | (() => void),
>(
    event: T,
    callback: P,
): symbol
Register a callback for an event.
Type Parameters
- T extends
      | "mute"
      | "reconnection"
      | "conversationEvent"
      | "callHangup"
      | "callMediaDisconnect"
      | "legStatusUpdate"
      | "rtcStatsUpdate"
      | "callInvite"
      | "callInviteCancel"
      | "sessionError"
      | "callMediaError"
      | "callMediaWarning"
      | "emergencyCallDisconnected"
      | "emergencyCallHangup"
      | "callTransfer"
      | "earmuff"
      | "dtmf"
      | "callMediaReconnecting"
      | "callMediaReconnection"
      | "reconnecting"
      | "peerConnectionCreated"
- P extends
      | ((event: ConversationEvent) => void)
      | (
          (
              callId: string,
              callQuality: RTCQualityJS,
              reason: HangupReason,
          ) => void
      )
      | ((callId: string, reason: "networkChange") => void)
      | ((callId: string, legId: string, legStatus: LegStatus) => void)
      | ((stats: RTCStatsJS, callId: string) => void)
      | ((callId: string, reason: CancelReason) => void)
      | ((callId: string, from: string, channelType: VoiceChannelType) => void)
      | ((reason: SessionErrorReason) => void)
      | ((callId: string, error: VonageError) => void)
      | ((callId: string, warning: VonageError) => void)
      | ((callId: string) => void)
      | ((callId: string) => void)
      | ((callId: string | null, pc: RTCPeerConnection) => void)
      | ((callId: string, legId: string, isMuted: boolean) => void)
      | (() => void)
      | ((callId: string, conversationId: string) => void)
      | ((callId: string, legId: string, earmuffStatus: boolean) => void)
      | ((callId: string, legId: string, digits: string) => void)
      | ((callId: string) => void)
      | ((callId: string) => void)
      | (() => void)
Parameters
- event: T
  the event to register for (e.g. 'legStatusUpdate')
- callback: P
  the callback to register for the event
Returns symbol
a symbol that can be used to unregister the callback
Example
```
const eventHandler = (event: ConversationEvent) => {
  if (event.kind == 'member:invited') {
    console.log(`Member invited: ${event.body.memberId}`);
  } else if (event.kind == 'member:joined') {
    console.log(`Member joined: ${event.body.memberId}`);
  } else if (event.kind == 'member:left') {
    console.log(`Member left: ${event.body.memberId}`);
  } else if (event.kind == 'ephemeral') {
    console.log(`Ephemeral event: ${event.body}`);
  } else if (event.kind == 'custom') {
    console.log(`Custom event: ${event.body}`);
  } else if (event.kind == 'message:text') {
    console.log(`Text message: ${event.body.text}`);
  } else if (event.kind == 'message:custom') {
    console.log(`Custom message: ${event.body.customData}`);
  } else if (event.kind == 'message:image') {
    console.log(`Image message: ${event.body.imageUrl}`);
  } else if (event.kind == 'message:video') {
    console.log(`Video message: ${event.body.videoUrl}`);
  } else if (event.kind == 'message:audio') {
    console.log(`Audio message: ${event.body.audioUrl}`);
  } else if (event.kind == 'message:file') {
    console.log(`File message: ${event.body.fileUrl}`);
  } else if (event.kind == 'message:vcard') {
    console.log(`Vcard message: ${event.body.vcardUrl}`);
  } else if (event.kind == 'message:location') {
    console.log(`Location message: ${event.body.location}`);
  } else if (event.kind == 'message:template') {
    console.log(`Template message: ${event.body.template}`);
  } else if (event.kind == 'event:delete') {
    console.log(`Template message: ${event.body}`);
  } else if (event.kind == 'message:seen') {
    console.log(`Template message: ${event.body}`);
  } else if (event.kind == 'message:delivered') {
    console.log(`Message delivered event: ${event.body}`);
  } else if (event.kind == 'message:rejected') {
    console.log(`Message rejected event ${event.body}`);
  } else if (event.kind == 'message:submitted') {
    console.log(`Message delivered event ${event.body}`);
  } else if (event.kind == 'message:undeliverable') {
    console.log(`Message undeliverable event ${event.body}`);
  } else {
    exhaustiveCheck(event);
  }
};

const listener = client.on('conversationEvent', eventHandler);

client.off('conversationEvent', listener);
```
Remarks
Be sure to store the symbol returned by this method so you can unregister the callback later. We recommend unregistering callbacks when you no longer need them. See off.

setConfig

setConfig(config: ClientConfigObject): void

Set a configuration for the client SDK

Parameters

config: ClientConfigObject
A configuration object

Returns void

void

Example

const config: ClientConfig = new ClientConfig(ConfigRegion.EU);
config.apiUrl = 'https://api.example.com';
config.websocketUrl = 'https://ws.example.com';
config.rtcStatsTelemetry = true;
config.autoReconnectMedia = false;
client.setConfig(config);
// or
client.setConfig({
  apiUrl: 'https://api.example.com',
  websocketUrl: 'https://ws.example.com',
  region: 'EU'
});

updateConversation

updateConversation(
conversationId: string,
parameters: UpdateConversationParameters,
): Promise<Conversation>
Updates a conversation object identified by its unique conversation ID.

This method overrides the conversation properties to the provided parameters and rest remains as it is.
Parameters
- conversationId: string
  the Conversation's id.
- parameters: UpdateConversationParameters
  The properties of the conversation. These will replace existing values to the provided ones, rest will remain as they are.
Returns Promise<Conversation>
conversation, this object will contain the updated conversation properties if the update is successful.
Example
```
const conversation = await client.updateConversation('ConversationID', {
  // Update Name
  name: some('name'),
  // Reset Display Name
  displayName: some(null),
  // Update imageUrl
  imageUrl: 'imageUrl',
  // Leave TTL as is (implicitly via omission)
  // Leave customSortKey as is (explicitly via none)
  customSortKey: none(),
  customData: { key: 'value' }
});
```
Overrides vonage.CombinedClientJS.updateConversation

Chat

createConversation

createConversation(
parameters?: Nullable<CreateConversationParameters>,
): Promise<string>
Create a conversation
Parameters
- Optionalparameters: Nullable<CreateConversationParameters>
  A CreateConversationParameters object containing the parameters for the creation request.
Returns Promise<string>
the cid of the conversation
Example
```
const conversationId = await client.createConversation({
  name: 'name',
  displayName: 'displayName',
  imageUrl: 'imageUrl',
  ttl: 60,
  customSortKey: 'customSortKey',
  customData: { key: 'value' }
});
```
Overrides vonage.CombinedClientJS.createConversation

deleteConversation

deleteConversation(id: string): Promise<void>
Delete a Conversation
Parameters
- id: string
  the Conversation's id
Returns Promise<void>
void
Example
```
await client.deleteConversation('CONVERSATION_ID');
```
Overrides vonage.CombinedClientJS.deleteConversation

deleteEvent

deleteEvent(id: number, conversationId: string): Promise<void>
Delete an Event in a Conversation
Parameters
- id: number
  the id for the Event to be deleted
- conversationId: string
  the id for the conversation, the event belongs to.
Returns Promise<void>
void
Example
```
await client.deleteEvent(123, 'CONVERSATION_ID');
```
Overrides vonage.CombinedClientJS.deleteEvent

getConversationEvents

getConversationEvents(
id: string,
parameters?: Nullable<GetConversationEventsParameters>,
): Promise<EventsPage>
Get a Conversation's Events
Parameters
- id: string
  the Conversation's id
- Optionalparameters: Nullable<GetConversationEventsParameters>
  A GetConversationEventsParameters object containing the parameters for the request.
Returns Promise<EventsPage>
a EventsPage containing the events
Example
```
const { events, nextCursor, previousCursor } =
  await client.getConversationEvents('CONVERSATION_ID', {
    order: PresentingOrder.DESC,
    pageSize: 10,
    cursor: undefined,
    eventFilter: ['message', 'member:joined'], // event filter query
    includeDeletedEvents: false,
    startId: 3 // start event id
  });
```
Overrides vonage.CombinedClientJS.getConversationEvents

getConversationMember

getConversationMember(cid: string, mid: string): Promise<Member>
Get a Member of a Conversation
Parameters
- cid: string
  the Conversation's id
- mid: string
  the Member's id
Returns Promise<Member>
the Member
Example
```
const { id, state, channel } = await client.getConversationMember(
  'CONVERSATION_ID',
  'MEMBER_ID'
);
console.log(
  `Member ID: ${id}, State: ${state}, Channel Type: ${channel?.type}`
);
```
Inherited from vonage.CombinedClientJS.getConversationMember

getConversationMembers

getConversationMembers(
id: string,
parameters?: Nullable<GetConversationMembersParameters>,
): Promise<MembersPage>
Get a Conversation's Members
Parameters
- id: string
  the Conversation's id
- Optionalparameters: Nullable<GetConversationMembersParameters>
  A GetConversationMembersParameters object containing the parameters for the request.
Returns Promise<MembersPage>
a MembersPage containing the members
Example
```
const { members, nextCursor, previousCursor } =
  await client.getConversationMembers('CONVERSATION_ID', {
    order: PresentingOrder.ASC,
    pageSize: 10
  });
```
Overrides vonage.CombinedClientJS.getConversationMembers

getConversations

getConversations(
parameters?: Nullable<GetConversationsParameters>,
): Promise<ConversationsPage>
Get a list of Conversations for the user.
Parameters
- Optionalparameters: Nullable<GetConversationsParameters>
  A GetConversationsParameters object containing the parameters for the request.
Returns Promise<ConversationsPage>
a ConversationsPage containing the conversations
Example
```
const { conversations, nextCursor, previousCursor } =
  await client.getConversations({
    order: PresentingOrder.DESC,
    pageSize: 10,
    cursor: undefined,
    includeCustomData: true,
    orderBy: OrderBy.CUSTOM_SORT_KEY
  });
```
Overrides vonage.CombinedClientJS.getConversations

inviteToConversation

inviteToConversation(id: string, name: string): Promise<string>
Invite a user to a Conversation by user's name
Parameters
- id: string
  the Conversation's id
- name: string
  the name of the user to invite
Returns Promise<string>
the memberId of the member
Example
```
const memberId = await client.inviteToConversation(
  'CONVERSATION_ID',
  'USERNAME'
);
```
Overrides vonage.CombinedClientJS.inviteToConversation

joinConversation

joinConversation(id: string): Promise<string>
Join a Conversation
Parameters
- id: string
  the Conversation's id
Returns Promise<string>
the memberId of the member
Example
```
const memberId = await client.joinConversation('CONVERSATION_ID');
```
Overrides vonage.CombinedClientJS.joinConversation

leaveConversation

leaveConversation(id: string): Promise<void>
Leave a Conversation
Parameters
- id: string
  the Conversation's id
Returns Promise<void>
void
Example
```
await client.leaveConversation('CONVERSATION_ID');
```
Overrides vonage.CombinedClientJS.leaveConversation

sendCustomEvent

sendCustomEvent(
    id: string,
    eventType: string,
    customData: CustomData,
): Promise<string>
Send a Custom event to a Conversation
Parameters
- id: string
  the Conversation's id
- eventType: string
- customData: CustomData
  the body of the event
Returns Promise<string>
the timestamp of the message
Example
```
const customData = {
  key1: 'val1',
  key2: 'val2'
};

const timestamp = await client.sendCustomEvent(
  'CONVERSATION_ID',
  'custom:test',
  customData // or JSON.stringify(customData)
);
```
Overrides vonage.CombinedClientJS.sendCustomEvent

sendEphemeralEvent

sendEphemeralEvent(id: string, customData: CustomData): Promise<string>
Send an ephemeral event to a Conversation
Parameters
- id: string
  the Conversation's id
- customData: CustomData
  the body of the event
Returns Promise<string>
the timestamp of the message
Example
```
const memberId = 'MEMBER_ID';
const readMessageEvent = {
  type: `${memberId}:readUpdate`,
  eventId: 'EVENT_ID',
  timestamp: 'TIMESTAMP'
};

const timestamp = await client.sendEphemeralEvent(
  'CONVERSATION_ID',
  readMessageEvent // or JSON.stringify(readMessageEvent)
);
```
Overrides vonage.CombinedClientJS.sendEphemeralEvent

sendMessageAudioEvent

sendMessageAudioEvent(id: string, audioUrl: URL): Promise<string>
Send a audio message to a Conversation.
Parameters
- id: string
  the Conversation's id
- audioUrl: URL
  the url of the audio resource.
Returns Promise<string>
the timestamp of the message
Example
```
const timestamp = await client.sendMessageAudioEvent(
  'CONVERSATION_ID',
  audioURL
);
```
Overrides vonage.CombinedClientJS.sendMessageAudioEvent

sendMessageCustomEvent

sendMessageCustomEvent(id: string, customData: CustomData): Promise<string>

Send a custom message to a Conversation

Parameters

id: string
the Conversation's id
customData: CustomData
the body of the message

Returns Promise<string>

the timestamp of the message

Example

const attachmentPayload = {
  attachment: {
    payload: {
      buttons: [
        {
          payload: '{"<cid>": "$","action": "connect","mid": "<mid>"}',
          title: 'Connect to an agent',
          type: 'postback'
        }
      ],
      template_type: 'button',
      text: "Hi, My name is Chatbot, Welcome to my chatbot's corner. How can We help you"
    },
    type: 'template'
  }
};

const timestamp = await client.sendMessageCustomEvent(
  'CONVERSATION_ID',
  attachmentPayload // or JSON.stringify(attachmentPayload)
);

sendMessageFileEvent

sendMessageFileEvent(id: string, fileUrl: URL): Promise<string>
Send a file message to a Conversation.
Parameters
- id: string
  the Conversation's id
- fileUrl: URL
  the url of the file resource.
Returns Promise<string>
the timestamp of the message
Example
```
const timestamp = await client.sendMessageFileEvent(
  'CONVERSATION_ID',
  fileURL
);
```
Overrides vonage.CombinedClientJS.sendMessageFileEvent

sendMessageImageEvent

sendMessageImageEvent(id: string, imageUrl: URL): Promise<string>
Send a Image message to a Conversation.
Parameters
- id: string
  the Conversation's id
- imageUrl: URL
  the url of the image resource.
Returns Promise<string>
the timestamp of the message
Example
```
const timestamp = await client.sendMessageImageEvent(
  'CONVERSATION_ID',
  imageUrl
);
```
Overrides vonage.CombinedClientJS.sendMessageImageEvent

sendMessageLocationEvent

sendMessageLocationEvent(id: string, location: Location): Promise<string>
Send a Location message to a Conversation.
Parameters
- id: string
  the Conversation's id
- location: Location
  the description of the location.
Returns Promise<string>
the timestamp of the message
Example
```
const timestamp = await client.sendMessageLocationEvent('CONVERSATION_ID', {
  latitude: 'LATITUDE',
  longitude: 'LONGITUDE',
  name: 'Name', //optional
  address: 'Address' //optional
});
```
Overrides vonage.CombinedClientJS.sendMessageLocationEvent

sendMessageSeenEvent

sendMessageSeenEvent(id: number, conversationId: string): Promise<string>
Send a message seen event to a Conversation
Parameters
- id: number
  the event id
- conversationId: string
  the conversation id
Returns Promise<string>
the timestamp of the message
Example
```
const eventId = 0;

const timestamp = await client.sendMessageSeenEvent(
  eventId,
  'conversation_id'
);
```
Overrides vonage.CombinedClientJS.sendMessageSeenEvent

sendMessageTemplateEvent

sendMessageTemplateEvent(
    id: string,
    templateObject: Template,
    whatsappObject: Whatsapp,
): Promise<string>
Send a template message to a Conversation.
Parameters
- id: string
  the Conversation's id
- templateObject: Template
  the description(name and paramters) of the template.
- whatsappObject: Whatsapp
  the description(locale and policies of business account) of the location.
Returns Promise<string>
the timestamp of the message
Example
```
const timestamp = await client.sendMessageTemplateEvent(
  'CONVERSATION_ID',
  {
    name: 'name',
    parameters: ['Params1'] // optional
  },
  {
    policy: '',
    locale: ''
  }
);
```
Overrides vonage.CombinedClientJS.sendMessageTemplateEvent

sendMessageTextEvent

sendMessageTextEvent(id: string, text: string, raw?: boolean): Promise<string>
Send a text message to a Conversation
Parameters
- id: string
  the Conversation's id
- text: string
  the Body of the message
- raw: boolean = false
  whether to send the text as raw or not (default: false, not recommended)
Returns Promise<string>
the timestamp of the message
Example
```
const timestamp = await client.sendMessageTextEvent(
  'CONVERSATION_ID',
  'Hello World!'
);
```
Overrides vonage.CombinedClientJS.sendMessageTextEvent

sendMessageVCardEvent

sendMessageVCardEvent(id: string, vCardUrl: URL): Promise<string>
Send a vcard message to a Conversation.
Parameters
- id: string
  the Conversation's id
- vCardUrl: URL
  the url of the vCardUrl resource.
Returns Promise<string>
the timestamp of the message
Example
```
const timestamp = await client.sendMessageVCardEvent(
  'CONVERSATION_ID',
  vCardUrl
);
```
Overrides vonage.CombinedClientJS.sendMessageVCardEvent

sendMessageVideoEvent

sendMessageVideoEvent(id: string, videoUrl: URL): Promise<string>
Send a Vidoe message to a Conversation.
Parameters
- id: string
  the Conversation's id
- videoUrl: URL
  the url of the video resource.
Returns Promise<string>
the timestamp of the message
Example
```
const timestamp = await client.sendMessageVideoEvent(
  'CONVERSATION_ID',
  videoURL
);
```
Overrides vonage.CombinedClientJS.sendMessageVideoEvent

Diagnostics

cancelConnectivityReport

cancelConnectivityReport(): void

Stops a running VonageClient.connectivityReport, which then rejects with the diagnostics:error:cancelled error.

Returns void

Overrides vonage.CombinedClientJS.cancelConnectivityReport

connectivityReport

connectivityReport(
options?: ConnectivityReportOptions,
): Promise<ConnectivityReport>
Tests whether this device and network can carry a call, and reports why not.

It places a short test call over the exact route a real call takes, streaming real microphone audio to Vonage's media server and measuring the audio that comes back. Nothing rings and the test leg is hung up as soon as it ends. Requires a session, and cannot run during a call: a call that starts during the test stops it. Like a call, it may prompt for microphone permission, and the test leg may be billed as a few seconds of in-app voice.
Parameters
- Optionaloptions: ConnectivityReportOptions
  how long to sample audio for, and to wait for media to connect
Returns Promise<ConnectivityReport>
the report: verdict, the failedAt stage and issues with hints, plus every measurement. It is plain JSON, so JSON.stringify(report) can be sent to support.
Example
```
const report = await client.connectivityReport();
if (report.verdict !== 'pass') {
  console.log(`Failed at: ${report.failedAt}`);
  report.issues.forEach((issue) =>
    console.log(`${issue.code}: ${issue.hint}`)
  );
}
// The report is plain JSON: send it to Vonage support as it is.
const forSupport = JSON.stringify(report);
```

Emergency

disableEarmuffEmergencyCall

disableEarmuffEmergencyCall(callId: string): Promise<void>
Disable earmuff for an emergency call.
Parameters
- callId: string
  the callId of the call to disable earmuff for
Returns Promise<void>
void

Overrides vonage.CombinedClientJS.disableEarmuffEmergencyCall

emergencyCall

emergencyCall(
    token: string,
    from: string,
    to: string,
    options?: Nullable<EmergencyCallOptionsJS>,
): Promise<EmergencyCallDataJS>
Starts an emergency call.
Parameters
- token: string
- from: string
- to: string
- Optionaloptions: Nullable<EmergencyCallOptionsJS>
  Optional EmergencyCallOptions containing call options
Returns Promise<EmergencyCallDataJS>
the result containing callId and reconnectToken

Overrides vonage.CombinedClientJS.emergencyCall

enableEarmuffEmergencyCall

enableEarmuffEmergencyCall(callId: string): Promise<void>
Enable earmuff for an emergency call.
Parameters
- callId: string
  the callId of the call to enable earmuff for
Returns Promise<void>
void

Overrides vonage.CombinedClientJS.enableEarmuffEmergencyCall

hangupEmergencyCall

hangupEmergencyCall(callId: string): Promise<void>
Hangup an emergency call.
Parameters
- callId: string
  the callId of the call to hangup
Returns Promise<void>
void

muteEmergencyCall

muteEmergencyCall(callId: string): Promise<void>
Mute an emergency call.
Parameters
- callId: string
  the callId of the call to mute
Returns Promise<void>
void

Overrides vonage.CombinedClientJS.muteEmergencyCall

reconnectEmergencyCall

reconnectEmergencyCall(
    token: string,
    callId: string,
    reconnectToken: string,
): Promise<void>
Reconnects an existing emergency call.
Parameters
- token: string
- callId: string
- reconnectToken: string
Returns Promise<void>
void

Overrides vonage.CombinedClientJS.reconnectEmergencyCall

unmuteEmergencyCall

unmuteEmergencyCall(callId: string): Promise<void>
Unmute an emergency call.
Parameters
- callId: string
  the callId of the call to unmute
Returns Promise<void>
void

Overrides vonage.CombinedClientJS.unmuteEmergencyCall

Voice

answer

answer(callId: string): Promise<void>
Answer a call
Parameters
- callId: string
  Call ID
Returns Promise<void>
void
Example
```
const callId = 'callId';
await client.answer(callId);
```
Inherited from vonage.CombinedClientJS.answer

disableAutoGainControl

disableAutoGainControl(id: string): Promise<void>
Experimental
Disable auto gain control on a call's audio track.
Parameters
- id: string
  The Call Id
Returns Promise<void>

Overrides vonage.CombinedClientJS.disableAutoGainControl

disableEarmuff

disableEarmuff(callId: string): Promise<void>
Unearmuff your leg of a call
Parameters
- callId: string
  Call ID
Returns Promise<void>
void
Example
```
const callId = 'callId';
await client.disableEarmuff(callId);
```
Inherited from vonage.CombinedClientJS.disableEarmuff

disableEchoCancellation

disableEchoCancellation(id: string): Promise<void>
Experimental
Disable echo cancellation on a call's audio track.
Parameters
- id: string
  The Call Id
Returns Promise<void>

Overrides vonage.CombinedClientJS.disableEchoCancellation

disableNoiseSuppression

disableNoiseSuppression(id: string): Promise<void>
Experimental
Disable noise suppression on a call's audio track.
Parameters
- id: string
  The Call Id
Returns Promise<void>

Overrides vonage.CombinedClientJS.disableNoiseSuppression

enableAutoGainControl

enableAutoGainControl(id: string): Promise<void>
Experimental
Enable auto gain control on a call's audio track.
Parameters
- id: string
  The Call Id
Returns Promise<void>

Overrides vonage.CombinedClientJS.enableAutoGainControl

enableEarmuff

enableEarmuff(callId: string): Promise<void>
Earmuff your leg of a call
Parameters
- callId: string
  Call ID
Returns Promise<void>
void
Example
```
const callId = 'callId';
await client.enableEarmuff(callId);
```
Inherited from vonage.CombinedClientJS.enableEarmuff

enableEchoCancellation

enableEchoCancellation(id: string): Promise<void>
Experimental
Enable echo cancellation on a call's audio track.
Parameters
- id: string
  The Call Id
Returns Promise<void>

Overrides vonage.CombinedClientJS.enableEchoCancellation

enableNoiseSuppression

enableNoiseSuppression(id: string): Promise<void>
Experimental
Enable noise suppression on a call's audio track.
Parameters
- id: string
  The Call Id
Returns Promise<void>

Overrides vonage.CombinedClientJS.enableNoiseSuppression

getAudioOutputElement

getAudioOutputElement(): HTMLAudioElement | undefined

Experimental
Get the HTML Audio Element for the SDK. It can be used to route output to other devices.

Returns HTMLAudioElement | undefined

Overrides vonage.CombinedClientJS.getAudioOutputElement

getCallLegs

getCallLegs(
callId: string,
parameters?: Nullable<GetCallLegsParameters>,
): Promise<LegsPage>
Get a Call's Legs
Parameters
- callId: string
- Optionalparameters: Nullable<GetCallLegsParameters>
  A GetCallLegsParameters object containing the parameters for the request.
Returns Promise<LegsPage>
a LegsPage containing the legs
Example
```
const { legs, nextCursor, previousCursor } = await client.getCallLegs(
  'callId',
  {
    order: PresentingOrder.DESC,
    pageSize: 10,
    cursor: undefined
  }
);
```
Overrides vonage.CombinedClientJS.getCallLegs

getLeg

getLeg(legId: string): Promise<LegJS>
Get the Leg for a call
Parameters
- legId: string
  The Leg Id
Returns Promise<LegJS>

Overrides vonage.CombinedClientJS.getLeg

getPeerConnection

getPeerConnection(id: string): RTCPeerConnection | undefined
Experimental
Get the Peer Connection for a call
Parameters
- id: string
  The Call Id
Returns RTCPeerConnection | undefined

Overrides vonage.CombinedClientJS.getPeerConnection

hangup

hangup(callId: string, reasonText?: string, reasonCode?: string): Promise<void>
Hangup a call.
Parameters
- callId: string
  the callId of the call to hangup
- OptionalreasonText: string
  optional reason text to send to the other party
- OptionalreasonCode: string
  optional reason code to send to the other party
Returns Promise<void>
void
Example
```
const callId = 'callId';
await client.hangup(callId);
```
Overrides vonage.CombinedClientJS.hangup

mute

mute(callId: string): Promise<void>
Mute your leg of a call
Parameters
- callId: string
  Call ID
Returns Promise<void>
void
Example
```
const callId = 'callId';
await client.mute(callId);
```
Inherited from vonage.CombinedClientJS.mute

reconnectCall

reconnectCall(callId: string): Promise<void>
Reconnect a call
Parameters
- callId: string
  Call ID
Returns Promise<void>
void
Example
```
const callId = 'callId';
await client.reconnectCall(callId);
```
Inherited from vonage.CombinedClientJS.reconnectCall

reject

reject(callId: string): Promise<void>
Reject a call
Parameters
- callId: string
  Call ID
Returns Promise<void>
void
Example
```
const callId = 'callId';
await client.reject(callId);
```
Inherited from vonage.CombinedClientJS.reject

say

say(callId: string, text: string): Promise<void>
Sends a TTS message to the Call
Parameters
- callId: string
  the callId of the call to send the message to
- text: string
  the text to send
Returns Promise<void>
void

Overrides vonage.CombinedClientJS.say

say(callId: string, params: CallSayParams): Promise<void>

Sends a TTS message to the Call

Parameters

callId: string
the callId of the call to send the message to
params: CallSayParams
the CallSayParams to send

Returns Promise<void>

void

Example

const callId = 'callId';
await client.say(callId, 'Hello World');
const ssmlExample =
  '<speak>Hello World <break strength="weak"/> I am using <say-as interpret-as="character">SSML</say-as> <break strength="weak" /> how cool is that? </speak>';
await client.say(callId, {
  text: ssmlExample,
  voiceName: 'Kimberly',
  ssml: true,
  level: 1,
  loop: 2
});

sendDTMF

sendDTMF(callId: string, digits: string): Promise<void>
Send a string of digits to a call via DTMF
Parameters
- callId: string
  Call ID
- digits: string
  DTMF digits
Returns Promise<void>
void
Example
```
const callId = 'callId';
await client.sendDTMF(callId, '1234');
```
Inherited from vonage.CombinedClientJS.sendDTMF

serverCall

serverCall(context?: Json): Promise<string>
Make a server call to the Vonage API. This is used to initiate a call using the Voice API and NCCO.
Parameters
- Optionalcontext: Json
  the context to send to the server passed as Custom data to the voice answer webhook
Returns Promise<string>
the callId of the call
Example
```
const context = {
  callee: 'user1'
};

const callId = await client.serverCall(context);
```
Overrides vonage.CombinedClientJS.serverCall

unmute

unmute(callId: string): Promise<void>
Unmute your leg of a call
Parameters
- callId: string
  Call ID
Returns Promise<void>
void

Inherited from vonage.CombinedClientJS.unmute

Class VonageClient

Hierarchy

Index

Accessors

Methods

Chat

Diagnostics

Emergency

Voice

Accessors

connectionStatus

Returns ConnectionStatus

emergencyCore

Returns any

Methods

clearCallbacks

Type Parameters

Parameters

Returns void

Example

Remarks

createSession

Parameters

Returns Promise<string>

Example

getConversation

Parameters

Returns Promise<Conversation>

Example

off

Type Parameters

Parameters

Returns boolean

Example

Remarks

on

Type Parameters

Parameters

Returns symbol

Example

Remarks

setConfig

Parameters

Returns void

Example

updateConversation

Parameters

Returns Promise<Conversation>

Example

Chat

createConversation

Parameters

Returns Promise<string>

Example

deleteConversation

Parameters

Returns Promise<void>

Example

deleteEvent

Parameters

Returns Promise<void>

Example

getConversationEvents

Parameters

Returns Promise<EventsPage>

Example

getConversationMember

Parameters

Returns Promise<Member>

Example

getConversationMembers

Parameters

Returns Promise<MembersPage>

Example

getConversations

Parameters

Returns Promise<ConversationsPage>

Example

inviteToConversation

Parameters