Skip to content

Commit 4555fea

Browse files
author
Tim Mendoza
committed
Update documentation
1 parent 76a6241 commit 4555fea

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ Each request is verified using a passcode generated at deploy time. Passcodes re
8282

8383
### Token
8484

85-
Returns a Programmable Video Access token.
85+
This endpoint returns a Programmable Video Access token. When `create_room` is true, it will create a room and [Twilio conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) associated with the room. This token is used by the above mentioned Video Apps to connect to a video room and a conversation.
8686

8787
```shell
8888
POST /token
@@ -94,7 +94,7 @@ POST /token
9494
| --------------- | --------- | -------------------------------------------------------------------------------------- |
9595
| `passcode` | `string` | **Required**. The application passcode. |
9696
| `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. |
97+
| `room_name` | `string` | **Required when `create_room` is `true`** A room name that will be used to create a token scoped to connecting to only one room. |
9898
| `create_room` | `boolean` | (default: `true`) When false, a room will not be created when a token is requested. |
9999

100100
#### Success Responses

0 commit comments

Comments
 (0)