Skip to main content

Start

Definition​

The Start verb is used to start a unidirectional media Stream. A unidirectional stream is when CarrierX sends the call audio stream to your application, but your application cannot send an audio stream to the call. The name of the Stream is used when starting and stopping the Stream.

tip

See Stream for full details on streaming call audio via WebSockets.

Use Stop to stop a Stream.

Start has no attributes.

Example​

In this example, the Start verb is used to start a unidirectional Stream. The name of the Stream is used to identify which stream to start.

<Response>
  <Start>
    <Stream name="myStream" url="wss://example.com"/>
  </Start>
</Response>

Nesting Rules​

  • You can nest Stream within the Start verb.
  • You cannot nest the Start verb within other FlexML verbs.