Managing Channels (Streams) in the CommPeak Portal

View every messaging channel on your account and create, edit, reset, or delete SMS stream API tokens from the Channels (Streams) page.

The Channels (Streams) page in the CommPeak Portal lists every messaging channel on your account and lets you manage the API tokens of your messaging streams without leaving the Portal. Use these tokens to authenticate requests to the Streams API.

❗️

IMPORTANT

Review the TextPeak Streams API overview before you start sending messages through the API.

Before you start, activate the SMS service as described in SMS Service Activation.

Channels (Streams) page

To open the Channels (Streams) page:

Open Channels (Streams)

Expand Messaging in the main menu and select Channels (Streams).

Screenshot of the Messaging menu in the CommPeak Portal with Messaging Campaigns selected

Messaging Campaigns menu tab

Review your channels

The Channels (Streams) page opens with the list of your channels.

Screenshot of the Channels (Streams) page showing SMS streams, a WhatsApp channel, and the Resources panel

Channels (Streams) page

The page covers SMS, WhatsApp, Telegram, Email, Voice, and WebChat channels. You manage SMS stream tokens here, and every other channel type in TextPeak, messaging platform.

Channels table

Download CSV
ColumnDescription
NameThe channel name, with its stream type underneath.
Channel typeThe channel type, for example SMS Marketing, SMS OTP, SMS Two Way, or WhatsApp.
SenderThe sender ID assigned to the channel.
TrafficWhether the channel has carried traffic. New channels show No traffic yet.
Last sentThe date and time of the last message sent through the channel.
API tokenThe channel's API token, hidden by default.
IP ACLThe IP addresses allowed to call the API with this token. 0.0.0.0/0 means any IP address can use it.

Click the Name, Channel type, Traffic, or Last sent column title to sort the table.

SMS streams show the token actions: Reset Token, the pencil icon, and the trash icon. Channels of other types show Manage in SMS Platform instead, which opens the channel in TextPeak.

Viewing an API token

Click the eye icon in the API token column to show the token, and then copy it into your API tool.

🚧

WARNING

Anyone with the token can send messages that are charged to your account. Store it securely, and restrict its use to your own servers with the IP ACL setting.

Creating an SMS stream token

Create a stream token

Click Create SMS Only Stream Token in the top right corner of the page.

Screenshot of the Create SMS Stream API Token button

Create SMS Stream API Token button

Name the stream

In the Create SMS stream token sidebar, enter a Name for the stream.

Select the stream type

In the Stream Type drop-down, select Streams Channel - Transactional, Streams Channel - Marketing, or Streams Channel - Two way SMS. For help choosing, see Messaging Route Types: A Comprehensive Guide.

Add IP addresses

Under IP ACL, enter an IP address in Classless Inter-Domain Routing (CIDR) format, for example 203.0.113.10/32 for a single address, and click Add. Repeat for each address that will call the API.

Restrict the token

To restrict the token to the addresses you added, click the x on the 0.0.0.0/0 entry to remove it.

Screenshot of the Create SMS stream token sidebar with the Name, Stream Type, and IP ACL fields filled in

Create SMS stream token sidebar

Create the token

Click Create SMS Stream Token. The new stream appears in the channels table.

Editing an SMS stream token

Edit the stream

Click the pencil icon on the stream's row.

Update the details

In the Update SMS stream token sidebar, change the Name or the IP ACL list. The Traffic Type is set when the stream is created and cannot be changed.

Screenshot of the Update SMS stream token sidebar showing the Name, Traffic Type, and IP ACL fields

Update SMS stream token sidebar

Save the token

Click Save SMS Stream Token.

Resetting or deleting an SMS stream token

  • To issue a new token, click Reset Token on the stream's row, and then click OK in the confirmation window.
  • To remove a stream, click the trash icon on its row, and then click OK in the confirmation window.

Managing other channel types

WhatsApp, Telegram, Email, Voice, and WebChat channels are created and configured in TextPeak. Click Manage all channels in SMS Platform to open the TextPeak Channels page, or Manage in SMS Platform on a channel's row to open that channel.

For what each channel type carries, with a link to the setup guide for each one, see the TextPeak Channels article. To add or remove the sender IDs your channels can use, see Sender IDs.

👍

TIP

Below the list of your Streams API, you can see links that you can use to learn more about TextPeak - CommPeak's messaging platform.
TextPeak is a tool for creating Messaging Channels and SMS campaigns with a variety of customization options for your messages.

Screenshot of Resources section

Resources links

To start using TextPeak, click Manage all channels in SMS Platform.

Screenshot of the Manage all channels in SMS Platform button

Manage all channels in SMS Platform button

Next steps

After you create a stream, send a test message to check that the service works. To send one-time passwords over SMS, WhatsApp, and Voice from one endpoint, see OTP Verification API in the CommPeak Portal.



Did this page help you?