Launch CommPeak's Streams SMS API: Activate the SMS service, create or use default API tokens, and configure stream settings to authenticate and send SMS messages via API.
You can send one or multiple messages using the Streams SMS API service in your CommPeak Portal account. Use available API tokens to authenticate your API requests or create new tokens.
❗️
IMPORTANT
We strongly recommend reviewing the related API documentation before you start using the SMS API.
The first step is activating the SMS service described in the Getting Started article.
Using Default API Tokens
On the SMS Platform and SMS API page, you can find tokens automatically created on service activation that are ready for use. Click the eye icon to show the token and then copy it for future use.
To use default tokens:
After the SMS service activation, expand SMS in the main menu and select SMS Platform. You can find default tokens on the SMS Platform and SMS API page.
SMS Platform tab
Click the pencil icon to change the stream name and add one or more IP addresses from which you will make API calls.
SMS Platform and SMS API page
To add an IP, enter it and click +. Then click Save.
Edit SMS Stream Token section
Click the eye icon to show the token and copy it for use.
Unhide and copy token button
Creating New API Tokens
To create an API token:
Click on the plus sign next to the number of available streams.
Plus sign
In the pop-up window on the right, enter the name of the new stream.
Create SMS Stream Token button
In the Stream Type field, select one of the options.
You can learn more about SMS route types from our Comprehensive Guide.
In the IP ACL field, you can add one or more IPs that will be allowed to access the API using this authentication token.
Click CREATE SMS STREAM TOKEN at the bottom of the page. The stream will be added to the list.
Click the eye icon on the needed line in the API Token field to get the token. This will reveal it. Then, you can copy it and use it on your API tool. You will find further instructions about creating API requests in our API documentation.
Later, you can click the edit icon and change the stream name and allowed IPs.
👍
TIP
Below the list of your API streams, you can see links that you can use to learn more about TextPeak - CommPeak's SMS platform.
TextPeak is a tool for creating SMS campaigns with a variety of customization options for your messages.
To start using TextPeak, click Login to TextPeak.
Login to TextPeak button
After you have created API streams, you can send test messages to ensure the service works well.
