Skip to content

Commit 3c1b7ac

Browse files
author
Tim Mendoza
committed
Add links to Twilio conversations
1 parent 100d21d commit 3c1b7ac

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
### New Features
66

7-
- Added support for Twilio Conversations. When an application requests a token from the `/token` endpoint, a `create_conversation=true` parameter can now be specified. When this parameter is present, the `/token` endpoint will create a conversation that is associated with the room and add the participant to it. This allows video application to use Twilio Conversations for in-room chat.
7+
- Added support for Twilio Conversations. When an application requests a token from the `/token` endpoint, a `create_conversation=true` parameter can now be specified. When this parameter is present, the `/token` endpoint will create a conversation that is associated with the room and add the participant to it. This allows video application to use [Twilio Conversations](https://www.twilio.com/conversations-api) for in-room chat.
88

99
### Maintenence
1010

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-
This endpoint returns a Programmable Video Access token. When `create_room` is true, it will create a room, and when `create_conversation` is true, it will create a [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.
85+
This endpoint returns a Programmable Video Access token. When `create_room` is true, it will create a room, and when `create_conversation` is true, it will create a [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
@@ -96,7 +96,7 @@ POST /token
9696
| `user_identity` | `string` | **Required**. The user's identity. |
9797
| `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. |
99-
| `create_conversation` | `boolean` | (default: `false`) When true, a Twilio Conversation will be created (if it doesn't already exist) and a participant will be added to it when a token is requested. `create_room` must also be `true`. |
99+
| `create_conversation` | `boolean` | (default: `false`) When true, a [Twilio Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) will be created (if it doesn't already exist) and a participant will be added to it when a token is requested. `create_room` must also be `true`. |
100100

101101
#### Success Responses
102102

0 commit comments

Comments
 (0)