Streams API in the CommPeak SMS platform provides the following SMS routes:
marketing routes that you can use for sending promotional messages, product update announcements, reminders, and more
transactional routes that usually channel automated texts generated in response to specific customer actions
OTP routes that deliver one-time passwords to users
two-way routes that allow for communication in both directions
WhatsApp routes for interacting with the WhatsApp platform
You can read more and get advice on choosing the right route type in our Comprehensive Guide.
NOTE
Streams API is also available in your CommPeak Portal account.
Getting Started with Streams API
Once you've made your choice, you can start creating your first route using CommPeak Streams API:
Click Streams API in the main menu on the left.
On the page that opens, click Create Streams API.
Choose a stream type.
Depending on your choice, perform the steps described in the dedicated articles:
Streams API Page
Click Streams API in the main menu on the left to open the Streams API page. It lists all SMS streams that you have created and their total amount.
To define your search, apply name, status, or tag filters at the top.
Scroll between the pages by clicking the navigation links in the bottom right corner.
The following table contains column explanations.
Column | Description |
Name | A stream name combines any letters, numbers, or symbols. Click on the name to open a side panel with the following tabs:
For more details, please take a look at the sections below. |
Status |
|
Tags | Tags that you applied to the stream in the first step of its creation |
Type | Marketing, Transactional, OTP, Two-way or WhatsApp |
Allowed IPs | One or more IP addresses that you allowed to make API calls |
Default Sender | Customized or a Sender ID that you added when creating the stream |
Last Activity |
|
Action | Click the three dots menu to perform the following actions:
|
Streams API Data
A side panel opens on the right after you click the stream name in the table on the Stream API page. It contains the following tabs, each with additional settings depending on the stream type.
Info
To edit stream details and view its statistics, click its name and then go to the Info tab.
Settings
Click the pencil icon to modify OTP settings.
Events
Add new event templates for transactional and OTP streams.
Click the pencil icon to update the WhatsApp authentication token.
Webhooks
Copy the endpoint and request body for webhooks you created in two-way or WhatsApp streams.
Request API
Copy the endpoint and request body.
Realtime
The Realtime Performance page shows live stream activity with the possibility of filtering by names, statuses, or tags.