Get Turn Credentials

Generate temporary TURN credentials for WebRTC clients using the authenticated community API key.

GET https://api.sonorancad.com/v2/general/turn

Rate limit: 20 requests per minute Authenticated v2 endpoints are rate limited per API key rather than per IP address.

Generate temporary TURN credentials for Sonoran CAD WebRTC clients. This route uses normal v2 API authentication and does not require a paid plan.

Query Parameters

Name

Type

Required

Description

userId

string

Optional user identifier appended to the generated TURN username. Colons are normalized to underscores.

Example Request

-- luarocks install sonoran.lua
-- For SonoranCADFiveM in-game usage, see the SonoranCADFiveM tab for the export-based client.
local Sonoran = require("sonoran")

local sonoran = Sonoran.createClient({
  product = Sonoran.productEnums.CAD,
  communityId = "YOUR_COMMUNITY_ID",
  apiKey = "YOUR_API_KEY",
  defaultServerId = 1
})

local response = sonoran.cad:getTurnCredentialsV2({
  userId = "unit-1"
})

print(response.success)
print(response.data and response.data.ttl)

Use this tab only when calling the v2 API from the server side of an in-game FiveM resource.

Sonoran.lua and Sonoran.js: use the sonorancad export to get the ready CAD client.
Sonoran.Net: FiveM exports do not return a .NET client. Read the Sonoran CAD convars and create a fresh client.
Sonoran.py: FiveM does not run Python resources; use the Python tab for external integrations.

The API key is stored in sonoran_apiKey as a protected FiveM convar. FiveM restricts a convar after add_convar_permission is configured, so only explicitly permitted resources can read it. Grant another resource access with add_convar_permission your-resource-name read sonoran_apiKey. If you change the API key in config.json, fully restart the sonorancad resource before reading the updated convar value.

Sonoran.lua

local cad = exports["sonorancad"]:getCadClient()

Sonoran.js

const cad = exports["sonorancad"].getCadClient();

Sonoran.Net

// dotnet add package Sonoran.Net
using CitizenFX.Core.Native;
using Sonoran;

var communityId = API.GetConvar("sonoran_communityID", "");
var apiKey = API.GetConvar("sonoran_apiKey", "");
var serverIdRaw = API.GetConvar("sonoran_serverId", "1");
var serverId = int.TryParse(serverIdRaw, out var parsedServerId) ? parsedServerId : 1;

using var sonoran = new SonoranClient(new SonoranClientOptions
{
    product = SonoranProduct.CAD,
    communityId = communityId,
    apiKey = apiKey,
    defaultServerId = serverId
});

// npm install @sonoransoftware/sonoran.js
// For SonoranCADFiveM in-game usage, see the SonoranCADFiveM tab for the export-based client.
const Sonoran = require('@sonoransoftware/sonoran.js');

(async () => {
  const instance = new Sonoran.Instance({
    communityId: 'YOUR_COMMUNITY_ID',
    apiKey: 'YOUR_API_KEY',
    product: Sonoran.productEnums.CAD,
    serverId: 1,
  });

  const response = await instance.cad.getTurnCredentialsV2({
    userId: 'unit-1',
  });

  console.log(response);
})();

# pip install Sonoran.py
# Sonoran.py is for external Python integrations; FiveM resources should use the SonoranCADFiveM tab.
from sonoran import Instance, productEnums

instance = Instance(
    apiKey="YOUR_API_KEY",
    communityId="YOUR_COMMUNITY_ID",
    product=productEnums.CAD,
    serverId=1,
)

response = instance.cad.getTurnCredentialsV2({
    "userId": "unit-1",
})

print(response.success)
print(response.data if response.success else response.reason)

// dotnet add package Sonoran.Net
// For SonoranCADFiveM in-game usage, see the SonoranCADFiveM tab; .NET creates a fresh client from convars.
using Sonoran;

using var sonoran = new SonoranClient(new SonoranClientOptions
{
    product = SonoranProduct.CAD,
    communityId = "YOUR_COMMUNITY_ID",
    apiKey = "YOUR_API_KEY",
    defaultServerId = 1
});

var response = await sonoran.Cad.getTurnCredentialsV2(new GetTurnCredentialsV2Query
{
    UserId = "unit-1"
});

Console.WriteLine(response.success);
Console.WriteLine(response.data);

Import this YAML into Postman with Import -> Raw text to create a single-endpoint request collection for this route.

openapi: "3.0.3"
info:
  title: "Sonoran CAD v2 - Get Turn Credentials"
  version: "1.0.0"
  description: "Generate temporary TURN credentials for WebRTC clients using the authenticated community API key."
servers:
  -
    url: "https://api.sonorancad.com"
paths:
  /v2/general/turn:
    get:
      summary: "Get Turn Credentials"
      operationId: "getTurnCredentials"
      parameters:
        -
          in: "query"
          name: "userId"
          required: false
          schema:
            type: "string"
          description: "Optional user identifier appended to the generated TURN username."
      responses:
        200:
          description: "Successful response"
          content:
            application/json:
              schema:
                type: "object"
              example:
                iceServers:
                  - urls:
                      - "turn:coturn.sonorancad.com:3478?transport=udp"
                      - "turn:coturn.sonorancad.com:3478?transport=tcp"
                      - "stun:coturn.sonorancad.com:3478"
                    username: "1735689600:unit-1"
                    credential: "base64-turn-credential"
                ttl: 600
      security:
        -
          bearerAuth:
components:
  securitySchemes:
    bearerAuth:
      type: "http"
      scheme: "bearer"
      bearerFormat: "JWT"

Response

Successful requests return application/json.

{
  "iceServers": [
    {
      "urls": [
        "turn:coturn.sonorancad.com:3478?transport=udp",
        "turn:coturn.sonorancad.com:3478?transport=tcp",
        "stun:coturn.sonorancad.com:3478"
      ],
      "username": "1735689600:unit-1",
      "credential": "base64-turn-credential"
    }
  ],
  "ttl": 600
}

PreviousGet Version NextUpload Bodycam Recording

Last updated 15 days ago

Was this helpful?