Giter Club home page Giter Club logo

plugin-token's Introduction

@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 profile.
  --allow-incoming=true|false                [default: true] Allow incoming calls (true/false) (defaults to true)
  --identity=identity                        (required) The user identity

  --push-credential-sid=push-credential-sid  The Push Credential SID for receiving incoming call push notifications,
                                             starts with CRXXX

  --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 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 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 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:sync

USAGE
  $ twilio token:sync

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.
  --identity=identity                  (required) The user identity
  --sync-service-sid=sync-service-sid  (required) The service SID for the Sync, starts with ISXXX
  --ttl=ttl                            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

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.
  --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 profile.
  --allow-incoming=true|false                [default: true] Allow incoming calls (true/false) (defaults to true)
  --identity=identity                        (required) The user identity

  --push-credential-sid=push-credential-sid  The Push Credential SID for receiving incoming call push notifications,
                                             starts with CRXXX

  --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

plugin-token's People

Contributors

micaswyers-work avatar dkundel avatar dependabot[bot] avatar mmena1 avatar bobiechen-twilio avatar snyk-bot avatar crweiner avatar dprothero avatar jefflinwood avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.