To understand the relationships between the different components in the system and between the Nexmo APIs, consider the system flow of event dispatching.
To illustrate, consider the use case of a making a call from a phone to an app user.
This flow is summarized here:
- A phone call is initiated.
- Nexmo receives the call and calls back on the
- An NCCO is executed.
- A call is created and users connected into it.
- Events are dispatched.
Note: in the mentioned use case the entry point is a phone call to a Nexmo number. However, the diagram below and the way events are dispatched in the system, works in a similar manner for all other event type.
This is illustrated in the following diagram:
The sequence is as follows:
Nexmo receives the call and triggers your Nexmo Application’s
answer_urlwebhook, which your backend exposes.
answer_urldetermines how to handle a call, and who to connect the call to. It does that by executing an NCCO, that utilizes Nexmo Voice API numerous capabilities.
A call is created, and the requested users are connected into it. A call, as with Nexmo communication events, occur within a Conversation object. As a result of
answer_urlexecution, a new Conversation is created, or an existing one is fetched, and the requested users are added to it to connect to the call. Note, all of the events are passing through the Conversation API and are accessible to you through it. For that reason, Conversations are very powerful, as they hold all the communication events of all channels per user, allowing you to retain the communication context, and provide better and smarter communication experiences for your users.
All the respective events are dispatched to your application. These events can be inbound to the backend or to the client app:
a. and b. To your backend via
event_urlwebhooks, that you could assign to your Vonage application. There are both Voice events and RTC events. Events to your Vonage application's voice
event_urlwebhook are dispatched by Voice API. Events to your Vonage application's RTC capability
event_urlwebhook are dispatched by Conversation API.
c. To your client-side application, which is integrated with the Client SDK. These events can be received via callbacks that the Client SDKs trigger if a user is logged in to the SDK. They can also be received via push notifications, if they have been enabled, and the app is in the background.
Note: Only selected events are dispatched to the Client SDKs. In order to receive all events, make sure you set
event_url webhooks for your Nexmo Application. Setting of event webhooks is not mandatory but is highly recommended.
For further information see the following documentation: