@@ -7,7 +7,7 @@ Generate a temporary token for use in a Twilio client-side SDK application
77* [ Requirements] ( #requirements )
88* [ Usage] ( #usage )
99* [ Commands] ( #commands )
10- * [ Contributing] ( #contributing )
10+ * [ Contributing] ( #- contributing )
1111* [ License] ( #license )
1212<!-- tocstop -->
1313# Requirements
@@ -39,141 +39,144 @@ USAGE
3939
4040```
4141USAGE
42- $ twilio token:capability:client
43-
44- OPTIONS
45- -l=(debug|info|warn|error|none) [default: info] Level of logging messages.
46- -o=(columns|json|tsv|none) [default: columns] Format of command output.
47- -p, --profile=profile Shorthand identifier for your profile.
48- --allow-incoming=true|false [default: true] Allow incoming calls (true/false) (defaults to true)
49- --identity=identity (required) The user identity
50-
51- --push-credential-sid=push-credential-sid The Push Credential SID for receiving incoming call push notifications,
52- starts with CRXXX
53-
54- --silent Suppress output and logs. This is a shorthand for "-l none -o none".
55-
56- --ttl=ttl Optional TTL for token (up to 24 hours) (value in seconds)
57-
58- --voice-app-sid=voice-app-sid (required) The TwiML Application SID for outbound calls, starts with APXXX
42+ $ twilio token:capability:client --voice-app-sid <value> --identity <value> [-l (debug|info|warn|error|none)] [-o
43+ (columns|json|tsv|none)] [--silent] [-p <value>] [--allow-incoming true|false] [--push-credential-sid <value>]
44+ [--ttl <value>]
45+
46+ FLAGS
47+ -l=(debug|info|warn|error|none) [default: info] Level of logging messages.
48+ -o=(columns|json|tsv|none) [default: columns] Format of command output.
49+ -p, --profile=<value> Shorthand identifier for your profile.
50+ --allow-incoming=<option> [default: true] Allow incoming calls (true/false) (defaults to true)
51+ <options: true|false>
52+ --identity=<value> (required) The user identity
53+ --push-credential-sid=<value> The Push Credential SID for receiving incoming call push notifications, starts with
54+ CRXXX
55+ --silent Suppress output and logs. This is a shorthand for "-l none -o none".
56+ --ttl=<value> Optional TTL for token (up to 24 hours) (value in seconds)
57+ --voice-app-sid=<value> (required) The TwiML Application SID for outbound calls, starts with APXXX
5958```
6059
61- _ See code: [ src/commands/token/capability/client.js] ( https://github.com/twilio-labs/plugin-token/blob/v4 .0.0/src/commands/token/capability/client.js ) _
60+ _ See code: [ src/commands/token/capability/client.js] ( https://github.com/twilio-labs/plugin-token/blob/v6 .0.0/src/commands/token/capability/client.js ) _
6261
6362## ` twilio token:capability:worker `
6463
6564```
6665USAGE
67- $ twilio token:capability:worker
66+ $ twilio token:capability:worker --worker-sid <value> --workspace-sid <value> [-l (debug|info|warn|error|none)] [-o
67+ (columns|json|tsv|none)] [--silent] [-p <value>] [--ttl <value>]
6868
69- OPTIONS
69+ FLAGS
7070 -l=(debug|info|warn|error|none) [default: info] Level of logging messages.
7171 -o=(columns|json|tsv|none) [default: columns] Format of command output.
72- -p, --profile=profile Shorthand identifier for your profile.
73- --silent Suppress output and logs. This is a shorthand for "-l none -o none".
74- --ttl=ttl Optional TTL for token (up to 24 hours) (value in seconds)
75- --worker-sid=worker-sid (required) The Worker SID for this token
76- --workspace-sid=workspace-sid (required) The Workspace SID for this token
72+ -p, --profile=<value> Shorthand identifier for your profile.
73+ --silent Suppress output and logs. This is a shorthand for "-l none -o none".
74+ --ttl=<value> Optional TTL for token (up to 24 hours) (value in seconds)
75+ --worker-sid=<value> (required) The Worker SID for this token
76+ --workspace-sid=<value> (required) The Workspace SID for this token
7777```
7878
79- _ See code: [ src/commands/token/capability/worker.js] ( https://github.com/twilio-labs/plugin-token/blob/v4 .0.0/src/commands/token/capability/worker.js ) _
79+ _ See code: [ src/commands/token/capability/worker.js] ( https://github.com/twilio-labs/plugin-token/blob/v6 .0.0/src/commands/token/capability/worker.js ) _
8080
8181## ` twilio token:chat `
8282
8383```
8484USAGE
85- $ twilio token:chat
86-
87- OPTIONS
88- -l=(debug|info|warn|error|none) [default: info] Level of logging messages.
89- -o=(columns|json|tsv|none) [default: columns] Format of command output.
90- -p, --profile=profile Shorthand identifier for your profile.
91- --chat-service-sid=chat-service-sid (required) The service SID for the Chat, starts with ISXXX
92- --identity=identity (required) The user identity
93- --silent Suppress output and logs. This is a shorthand for "-l none -o none".
94- --ttl=ttl Optional TTL for token (up to 24 hours) (value in seconds)
85+ $ twilio token:chat --identity <value> --chat-service-sid <value> [-l (debug|info|warn|error|none)] [-o
86+ (columns|json|tsv|none)] [--silent] [-p <value>] [--ttl <value>]
87+
88+ FLAGS
89+ -l=(debug|info|warn|error|none) [default: info] Level of logging messages.
90+ -o=(columns|json|tsv|none) [default: columns] Format of command output.
91+ -p, --profile=<value> Shorthand identifier for your profile.
92+ --chat-service-sid=<value> (required) The service SID for the Chat, starts with ISXXX
93+ --identity=<value> (required) The user identity
94+ --silent Suppress output and logs. This is a shorthand for "-l none -o none".
95+ --ttl=<value> Optional TTL for token (up to 24 hours) (value in seconds)
9596```
9697
97- _ See code: [ src/commands/token/chat.js] ( https://github.com/twilio-labs/plugin-token/blob/v4 .0.0/src/commands/token/chat.js ) _
98+ _ See code: [ src/commands/token/chat.js] ( https://github.com/twilio-labs/plugin-token/blob/v6 .0.0/src/commands/token/chat.js ) _
9899
99100## ` twilio token:flex `
100101
101102```
102103USAGE
103- $ twilio token:flex
104+ $ twilio token:flex --worker-sid <value> --workspace-sid <value> [-l (debug|info|warn|error|none)] [-o
105+ (columns|json|tsv|none)] [--silent] [-p <value>] [--ttl <value>]
104106
105- OPTIONS
107+ FLAGS
106108 -l=(debug|info|warn|error|none) [default: info] Level of logging messages.
107109 -o=(columns|json|tsv|none) [default: columns] Format of command output.
108- -p, --profile=profile Shorthand identifier for your profile.
109- --silent Suppress output and logs. This is a shorthand for "-l none -o none".
110- --ttl=ttl Optional TTL for token (up to 24 hours) (value in seconds)
111- --worker-sid=worker-sid (required) The Worker SID for this token
112- --workspace-sid=workspace-sid (required) The Workspace SID for this token
110+ -p, --profile=<value> Shorthand identifier for your profile.
111+ --silent Suppress output and logs. This is a shorthand for "-l none -o none".
112+ --ttl=<value> Optional TTL for token (up to 24 hours) (value in seconds)
113+ --worker-sid=<value> (required) The Worker SID for this token
114+ --workspace-sid=<value> (required) The Workspace SID for this token
113115```
114116
115- _ See code: [ src/commands/token/flex.js] ( https://github.com/twilio-labs/plugin-token/blob/v4 .0.0/src/commands/token/flex.js ) _
117+ _ See code: [ src/commands/token/flex.js] ( https://github.com/twilio-labs/plugin-token/blob/v6 .0.0/src/commands/token/flex.js ) _
116118
117119## ` twilio token:sync `
118120
119121```
120122USAGE
121- $ twilio token:sync
122-
123- OPTIONS
124- -l=(debug|info|warn|error|none) [default: info] Level of logging messages.
125- -o=(columns|json|tsv|none) [default: columns] Format of command output.
126- -p, --profile=profile Shorthand identifier for your profile.
127- --identity=identity (required) The user identity
128- --silent Suppress output and logs. This is a shorthand for "-l none -o none".
129- --sync-service-sid=sync-service-sid (required) The service SID for the Sync, starts with ISXXX
130- --ttl=ttl Optional TTL for token (up to 24 hours) (value in seconds)
123+ $ twilio token:sync --identity <value> --sync-service-sid <value> [-l (debug|info|warn|error|none)] [-o
124+ (columns|json|tsv|none)] [--silent] [-p <value>] [--ttl <value>]
125+
126+ FLAGS
127+ -l=(debug|info|warn|error|none) [default: info] Level of logging messages.
128+ -o=(columns|json|tsv|none) [default: columns] Format of command output.
129+ -p, --profile=<value> Shorthand identifier for your profile.
130+ --identity=<value> (required) The user identity
131+ --silent Suppress output and logs. This is a shorthand for "-l none -o none".
132+ --sync-service-sid=<value> (required) The service SID for the Sync, starts with ISXXX
133+ --ttl=<value> Optional TTL for token (up to 24 hours) (value in seconds)
131134```
132135
133- _ See code: [ src/commands/token/sync.js] ( https://github.com/twilio-labs/plugin-token/blob/v4 .0.0/src/commands/token/sync.js ) _
136+ _ See code: [ src/commands/token/sync.js] ( https://github.com/twilio-labs/plugin-token/blob/v6 .0.0/src/commands/token/sync.js ) _
134137
135138## ` twilio token:video `
136139
137140```
138141USAGE
139- $ twilio token:video
142+ $ twilio token:video --identity <value> [-l (debug|info|warn|error|none)] [-o (columns|json|tsv|none)]
143+ [--silent] [-p <value>] [--room-name <value>] [--ttl <value>]
140144
141- OPTIONS
145+ FLAGS
142146 -l=(debug|info|warn|error|none) [default: info] Level of logging messages.
143147 -o=(columns|json|tsv|none) [default: columns] Format of command output.
144- -p, --profile=profile Shorthand identifier for your profile.
145- --identity=identity (required) The user identity
146- --room-name=room-name The name of the room this token grants access to
147- --silent Suppress output and logs. This is a shorthand for "-l none -o none".
148- --ttl=ttl Optional TTL for token (up to 24 hours) (value in seconds)
148+ -p, --profile=<value> Shorthand identifier for your profile.
149+ --identity=<value> (required) The user identity
150+ --room-name=<value> The name of the room this token grants access to
151+ --silent Suppress output and logs. This is a shorthand for "-l none -o none".
152+ --ttl=<value> Optional TTL for token (up to 24 hours) (value in seconds)
149153```
150154
151- _ See code: [ src/commands/token/video.js] ( https://github.com/twilio-labs/plugin-token/blob/v4 .0.0/src/commands/token/video.js ) _
155+ _ See code: [ src/commands/token/video.js] ( https://github.com/twilio-labs/plugin-token/blob/v6 .0.0/src/commands/token/video.js ) _
152156
153157## ` twilio token:voice `
154158
155159```
156160USAGE
157- $ twilio token:voice
158-
159- OPTIONS
160- -l=(debug|info|warn|error|none) [default: info] Level of logging messages.
161- -o=(columns|json|tsv|none) [default: columns] Format of command output.
162- -p, --profile=profile Shorthand identifier for your profile.
163- --allow-incoming=true|false [default: true] Allow incoming calls (true/false) (defaults to true)
164- --identity=identity (required) The user identity
165-
166- --push-credential-sid=push-credential-sid The Push Credential SID for receiving incoming call push notifications,
167- starts with CRXXX
168-
169- --silent Suppress output and logs. This is a shorthand for "-l none -o none".
170-
171- --ttl=ttl Optional TTL for token (up to 24 hours) (value in seconds)
172-
173- --voice-app-sid=voice-app-sid (required) The TwiML Application SID for outbound calls, starts with APXXX
161+ $ twilio token:voice --voice-app-sid <value> --identity <value> [-l (debug|info|warn|error|none)] [-o
162+ (columns|json|tsv|none)] [--silent] [-p <value>] [--allow-incoming true|false] [--push-credential-sid <value>]
163+ [--ttl <value>]
164+
165+ FLAGS
166+ -l=(debug|info|warn|error|none) [default: info] Level of logging messages.
167+ -o=(columns|json|tsv|none) [default: columns] Format of command output.
168+ -p, --profile=<value> Shorthand identifier for your profile.
169+ --allow-incoming=<option> [default: true] Allow incoming calls (true/false) (defaults to true)
170+ <options: true|false>
171+ --identity=<value> (required) The user identity
172+ --push-credential-sid=<value> The Push Credential SID for receiving incoming call push notifications, starts with
173+ CRXXX
174+ --silent Suppress output and logs. This is a shorthand for "-l none -o none".
175+ --ttl=<value> Optional TTL for token (up to 24 hours) (value in seconds)
176+ --voice-app-sid=<value> (required) The TwiML Application SID for outbound calls, starts with APXXX
174177```
175178
176- _ See code: [ src/commands/token/voice.js] ( https://github.com/twilio-labs/plugin-token/blob/v4 .0.0/src/commands/token/voice.js ) _
179+ _ See code: [ src/commands/token/voice.js] ( https://github.com/twilio-labs/plugin-token/blob/v6 .0.0/src/commands/token/voice.js ) _
177180<!-- commandsstop -->
178181# Contributing
179182
0 commit comments