Messages API Overview
| This API is currently in BETA and as such requires that your account is enabled for this API or a specific channel. Please contact your account manager to be granted access and participate in our BETA program. |
CPaaS will expand the capabilities of the API and always welcomes your feedback.
Introduction
CPaaS Messages API is an Omnichannel Messaging RESTful API that allows businesses to communicate with customers on their favorite channels thus delivering better and secure customer experiences and engagement increasing brand visibility
The Messages API allows you to send outbound messages, also known as Application to Person (A2P) - and/or receive incoming customer messages, also known as Person to Application (P2A) - across various popular messaging channels supported by the platform.
Channels that are currently supported by the Messages API and planned to be added are listed below:
-
SMS
-
MMS
-
WhatsApp – Coming Soon
-
RCS Business Messaging – Coming Soon
-
Email – Coming Soon
-
Apple Messages for Business – Coming Soon
-
Push Notifications (Android, iOS, Web) – Coming Soon
-
Facebook Messenger – Coming Soon
-
Twitter DM – Planned
-
WeChat – Planned
-
Line – Planned
-
Instagram Business – Planned
-
Telegram – Planned
-
Viber Business – Planned
| Additional channels will be supported as they become popular |
This API is meant to be generic so that as new channels are added, the API stays the same and minimum changes are required from a development perspective to integrate them allowing a faster time to market to reach additional customers on their favourite channel. It is also meant to be flexible so that full control over channel specific features can be provided to deliver a powerful rich media experience to customers.
The benefits of this approach are that a developer needs to only become familiar with one Messaging API to send and receive messages across all supported channels while offering full control over channel specific features.
How Does the Messages API Work?
Message body, images, audio, video files and location are message channel features and functions that are relevant for all channels and they are supported through build in transcoding. For others that are specific to a given channel, the API provides the ability to specify an exact layout for the channel feature you are interested in such as WhatsApp Quick Replies, RCS Carousel, …
Media Retention
In an A2P scenario, the media content (images, audio, video, etc) is provided by the CPaaS Application, and as such not stored on the CPaaS Service. The content should be publicly accessible, and the retention is managed by the CPaaS Application Developer.
In a P2A scenario, the media content is stored by the channel provider, and as such is channel provider dependent. The retention varies per channel provider. The table below describes the retention period per channel provider.
| Channel | Retention Period |
|---|---|
MMS |
2 Days |
14 Days |
| If you need a longer retention period, you can download and manage the content on your infrastructure. |
MMS File Size Limits for the Major Carriers in the US
| Carrier | Long Code | Short Code | Toll-Free |
|---|---|---|---|
AT&T |
1 MB |
1 MB |
525 KB |
Verizon |
1.2 MB |
1.2 MB |
525 KB |
T-Mobile |
1 MB |
1 MB |
525 KB |
Sprint |
2 MB |
2 MB |
525 KB |
US Cellular |
500 KB |
500 KB |
525 KB |
| The file sizes above will generally be passed along to the wireless carriers. However, due to the differences in handsets, file types, and transcoding, we recommend you send attachments no larger than 500 KB to ensure the best chance of delivery. |
Get Started
To Get Started and engage your customers through an Omnichannel Experience, please head to our Messages API Documentation.