Skip to content
Twilio CLI plugin for generating access tokens for Twilio Chat, Video, etc.
JavaScript Batchfile
Branch: master
Clone or download
Latest commit 8fbdf77 Sep 9, 2019

README.md

@twilio/plugin-token

Generate a temporary token for use in a Twilio client-side SDK application

Requirements

Setup

Head over to the twilio-cli documentation.

Usage

$ twilio plugins:install @twilio-labs/plugin-token
$ twilio --help token
USAGE
  $ twilio token
...

Commands

twilio token:capability:client

USAGE
  $ twilio token:capability:client

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 Twilio profile.
  --allow-incoming=true|false      [default: true] Allow incoming calls (true/false) (defaults to true)
  --identity=identity              (required) The user identity
  --ttl=ttl                        Optional TTL for token (up to 24 hours) (value in seconds)
  --voice-app-sid=voice-app-sid    (required) The TwiML Application SID for outbound calls, starts with APXXX

See code: src/commands/token/capability/client.js

twilio token:capability:worker

USAGE
  $ twilio token:capability:worker

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 Twilio profile.
  --ttl=ttl                        Optional TTL for token (up to 24 hours) (value in seconds)
  --worker-sid=worker-sid          (required) The Worker SID for this token
  --workspace-sid=workspace-sid    (required) The Workspace SID for this token

See code: src/commands/token/capability/worker.js

twilio token:chat

USAGE
  $ twilio token:chat

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 Twilio profile.
  --chat-service-sid=chat-service-sid  (required) The service SID for the Chat, starts with ISXXX
  --identity=identity                  (required) The user identity
  --ttl=ttl                            Optional TTL for token (up to 24 hours) (value in seconds)

See code: src/commands/token/chat.js

twilio token:flex

USAGE
  $ twilio token:flex

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 Twilio profile.
  --ttl=ttl                        Optional TTL for token (up to 24 hours) (value in seconds)
  --worker-sid=worker-sid          (required) The Worker SID for this token
  --workspace-sid=workspace-sid    (required) The Workspace SID for this token

See code: src/commands/token/flex.js

twilio token:video

USAGE
  $ twilio token:video

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 Twilio profile.
  --identity=identity              (required) The user identity
  --room-name=room-name            The name of the room this token grants access to
  --ttl=ttl                        Optional TTL for token (up to 24 hours) (value in seconds)

See code: src/commands/token/video.js

twilio token:voice

USAGE
  $ twilio token:voice

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 Twilio profile.
  --allow-incoming=true|false      [default: true] Allow incoming calls (true/false) (defaults to true)
  --identity=identity              (required) The user identity
  --ttl=ttl                        Optional TTL for token (up to 24 hours) (value in seconds)
  --voice-app-sid=voice-app-sid    (required) The TwiML Application SID for outbound calls, starts with APXXX

See code: src/commands/token/voice.js

Contributing

This project welcomes contributions from the community. Please see the CONTRIBUTING.md file for more details.

Code of Conduct

Please be aware that this project has a Code of Conduct. The tldr; is to just be excellent to each other ❤️

License

MIT

You can’t perform that action at this time.