@@ -90,11 +90,12 @@ POST /token
9090
9191###### Parameters
9292
93- | Name | Type | Description |
94- | --------------- | -------- | -------------------------------------------------------------------------------------- |
95- | ` passcode ` | ` string ` | ** Required** . The application passcode. |
96- | ` user_identity ` | ` string ` | ** Required** . The user's identity. |
97- | ` room_name ` | ` string ` | A room name that will be used to create a token scoped to connecting to only one room. |
93+ | Name | Type | Description |
94+ | --------------- | --------- | -------------------------------------------------------------------------------------- |
95+ | ` passcode ` | ` string ` | ** Required** . The application passcode. |
96+ | ` user_identity ` | ` string ` | ** Required** . The user's identity. |
97+ | ` room_name ` | ` string ` | A room name that will be used to create a token scoped to connecting to only one room. |
98+ | ` create_room ` | ` boolean ` | (default: ` true ` ) When false, a room will not be created when a token is requested. |
9899
99100###### Success Responses
100101
@@ -109,7 +110,7 @@ POST /token
109110``` json
110111{
111112 "token" : " 0000000000000000.0000000000000000000000.00000000000000000" ,
112- "room_type" : " group" | "group-small" | "peer-to-peer"
113+ "room_type" : " group" | "group-small" | "peer-to-peer" | null
113114}
114115```
115116
@@ -175,6 +176,24 @@ POST /token
175176
176177</table >
177178
179+ <table >
180+ <tr >
181+ <td > <b >Status</b > </td > <td > <b >Response</b > </td >
182+ </tr >
183+
184+ <tr >
185+ <td > 400 </td >
186+ <td >
187+
188+ ``` json
189+ {
190+ "error" : {
191+ "message" : " invalid parameter" ,
192+ "explanation" : " A boolean value must be provided for the create_room parameter"
193+ }
194+ }
195+ ```
196+
178197## Commands
179198
180199 <!-- commands -->
0 commit comments