Documentation
Log InRequest Live Demo

Creating Two-Way Streams

This article will walk you through creating an two-way SMS stream step by step.

Suggest Edits

Streams API in the CommPeak SMS platform provides two-way routes that deliver one-time passwords to users.

To start, select Streams API in the main menu on the left and click Create Streams API on the page that opens. Then, choose OTP in the pop-up window.

Stream type options: Two-Way

Stream type options: Two-Way

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 drop-down list

    • add a new Sender ID and use it.

Click Save & Next to proceed to the next step.

You can also enable the Demo Sending option to create a demo channel that simulates messaging flows without sending real messages. This option can be useful for testing and development use cases and is available for any stream type.

Screenshot of enablinbg Demo sending option

Enabling the Demo Sending option

📘

NOTE

Check the Creating Demo Channels section to learn more.


📘

NOTE

You can save the stream as a draft on each step and then complete the rest at any time later.

Screenshot of the drafted SMS Two-Way stream

Draft SMS Two-Way steram

Step 2: Incoming Messages Webhook (optional)

Create a webhook right away to receive messages through the API.

  • URL - select the GET or POST method and enter the URL to which you want to send data.

  • HTTP Headers - optionally, provide the key name and value. You can skip this step for now. Otherwise, click Save & Next to proceed to the next step.

You can skip this step for now. Otherwise, click Save & 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.

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

Updated 3 days ago