Get Connected Users

This endpoint gets all connected users for a specific Sonoran Radio server.

Get Connected Users

GET /v2/servers/:communityId/connected-users

Rate limit: 6 requests per minute

Returns every currently connected radio participant for the selected server.

Headers

Name

Value

Authorization

Bearer <community-api-key>

URL Parameters

Name

Type

Description

communityId

string

Sonoran Radio community ID

Examples

local response = client.radio:getConnectedUsersV2()

const response = await instance.radio?.getConnectedUsersV2();

response = instance.radio.getConnectedUsersV2()

var response = await sonoran.Radio.getConnectedUsersV2();

openapi: 3.1.0
paths:
  /v2/servers/{communityId}/connected-users:
    get:
      parameters:
        - in: path
          name: communityId
          required: true
          schema:
            type: string
            example: YOUR_COMMUNITY_ID
      security:
        - bearerAuth: []

curl -X GET "https://api.sonoranradio.com/v2/servers/YOUR_COMMUNITY_ID/connected-users" \
  -H "Authorization: Bearer your-community-api-key"

Response

Successful requests return application/json.

{
  "connectedUsers": [
    {
      "identity": "91de0ce8-c571-11e9-9714-5600023b2434",
      "name": "Officer Smith",
      "metadata": "{\"sonrad\":true}",
      "roomId": 1
    }
  ]
}

PreviousUsers NextGet Members

Last updated 3 months ago

Was this helpful?