Skip to main content
All CollectionsCommPeak PortalSMS Services
Using the Streams SMS API in the CommPeak Portal
Using the Streams SMS API in the CommPeak Portal
Updated over a week ago

You can send one or multiple messages using Streams SMS API service in your CommPeak Portal account. Use available API tokens to authenticate your API requests or create new tokens.

We strongly recommend that before you start using the SMS API, you review the related API documentation.

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.

To use default tokens:

  1. 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.

  2. Click the pencil icon to change the stream name and add one or more IP addresses from which you will make API calls.

  3. To add an IP, enter it and click +. Then click Save.

  4. Click the eye icon to show the token and copy it for use.

Creating New API Tokens

To create an API token:

  1. Click on the plus sign next to the number of available streams.

  2. In the pop-up window on the right, enter the name of the new stream.

  3. In the Stream Type field, select one of the options. You can learn more about SMS route types from our Comprehensive Guide.

  4. In the IP ACL field, you can add one or more IPs that will be allowed to access the API using this authentication token.

  5. Click CREATE SMS STREAM TOKEN at the bottom of the page.
    The stream will be added to the list.

  6. 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 to use it on your API tool.
    You will find further instructions about creating API requests in our API documentation.

  7. Later, you can click the edit icon and change the stream name and allowed IPs.

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.

After you have created API streams, you can send test messages to ensure the service works well.

Did this answer your question?