Streams API in the CommPeak SMS platform provides transactional routes that are good for sending notifications, reminders, alerts, or any other message based on user/customer action.
To start, select Streams API in the main menu on the left and click Create Streams API on the page that opens. Then, choose Transactional 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 be able to choose a specific Sender ID from available ones in each request
select a specific Sender ID from the dropdown 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: Message Content
Create message content for this stream by adding one or more templates dedicated to certain events. Click the plus icon to expand the event creation section.
Enter event data:
Event name - create a meaningful name to locate the stream quickly.
Event key - add a unique key that will identify the event. Click the information icon for reference on allowed characters.
Event message template - enter text that will be sent to your subscribers.
The UTF8 indicator will alert you if you use non-Unicode characters. The single SMS limit will decrease to 70 characters.
Below the message box, you can see tags. They are pulled from contact parameters and used as variables to enable sending personalized messages. For example, you can add the Name tags, which will include the contact's first or last name in your message.
To add a tag, place the cursor in the needed place of your message and click on the tag.
Click Create Template.
Click Next to proceed to the next step.
Step 3: Stream Summary
You can review stream details here.
On the right, the API requests' preview is available. You can copy the endpoint or request body right away.
Event 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.