@twilio-labs/plugin-rtc

This plugin adds functionality to the Twilio CLI which supports developing and deploying real-time communication apps.

Getting Started
Supported Apps
Commands

Getting Started

Install the Twilio CLI

Via npm or yarn:

$ npm install -g twilio-cli
$ yarn global add twilio-cli

Via homebrew:

$ brew tap twilio/brew && brew install twilio

See the Twilio CLI documentation for more information.

Install the plugin for general use

The following step will install the plugin from NPM and is recommended if you are interested in trying out the commands in the latest release.

$ twilio plugins:install @twilio-labs/plugin-rtc

Install the plugin for local development

The following step will install the plugin from a local directory. Use this option if you are interested in modifying the plugin and testing it out from the Twilio CLI.

$ twilio plugins:link /path/to/plugin-rtc

Supported Apps

This plugin currently supports the following applications:

Twilio Video App

A mobile and web collaboration application built with Twilio Programmable Video. Visit the projects below for instructions on how to use this plugin to build and deploy the Twilio Video app.

Token Server API Documentation

The following section documents the application token server used to provide Programable Video access tokens to supported Twilio Video applications. The token server is deployed as a Twilio Function.

Method	URL
POST	`/token`

Authentication

The application token server requires an authentication mechanism to be specified when deploying. The following section documents each support authentication mechanism.

Passcode

Each request is verified using a passcode generated at deploy time. Passcodes remain valid for one week. After the passcode expires, users can redeploy an application and a new passcode will be generated. The snippet below provides an example request body used by a supported application.

{
  "passcode": "1234564321",
  "user_identity": "User",
  "room_name": "Demo",
}

Token

Returns a Programmable Video Access token.

POST /token

Parameters

Name	Type	Description
`passcode`	`string`	Required. The application passcode.
`user_identity`	`string`	Required. The user's identity.
`room_name`	`string`	A room name that will be used to create a token scoped to connecting to only one room.

Success Responses

Status	Response
200	{ "token": "0000000000000000.0000000000000000000000.00000000000000000" }

Error Responses

Status	Response
400	{ "error": { "message": "missing user_identity", "explanation": "The user_identity parameter is missing." } }
401	{ "error": { "message": "passcode expired", "explanation": "The passcode used to validate application users has expired. Re-deploy the application to refresh the passcode." } }
401	{ "error": { "message": "passcode incorrect", "explanation": "The passcode used to validate application users is incorrect." } }

Commands

twilio rtc:apps:video:delete
twilio rtc:apps:video:deploy --authentication <auth>
twilio rtc:apps:video:view

`twilio rtc:apps:video:delete`

Delete a Programmable Video app

USAGE
  $ twilio rtc:apps:video:delete

OPTIONS
  -l=(debug|info|warn|error|none)  [default: info] Level of logging messages.
  -o=(columns|json|tsv)            [default: columns] Format of command output.
  -p, --profile=profile            Shorthand identifier for your profile.

EXAMPLE
  $ twilio rtc:apps:video:delete
  Removed app with Passcode: 1111111111

`twilio rtc:apps:video:deploy --authentication <auth>`

Deploy a Programmable Video app

USAGE
  $ twilio rtc:apps:video:deploy --authentication <auth>

OPTIONS
  -l=(debug|info|warn|error|none)  [default: info] Level of logging messages.
  -o=(columns|json|tsv)            [default: columns] Format of command output.
  -p, --profile=profile            Shorthand identifier for your profile.
  --app-directory=app-directory    Name of app directory to use
  --authentication=(passcode)      (required) Type of authentication to use
  --override                       Override an existing App deployment

DESCRIPTION
  This command publishes two components as a Twilio Function: an application token
  server and an optional React application.

  Token Server
  The token server provides Programmable Video access tokens and authorizes
  requests with the specified authentication mechanism.

  React Application
  The commands includes support for publishing a Programmable Video React
  Application. For more details using this plugin with the Programmable Video
  React application, please visit the project's home page.
  https://github.com/twilio/twilio-video-app-react

EXAMPLES
  # Deploy an application token server with passcode authentication
  $ twilio rtc:apps:video:deploy --authentication passcode
  deploying app... done
  Passcode: 1111111111

  # Deploy an application token server with the React app
  $ twilio rtc:apps:video:deploy --authentication passcode --app-directory /path/to/app
  deploying app... done
  Web App URL: https://video-app-1111-dev.twil.io?passcode=1111111111
  Passcode: 1111111111

  # Override an existing app with a fresh deployment
  # Please note that this will remove a previously deployed web application if no
  # app directory is provided
  $ twilio rtc:apps:video:deploy --authentication passcode --override 
  Removed app with Passcode: 1111111111
  deploying app... done
  Passcode: 2222222222
  Expires: Mon Mar 09 2020 16:36:23 GMT-0600

`twilio rtc:apps:video:view`

View a Programmable Video app

USAGE
  $ twilio rtc:apps:video:view

OPTIONS
  -l=(debug|info|warn|error|none)  [default: info] Level of logging messages.
  -o=(columns|json|tsv)            [default: columns] Format of command output.
  -p, --profile=profile            Shorthand identifier for your profile.

EXAMPLE
  $ twilio rtc:apps:video:view
  Web App URL: https://video-app-1111-dev.twil.io?passcode=1111111111
  Passcode: 1111111111

timmydoza / plugin-rtc