The Streams API in the CommPeak SMS platform provides two-way routes for sending messages to customers and receiving replies from them.
This article will walk you through creating a two-way SMS stream step by step.
To start, select Streams API in the main menu on the left and click Create Streams API on the open page. Then, choose SMS Two-Way in the pop-up window.
The Create New Stream wizard will load. Fill in the necessary information to complete each step.
Step 1: Stream API Details
Start with entering stream details.
Stream API name - enter a meaningful name to locate the stream quickly.
Stream API description - provide more information that will be visible when you open the stream.
Add IP - add one or more IP addresses from which you will make API calls. To add an IP, enter it and click Add.
Tags - create tags and apply them immediately to categorize your streams and quickly find the ones you need (optional).
Default sender -
you can use one of the following options:
leave it Customized to choose a specific Sender ID from available ones in each request
select a specific Sender ID from the drop-down list
add a new Sender ID, and use it.
Click Save & Next to proceed to the next step.
NOTE
You can save the stream as a draft on each step and then complete the rest at any time later.
Step 2: Incoming Messages Webhook (optional)
Create a webhook right away to receive messages through the API.
URL - select the GET or POST method and enter the URL to which you want to send data.
HTTP Headers - optionally, provide the key name and value.
You can skip this step for now. Otherwise, click Save & Next to proceed to the next step.
Step 3: Stream Summary
You can review stream details here.
The API event requests preview is available on the right. You can copy the endpoint or request body immediately.
Send Request
Status Request
After you click Create Stream, a pop-up appears. You can copy your authorization token here.
Finally, click Done. The new stream will appear at the top of your Streams API table.