Sign in

v1

latestOpenAPI 3.0.32026-07-24156161.2 MB
Streams

Add stream

Create a new stream. name is required; other fields are optional and depend on the stream type.

Authentication: TextPeak API key in the Authorization header (see Authentication in the API Overview).

post/streams

Request body

namestring required

Stream name.

descriptionstring

Free-text description.

type'MARKETING' | 'TRANSACTIONAL' | 'OTP' | 'TWO_WAY' | 'WHATSAPP_BUSINESS' | 'WHATSAPP_PRIVATE' | 'TELEGRAM_BOT' | 'TELEGRAM_PRIVATE' | 'WEBSOCKET' | 'VOICE'

Stream type.

paramsobject

Type-specific configuration; the accepted keys depend on the stream type.

ipAclstring

Comma/space-separated IP allow-list restricting where this stream may be used.

state'READY' | 'SENDING' | 'DRAFT' | 'DISABLED' | 'RESTRICTED'

Stream state.

Example request

{
  "name": "Marketing UK",
  "description": "Outbound marketing to UK contacts",
  "type": "MARKETING",
  "ipAcl": "192.0.2.10",
  "state": "READY"
}

Response

The created stream.

idinteger

Unique stream identifier.

streamUidstring

Opaque stream UID.

namestring

Stream name.

descriptionstring

Free-text description.

type'MARKETING' | 'TRANSACTIONAL' | 'OTP' | 'TWO_WAY' | 'WHATSAPP_BUSINESS' | 'WHATSAPP_PRIVATE' | 'TELEGRAM_BOT' | 'TELEGRAM_PRIVATE' | 'WEBSOCKET' | 'VOICE'

Stream type.

callerIdstring

Caller ID — present only for VOICE streams.

ipAclstring

Comma/space-separated IP allow-list.

state'READY' | 'SENDING' | 'DRAFT' | 'DISABLED' | 'RESTRICTED'

Stream state.

Example response

{
  "id": 5,
  "streamUid": "9f1c2d3e4b5a6789c0d1e2f3a4b5c6d7",
  "name": "Marketing UK",
  "description": "Outbound marketing to UK contacts",
  "type": "MARKETING",
  "callerId": "447700900123",
  "ipAcl": "192.0.2.10",
  "state": "READY",
  "streamTags": [
    {
      "id": 12,
      "value": "vip"
    }
  ]
}