Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Update to GIT-17-44068cc

...

GET

/channels

List[Channel]

List all active channels in Asterisk.

POST

/channels

Channel

Create a new channel (originate).

POST

/channels/create

Channel

Create channel.

GET

/channels/{channelId}

Channel

Channel details.

POST

/channels/{channelId}

Channel

Create a new channel (originate with id).

DELETE

/channels/{channelId}

void

Delete (i.e. hangup) a channel.

POST

/channels/{channelId}/continue

void

Exit application; continue execution in the dialplan.

POST

/channels/{channelId}/move

void

Move the channel from one Stasis application to another.

POST

/channels/{channelId}/redirect

void

Redirect the channel to a different location.

POST

/channels/{channelId}/answer

void

Answer a channel.

POST

/channels/{channelId}/ring

void

Indicate ringing to a channel.

DELETE

/channels/{channelId}/ring

void

Stop ringing indication on a channel if locally generated.

POST

/channels/{channelId}/dtmf

void

Send provided DTMF to a given channel.

POST

/channels/{channelId}/mute

void

Mute a channel.

DELETE

/channels/{channelId}/mute

void

Unmute a channel.

POST

/channels/{channelId}/hold

void

Hold a channel.

DELETE

/channels/{channelId}/hold

void

Remove a channel from hold.

POST

/channels/{channelId}/moh

void

Play music on hold to a channel.

DELETE

/channels/{channelId}/moh

void

Stop playing music on hold to a channel.

POST

/channels/{channelId}/silence

void

Play silence to a channel.

DELETE

/channels/{channelId}/silence

void

Stop playing silence to a channel.

POST

/channels/{channelId}/play

Playback

Start playback of media.

POST

/channels/{channelId}/play/{playbackId}

Playback

Start playback of media and specify the playbackId.

POST

/channels/{channelId}/record

LiveRecording

Start a recording.

GET

/channels/{channelId}/variable

Variable

Get the value of a channel variable or function.

POST

/channels/{channelId}/variable

void

Set the value of a channel variable or function.

POST

/channels/{channelId}/snoop

Channel

Start snooping.

POST

/channels/{channelId}/snoop/{snoopId}

Channel

Start snooping.

POST

/channels/{channelId}/dial

void

Dial a created channel.

GET

/channels/{channelId}/rtp_statistics

RTPstat

RTP stats on a channel.

POST

/channels/externalMedia

ExternalMedia

Start an External Media session.

Anchor
list
list

list: GET /channels

...

  • 404 - Channel cannot be found.

Anchor
externalMedia
externalMedia

externalMedia: POST /channels/externalMedia

Start an External Media session. Create a channel to an External Media source/sink.

Query parameters

  • channelId: string - The unique id to assign the channel on creation.
  • app: string - (required) Stasis Application to place channel into
  • external_host: string - (required) Hostname/ip:port of external host
  • encapsulation: string - Payload encapsulation protocol
    • Default: rtp
    • Allowed values: rtp
  • transport: string - Transport protocol
    • Default: udp
    • Allowed values: udp
  • connection_type: string - Connection type (client/server)
    • Default: client
    • Allowed values: client
  • format: string - (required) Format to encode audio in
  • direction: string - External media direction
    • Default: both
    • Allowed values: both

Body parameter

  • variables: containers - The "variables" key in the body object holds variable key/value pairs to set on the channel on creation. Other keys in the body object are interpreted as query parameters. Ex. { "endpoint": "SIP/Alice", "variables": { "CALLERID(name)": "Alice" } }

Error Responses

  • 400 - Invalid parameters
  • 409 - Channel is not in a Stasis application; Channel is already bridged