The Streams API in the CommPeak multi-channel messaging platform supports voice streams, which deliver one-time passwords and other voice-based notifications to your recipients over a dedicated SIP account.

A voice stream creates a SIP account behind the scenes in your CommPeak environment. You select a Caller ID from the numbers already available under your CommPeak Portal, and the stream becomes available to select as a Voice channel provider in the Omnichannel OTP Configurations.

📘

NOTE

A voice stream is currently scoped to OTP delivery. The underlying SIP account is a regular one and may support additional use cases in the future.

Creating Voice Streams

To create a voice stream:

1. Log in to TextPeak in your browser.
2. Click Streams API in the main menu on the left.
3. Click Create stream API in the top right corner.

4. In the Choose stream type dialog, expand Voice and select it.

🚧

BETA

Voice streams are currently in beta.

5. The Create New Stream | Voice page opens.
6. Complete each section to set up the stream.

Step 1: Stream API Details

1. Enter the basic stream information:

• Stream API name: enter a meaningful name to locate the stream quickly.

• Stream API description: optionally, provide more information that will be visible when you open the stream.

• Tags: optionally, create or select tags to categorize your streams. To add a tag, enter it in the field and select it from the drop-down list.

2. To test the stream without sending real calls, select Use Demo Sending under Simulate message delivery without sending real messages.
3. Click Save & Next.

📘

NOTE

Saving this step creates a draft. You can return to complete the rest at any time.

Step 2: Voice settings

Choose the Caller ID that recipients see when they receive a voice call from this stream.

1. Open the Caller ID drop-down list.

📘

NOTE

The caller IDs are not the senders but dedicated IDs configured in the Portal account.

2. Select a number from the list of numbers configured under your CommPeak portal: this will automatically create a dedicated SIP Account.

3. Click Save & Next.

📘

Caller ID source

The drop-down lists numbers configured under your CommPeak Portal account.

To add new numbers, see the DID Numbers documentation.

4. Review the stream details and voice settings and confirm by clicking Create stream.

5. In the popup window that appears, click Confirm.

6. The voice stream is created and appears at the top of your Streams API table. It's now available to select as the voice channel provider in your Omnichannel OTP Configurations.

🚧

LIMITATION

You can't delete the SIP account that a voice stream creates. Editing options for its rules are limited.

Related articles

• Omnichannel OTP Configurations
• Getting Started with Streams API
• Creating Transactional Streams.