Introducing Custom Channels in Conversations

Published February 05, 2020 by Britt Barak

At Vonage, we are committed to building the most robust, flexible and scalable platforms possible so that you can continue creating great conversation experiences for your users. With that in mind, we’re happy to announce a new sibling for in-app voice and messages channels: Custom Channels!

Using custom events, you can create a custom integration with any channel you can imagine. For example, other messaging platforms, emails, or payments.

How It Works:

1. Defining the Custom Event Object

A custom event has a type and a body. The type is your chosen name for the custom channel, which starts with the key "custom:". The body is key-value pairs that define the data you’d like to pass in the event.

2. Sending Custom Events

You can send custom events to a Conversation through Conversations API, or Client SDKs.

When sending an event through the Android or iOS SDKs, the "custom:" prefix for the event type is automatically added on your behalf.

Below are examples of how this can be achieved using the three supported Client SDKs.

Android

iOS

JavaScript

3. Receiving Custom Events

Receiving a custom event is similar to receiving any other event in youโ€™ll receive it on your application’s RTC event_url.

In our three supported Client SDKs, you’ll receive it as shown below:

Android

iOS

JavaScript

4. Sending Push Notifications

If your Android or iOS application is running in the background, you might want to notify your user about an incoming custom event with a push notification.

To do that, you must define the payload to send per push notification on a per type basis:

PUT https://api.nexmo.com/v2/applications/:your_nexmo_application_id

5. Receiving Push Notification

After setting up push notifications for your mobile apps, youโ€™re ready to receive your custom push. You can access the custom data that you previously defined as follows:

Android

iOS

Integration Complete

You now have all you need to a custom channel with custom push notifications into your conversation experiences. We can’t wait to see which channels youโ€™ll add and how you’ll use them to enrich your user’s conversation with you!

What’s Next?

Should you have any questions or feedback – let us know on our Community Slack or [email protected]

Leave a Reply

Your email address will not be published.

Get the latest posts from Nexmo’s next-generation communications blog delivered to your inbox.

By signing up to our communications blog, you accept our privacy policy , which sets out how we use your data and the rights you have in respect of your data. You can opt out of receiving our updates by clicking the unsubscribe link in the email or by emailing us at [email protected].