Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

ParameterDescription
channelId(optional) A unique ID to assign to the channel. One will be generated by Asterisk if not supplied.
app(required) The Stasis application.
variables(optional) A JSON object containing any variables you wish added to the channel.
external_host(required) The media destination as <host>:<port>. You can supply an IP address or hostname for host.
Be aware though that DNS queries must be done synchronously so the response to the post request may be delayed.
encapsulation

(optional) The media encapsulation desired.
With the first release of this capability, only rtp is supported as an encapsulation and that is the default if not supplied. Others may be supported in the future.
The rtp encapsulation will produce packets with a standard rtp header.

transport

(optional) The network transport desired.
With the first release of this capability, only UDP is supported and that is the default if not supplied.
In the future, it's expected that TCP, TLS and WebSockets will be supported.

connection_type

(optional) The connection type (client/server) desired.
With the first release of this capability, only client is supported and that is the default if not supplied. In this mode, Asterisk initiates the connection to the external host.
When server is supported, Asterisk will return an ip address and port in the response for your application to connect to to receive the media.

format

(required) The format/codec you wish the media to be encoded in.
Any standard format/codec supported by Asterisk is supported here. For example: ulaw, g722, etc.
There is no negotiation. The format you specify is the format you'll get.
The channel driver will automatically transcode the bridge's native media into this format.

direction(optional) The media direction (in/out/both) desired.
With the first release of this capability, only both is supported and that is the default if not supplied.
In this mode, media can flow in both direction on the External Media channel.

All parameters except variables can be supplied as part of the POST's query string.  Because it's a JSON object, variables MUST be supplied on the request body.  This is similar to other channel creation calls.

...