---
title: "Obtain TURN server credentials."
method: GET
path: "/_matrix/client/v3/voip/turnServer"
tags: ["VOIP"]
---

# Obtain TURN server credentials.

`GET /_matrix/client/v3/voip/turnServer`

## Request

- Base URL: `https://matrix.org`
- URL: `https://matrix.org/_matrix/client/v3/voip/turnServer`
- Auth: one of:
  - API key in query parameter `access_token`
  - HTTP bearer
- TypeScript: <https://skmtc.dev/matrix/apis/matrix-client-server-api/docs/_matrix/client/v3/voip/turnServer/get.ts> (a function with typed inputs; its response is checked against the schema)

This API provides credentials for the client to use when initiating
calls.

## Response `200`

The TURN server credentials.

- object
  - `password` string, required: The password to use.
  - `ttl` integer, required: The time-to-live in seconds
  - `uris` string[], required: A list of TURN URIs
  - `username` string, required: The username to use.

## Other responses

- `429`: This request was rate-limited.

---

[API](https://skmtc.dev/matrix/apis/matrix-client-server-api.md) - [All operations](https://skmtc.dev/matrix/apis/matrix-client-server-api/llms.txt) - [OpenAPI document](https://skmtc.dev/matrix/apis/matrix-client-server-api/revisions/c7fe4072c681?raw)