Skip to content

Commit f295b86

Browse files
authored
Update TURN credential generation docs to use /generate-ice-servers (#20420)
1 parent 2cb8146 commit f295b86

File tree

1 file changed

+29
-19
lines changed

1 file changed

+29
-19
lines changed

src/content/docs/calls/turn/generate-credentials.mdx

Lines changed: 29 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ With a TURN key you can:
2424
You should generate short-lived credentials for each TURN user. In order to create credentials, you should have a back-end service that uses your TURN Token ID and API token to generate credentials. It will make an API call like this:
2525

2626
```bash
27-
curl https://rtc.live.cloudflare.com/v1/turn/keys/$TURN_KEY_ID/credentials/generate \
27+
curl https://rtc.live.cloudflare.com/v1/turn/keys/$TURN_KEY_ID/credentials/generate-ice-servers \
2828
--header "Authorization: Bearer $TURN_KEY_API_TOKEN" \
2929
--header "Content-Type: application/json" \
3030
--data '{"ttl": 86400}'
@@ -34,33 +34,43 @@ The JSON response below can then be passed on to your front-end application:
3434

3535
```json
3636
{
37-
"iceServers": {
38-
"urls": [
39-
"stun:stun.cloudflare.com:3478",
40-
"turn:turn.cloudflare.com:3478?transport=udp",
41-
"turn:turn.cloudflare.com:3478?transport=tcp",
42-
"turns:turn.cloudflare.com:5349?transport=tcp"
43-
],
44-
"username": "bc91b63e2b5d759f8eb9f3b58062439e0a0e15893d76317d833265ad08d6631099ce7c7087caabb31ad3e1c386424e3e",
45-
"credential": "ebd71f1d3edbc2b0edae3cd5a6d82284aeb5c3b8fdaa9b8e3bf9cec683e0d45fe9f5b44e5145db3300f06c250a15b4a0"
46-
}
37+
"iceServers": [
38+
{
39+
"urls": [
40+
"stun:stun.cloudflare.com:3478",
41+
"stun:stun.cloudflare.com:53",
42+
"turn:turn.cloudflare.com:3478?transport=udp",
43+
"turn:turn.cloudflare.com:53?transport=udp",
44+
"turn:turn.cloudflare.com:3478?transport=tcp",
45+
"turn:turn.cloudflare.com:80?transport=tcp",
46+
"turns:turn.cloudflare.com:5349?transport=tcp",
47+
"turns:turn.cloudflare.com:443?transport=tcp"
48+
],
49+
"username": "bc91b63e2b5d759f8eb9f3b58062439e0a0e15893d76317d833265ad08d6631099ce7c7087caabb31ad3e1c386424e3e",
50+
"credential": "ebd71f1d3edbc2b0edae3cd5a6d82284aeb5c3b8fdaa9b8e3bf9cec683e0d45fe9f5b44e5145db3300f06c250a15b4a0"
51+
}
52+
]
4753
}
4854
```
4955

50-
Use `username` and `credential` as follows when instantiating the `RTCPeerConnection` (note, `iceServers` is now an array):
56+
Use `iceServers` as follows when instantiating the `RTCPeerConnection`:
5157

5258
```js
5359
const myPeerConnection = new RTCPeerConnection({
5460
iceServers: [
5561
{
5662
urls: [
57-
"stun:stun.cloudflare.com:3478",
58-
"turn:turn.cloudflare.com:3478?transport=udp",
59-
"turn:turn.cloudflare.com:3478?transport=tcp",
60-
"turns:turn.cloudflare.com:5349?transport=tcp"
63+
"stun:stun.cloudflare.com:3478",
64+
"stun:stun.cloudflare.com:53",
65+
"turn:turn.cloudflare.com:3478?transport=udp",
66+
"turn:turn.cloudflare.com:53?transport=udp",
67+
"turn:turn.cloudflare.com:3478?transport=tcp",
68+
"turn:turn.cloudflare.com:80?transport=tcp",
69+
"turns:turn.cloudflare.com:5349?transport=tcp",
70+
"turns:turn.cloudflare.com:443?transport=tcp"
6171
],
62-
username: "REPLACE_WITH_USERNAME",
63-
credential: "REPLACE_WITH_CREDENTIAL",
72+
"username": "bc91b63e2b5d759f8eb9f3b58062439e0a0e15893d76317d833265ad08d6631099ce7c7087caabb31ad3e1c386424e3e",
73+
"credential": "ebd71f1d3edbc2b0edae3cd5a6d82284aeb5c3b8fdaa9b8e3bf9cec683e0d45fe9f5b44e5145db3300f06c250a15b4a0"
6474
},
6575
],
6676
});
@@ -79,4 +89,4 @@ Short lived credentials can also be revoked before their TTL expires with a API
7989
curl --request POST \
8090
https://rtc.live.cloudflare.com/v1/turn/keys/$TURN_KEY_ID/credentials/$USERNAME/revoke \
8191
--header "Authorization: Bearer $TURN_KEY_API_TOKEN"
82-
```
92+
```

0 commit comments

Comments
 (0)