Class VonageClient

Clear all callbacks for an event.

Example

client.clearCallbacks('sessionError');
Copy

Remarks

This is useful for cleaning up callbacks when you no longer need them.

Create a session with a token and optional sessionId If no sessionId is provided, a new one will be generated and returned. If a sessionId is provided, it will be used to resume an existing session.

Example

const token = 'token';

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

Get a Conversation

Example

try {
  const conversation: Conversation = await client.getConversation(
    'conversationIdOrName'
  );
  console.log({ conversation });
} catch (e) {
  console.log({ e });
}
Copy

Unregister a callback for an event.

Example

client.off('reconnecting', reeconnectingListener);
client.off('reconnection', reeconnectionListener);
client.off('sessionError', sessionErrorListener);
Copy

Remarks

We recommend deregistering callbacks when you no longer need them.

Register a callback for an event.

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);
Copy

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.

Set a configuration for the client SDK

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'
});
client.setConfig({
  region: 'EU'
});
Copy

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.

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' }
});
Copy

Create a conversation

Example

const conversationId = await client.createConversation({
  name: 'name',
  displayName: 'displayName',
  imageUrl: 'imageUrl',
  ttl: 60,
  customSortKey: 'customSortKey',
  customData: { key: 'value' }
});
Copy

Delete a Conversation

Example

await client.deleteConversation('CONVERSATION_ID');
Copy

Delete an Event in a Conversation

Example

await client.deleteEvent(123, 'CONVERSATION_ID');
Copy

Get a Conversation's 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
  });
Copy

Get a Conversation's Members

Example

const { members, nextCursor, previousCursor } =
  await client.getConversationMembers('CONVERSATION_ID', {
    order: PresentingOrder.ASC,
    pageSize: 10
  });
Copy

Get a list of Conversations for the user.

Example

const { conversations, nextCursor, previousCursor } =
  await client.getConversations({
    order: PresentingOrder.DESC,
    pageSize: 10,
    cursor: undefined,
    includeCustomData: true,
    orderBy: OrderBy.CUSTOM_SORT_KEY
  });
Copy

Invite a user to a Conversation by user's name

Example

const memberId = await client.inviteToConversation(
  'CONVERSATION_ID',
  'USERNAME'
);
Copy

Join a Conversation

Example

const memberId = await client.joinConversation('CONVERSATION_ID');
Copy

Leave a Conversation

Example

await client.leaveConversation('CONVERSATION_ID');
Copy

Send a Custom event to a Conversation

Example

const customData = {
  key1: 'val1',
  key2: 'val2'
};

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

Send an ephemeral event to a Conversation

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)
);
Copy

Send a audio message to a Conversation.

Example

const timestamp = await client.sendMessageAudioEvent(
  'CONVERSATION_ID',
  audioURL
);
Copy

Send a custom message to a Conversation

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)
);
Copy

Send a file message to a Conversation.

Example

const timestamp = await client.sendMessageFileEvent(
  'CONVERSATION_ID',
  fileURL
);
Copy

Send a Image message to a Conversation.

Example

const timestamp = await client.sendMessageImageEvent(
  'CONVERSATION_ID',
  imageUrl
);
Copy

Send a Location message to a Conversation.

Example

const timestamp = await client.sendMessageLocationEvent('CONVERSATION_ID', {
  latitude: 'LATITUDE',
  longitude: 'LONGITUDE',
  name: 'Name', //optional
  address: 'Address' //optional
});
Copy

Send a message seen event to a Conversation

Example

const eventId = 0;

const timestamp = await client.sendMessageSeenEvent(
  eventId,
  'conversation_id'
);
Copy

Send a template message to a Conversation.

Example

const timestamp = await client.sendMessageTemplateEvent(
  'CONVERSATION_ID',
  {
    name: 'name',
    parameters: ['Params1'] // optional
  },
  {
    policy: '',
    locale: ''
  }
);
Copy

Send a text message to a Conversation

Example

const timestamp = await client.sendMessageTextEvent(
  'CONVERSATION_ID',
  'Hello World!'
);
Copy

Send a vcard message to a Conversation.

Example

const timestamp = await client.sendMessageVCardEvent(
  'CONVERSATION_ID',
  vCardUrl
);
Copy

Send a Vidoe message to a Conversation.

Example

const timestamp = await client.sendMessageVideoEvent(
  'CONVERSATION_ID',
  videoURL
);
Copy

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

Get a Call's Legs

Example

const { legs, nextCursor, previousCursor } = await client.getCallLegs(
  'callId',
  {
    order: PresentingOrder.DESC,
    pageSize: 10,
    cursor: undefined
  }
);
Copy

Get the Leg for a call

Get the Peer Connection for a call

Hangup a call.

Example

const callId = 'callId';
await client.hangup(callId);
Copy

Sends a TTS message to the Call

Sends a TTS message to the Call

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
});
Copy

Make a server call to the Vonage API. This is used to initiate a call using the Voice API and NCCO.

Example

const context = {
  callee: 'user1'
};

const callId = await client.serverCall(context);
Copy