Skip to content

Commit dfffe25

Browse files
author
Tim Mendoza
committed
Improve readme headings
1 parent 2f2a521 commit dfffe25

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -56,19 +56,19 @@ A mobile and web collaboration application built with Twilio Programmable Video.
5656
- [iOS App](https://github.com/twilio/twilio-video-app-ios)
5757
- [Android App](https://github.com/twilio/twilio-video-app-android)
5858

59-
#### Token Server API Documentation
59+
## Token Server API Documentation
6060

6161
The following section documents the application [token server](/src/video-token-server.js) used to provide [Programable Video access tokens](https://www.twilio.com/docs/video/tutorials/user-identity-access-tokens) to supported Twilio Video applications. The token server is deployed as a [Twilio Function](https://www.twilio.com/docs/runtime/functions).
6262

6363
| Method | URL |
6464
| ------ | ------------------ |
6565
| POST | [`/token`](#token) |
6666

67-
##### Authentication
67+
### Authentication
6868

6969
The application token server requires an [authentication mechanism](#twilio-rtcappsvideodeploy---authentication-auth) to be specified when deploying. The following section documents each supported authentication mechanism.
7070

71-
###### Passcode
71+
#### Passcode
7272

7373
Each request is verified using a passcode generated at deploy time. Passcodes remain valid for one week. After the passcode expires, users can redeploy an application and a new passcode will be generated. The snippet below provides an example request body used by a supported application.
7474

@@ -80,15 +80,15 @@ Each request is verified using a passcode generated at deploy time. Passcodes re
8080
}
8181
```
8282

83-
##### Token
83+
### Token
8484

8585
Returns a Programmable Video Access token.
8686

8787
```shell
8888
POST /token
8989
```
9090

91-
###### Parameters
91+
#### Parameters
9292

9393
| Name | Type | Description |
9494
| --------------- | --------- | -------------------------------------------------------------------------------------- |
@@ -97,7 +97,7 @@ POST /token
9797
| `room_name` | `string` | 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

100-
###### Success Responses
100+
#### Success Responses
101101

102102
<table>
103103
<tr>
@@ -119,7 +119,7 @@ POST /token
119119

120120
</table>
121121

122-
###### Error Responses
122+
#### Error Responses
123123

124124
<table>
125125
<tr>
@@ -189,23 +189,23 @@ POST /token
189189

190190
</table>
191191

192-
##### Recording Rules
192+
### Recording Rules
193193

194194
Changes the Recording Rules for a given room SID.
195195

196196
```shell
197197
POST /recordingrules
198198
```
199199

200-
###### Parameters
200+
#### Parameters
201201

202202
| Name | Type | Description |
203203
| ---------- | -------- | ------------------------------------------------------------------- |
204204
| `passcode` | `string` | **Required**. The application passcode. |
205205
| `room_sid` | `string` | **Required**. The SID of the room to change the recording rules of. |
206206
| `rules` | `array` | **Required**. An array of recording rules to apply to the room. |
207207

208-
###### Success Responses
208+
#### Success Responses
209209

210210
<table>
211211
<tr>
@@ -234,7 +234,7 @@ POST /recordingrules
234234

235235
</table>
236236

237-
###### Error Responses
237+
#### Error Responses
238238

239239
<table>
240240
<tr>

0 commit comments

Comments
 (0)