Conversation API

The Conversation API is a low-level API that allows you to create various objects such as Events, Members, and Conversations.

Conversations are the fundamental concept the API revolves around. Conversations are containers of communications exchanged between two or more Users which could be a single interaction or the history of all interactions between them.

The API also allows you to create Events to enable text, voice and custom communications between two Users and store them in Conversations.

Text, voice and custom communications can currently flow through various Channels like App, Phone, SIP, and Websocket. To enable the App channel (for in-app messaging and voice), you would need to also utilize our Vonage Client SDK.

Phone, SIP and Websocket Channels are enabled through the Voice API and they all flow into Conversations.

Contents

Supported features

The Conversation API currently supports a range of communication channels described in this documentation.

As the Conversation API expands to support more and more Vonage services, the supported Channels will also expand. Conversations would, as a result, become the container for the history of all your communication exchanged via Vonage API Services. This history would then be accessible through the Conversation API.

Concepts

  • How to set up your application
  • Application: A Vonage Application provides a container for Users and Conversations.
  • How to authenticate users
  • User: A User represents an entity such as a person that wishes to communicate.
  • Conversation: A Conversation connects Users and allows them to communicate.
  • Event flow: This topic provides an overview of a event dispatching flow through the system encompassing the Vonage Voice and Conversation services.
  • Member: A Member is created when a User joins a Conversation.
  • Call: A Call consists of one or more Legs.
  • Channel: A Channel refers to one of App, Phone, SIP or Websocket.
  • Leg: A Leg connects a User with a Conversation.
  • Media: Media refers to type of communication. It is currently one of text or voice
  • Event: Conversations are event-driven. Event objects are generated when key activities occur.
  • Session: A Session is a live communication stream created with a Client SDK.

Getting started

Get started with these guides:

Code Snippets

Code snippets provide ready to use samples of code so you can build out your application quickly.

You could start by Creating a Conversation.

Use Cases

There is also a Use Case on how to build your own Contact Center.

Reference