@twilio/plugin-token

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

• Requirements
• Usage
• Commands
• Contributing
• License

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
• twilio token:capability:worker
• twilio token:chat
• twilio token:flex
• twilio token:sync
• twilio token:video
• twilio token:voice

twilio token:capability:client

USAGE
  $ twilio token:capability:client --voice-app-sid <value> --identity <value> [-l (debug|info|warn|error|none)] [-o
    (columns|json|tsv|none)] [--silent] [-p <value>] [--allow-incoming true|false] [--push-credential-sid <value>]
    [--ttl <value>]

FLAGS
  -l=(debug|info|warn|error|none)    [default: info] Level of logging messages.
  -o=(columns|json|tsv|none)         [default: columns] Format of command output.
  -p, --profile=<value>              Shorthand identifier for your profile.
      --allow-incoming=<option>      [default: true] Allow incoming calls (true/false) (defaults to true)
                                     <options: true|false>
      --identity=<value>             (required) The user identity
      --push-credential-sid=<value>  The Push Credential SID for receiving incoming call push notifications, starts with
                                     CRXXX
      --silent                       Suppress  output and logs. This is a shorthand for "-l none -o none".
      --ttl=<value>                  Optional TTL for token (up to 24 hours) (value in seconds)
      --voice-app-sid=<value>        (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 --worker-sid <value> --workspace-sid <value> [-l (debug|info|warn|error|none)] [-o
    (columns|json|tsv|none)] [--silent] [-p <value>] [--ttl <value>]

FLAGS
  -l=(debug|info|warn|error|none)  [default: info] Level of logging messages.
  -o=(columns|json|tsv|none)       [default: columns] Format of command output.
  -p, --profile=<value>            Shorthand identifier for your profile.
      --silent                     Suppress  output and logs. This is a shorthand for "-l none -o none".
      --ttl=<value>                Optional TTL for token (up to 24 hours) (value in seconds)
      --worker-sid=<value>         (required) The Worker SID for this token
      --workspace-sid=<value>      (required) The Workspace SID for this token

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

twilio token:chat

USAGE
  $ twilio token:chat --identity <value> --chat-service-sid <value> [-l (debug|info|warn|error|none)] [-o
    (columns|json|tsv|none)] [--silent] [-p <value>] [--ttl <value>]

FLAGS
  -l=(debug|info|warn|error|none)  [default: info] Level of logging messages.
  -o=(columns|json|tsv|none)       [default: columns] Format of command output.
  -p, --profile=<value>            Shorthand identifier for your profile.
      --chat-service-sid=<value>   (required) The service SID for the Chat, starts with ISXXX
      --identity=<value>           (required) The user identity
      --silent                     Suppress  output and logs. This is a shorthand for "-l none -o none".
      --ttl=<value>                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 --worker-sid <value> --workspace-sid <value> [-l (debug|info|warn|error|none)] [-o
    (columns|json|tsv|none)] [--silent] [-p <value>] [--ttl <value>]

FLAGS
  -l=(debug|info|warn|error|none)  [default: info] Level of logging messages.
  -o=(columns|json|tsv|none)       [default: columns] Format of command output.
  -p, --profile=<value>            Shorthand identifier for your profile.
      --silent                     Suppress  output and logs. This is a shorthand for "-l none -o none".
      --ttl=<value>                Optional TTL for token (up to 24 hours) (value in seconds)
      --worker-sid=<value>         (required) The Worker SID for this token
      --workspace-sid=<value>      (required) The Workspace SID for this token

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

twilio token:sync

USAGE
  $ twilio token:sync --identity <value> --sync-service-sid <value> [-l (debug|info|warn|error|none)] [-o
    (columns|json|tsv|none)] [--silent] [-p <value>] [--ttl <value>]

FLAGS
  -l=(debug|info|warn|error|none)  [default: info] Level of logging messages.
  -o=(columns|json|tsv|none)       [default: columns] Format of command output.
  -p, --profile=<value>            Shorthand identifier for your profile.
      --identity=<value>           (required) The user identity
      --silent                     Suppress  output and logs. This is a shorthand for "-l none -o none".
      --sync-service-sid=<value>   (required) The service SID for the Sync, starts with ISXXX
      --ttl=<value>                Optional TTL for token (up to 24 hours) (value in seconds)

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

twilio token:video

USAGE
  $ twilio token:video --identity <value> [-l (debug|info|warn|error|none)] [-o (columns|json|tsv|none)]
    [--silent] [-p <value>] [--room-name <value>] [--ttl <value>]

FLAGS
  -l=(debug|info|warn|error|none)  [default: info] Level of logging messages.
  -o=(columns|json|tsv|none)       [default: columns] Format of command output.
  -p, --profile=<value>            Shorthand identifier for your profile.
      --identity=<value>           (required) The user identity
      --room-name=<value>          The name of the room this token grants access to
      --silent                     Suppress  output and logs. This is a shorthand for "-l none -o none".
      --ttl=<value>                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 --voice-app-sid <value> --identity <value> [-l (debug|info|warn|error|none)] [-o
    (columns|json|tsv|none)] [--silent] [-p <value>] [--allow-incoming true|false] [--push-credential-sid <value>]
    [--ttl <value>]

FLAGS
  -l=(debug|info|warn|error|none)    [default: info] Level of logging messages.
  -o=(columns|json|tsv|none)         [default: columns] Format of command output.
  -p, --profile=<value>              Shorthand identifier for your profile.
      --allow-incoming=<option>      [default: true] Allow incoming calls (true/false) (defaults to true)
                                     <options: true|false>
      --identity=<value>             (required) The user identity
      --push-credential-sid=<value>  The Push Credential SID for receiving incoming call push notifications, starts with
                                     CRXXX
      --silent                       Suppress  output and logs. This is a shorthand for "-l none -o none".
      --ttl=<value>                  Optional TTL for token (up to 24 hours) (value in seconds)
      --voice-app-sid=<value>        (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