Using the Multi-channel Messaging API
Webex Connect allows you to send messages to your customers across communication channels by using a single unified multi-channel messaging API.
You can send messages across multiple channels including SMS, Voice, Email, Live Chat, In-app Messaging, Push Notifications, Facebook Messenger, Whatsapp, Apple Messages for Business, Google Business Messages and more using the Messaging Rest API of Webex Connect.
Prerequisites
A login credentials to access Webex Connect.
A service created must be in Live state.
Before using the API you will need setup a service and fetch the unique service key for authentication purposes. In addition to that you will also need to setup the required assets for each channel under numbers and apps.
Fetching the Unique Service Key
Each service in Webex Connect has a Unique Service Key associated with it. This is required when using the messaging APIs, event APIs, or flows. You can access the service key under the Messaging API section on the service dashboard.
You can copy the key or use Run in Postman button to directly open the postman collection for testing.
Note: Service key is used to identify incoming API calls for messaging and event APIs.
Messaging API
The Messaging API is a single API with individual channel objects that allows third party/external applications to make outbound messaging requests using a RESTful API over HTTPS to the Webex Connect platform.
The API itself supports the following capabilities across different channels -
| Sno | Channel | Details |
|---|---|---|
| 1 | SMS | Concatenated long messages of up to 1024 characters in any language with alpha number sender ID support. Message types supported: Text Flash Binary Unicode |
| 2 | Voice | Out bound voice calls using any call flow setup on the platform or by media supplied with preferred CLI number setting. |
| 3 | In-app Messaging | Interactive rich multimedia messages with text and optional media items. Supporting for most of the popular image,audio and video MIME types. |
| 4 | Push Notifications | Interactive app push notifications on Android and iOS with options to set a collapse key, time to live, custom notification sound. The API also supports deep link, opening URLs, sharing, topics,segments and bulk messaging. |
| 5 | Facebook Messenger | All messenger templates upto v 1.4 update including Templates generic button receipt airlinetemplatesMessage Attachments image video audio file |
| 8 | Apple Business Chat | Text messaging |
Updated 4 months ago