API Endpoints
Learn more about our backend API endpoints!
API Base URLs
Production: https://api.sonoranradio.com
Development: https://radioapi.dev.sonoransoftware.com
Get Community Channels
POST
/radio/get-community-channels/:id/:key
This endpoint gets all connected users in a community.
Headers
Name | Value |
---|---|
Content-Type |
|
Body
Name | Type | Description |
---|---|---|
| string | Community ID |
| string | Community API Key |
Response
Get Connected Users
POST
/radio/get-connected-users/:id/:key
This endpoint gets all connected users in a community.
Headers
Name | Value |
---|---|
Content-Type |
|
Body
Name | Type | Description |
---|---|---|
| string | Community ID |
| string | Community API Key |
Response
Set Server IP
POST
/radio/set-server-ip
This endpoint sets the IP address of a Sonoran Radio community, used for resource authentication.
Headers
Name | Value |
---|---|
Content-Type |
|
Body
Name | Type | Description |
---|---|---|
| string | Community ID |
| string | Community API Key |
| string | Push Event URL |
Response
Get Server Subscription from IP
GET
/radio/check-server-subscription
This endpoint gets the subscription enumeration value of a Sonoran Radio community, based on the IP address it's called from. The IP address is set via the set server IP endpoint.
Headers
Name | Value |
---|---|
Content-Type |
|
Response
Set In-Game Speaker Locations
POST
/radio/set-server-speakers
Sends a list of in-game speaker locations that the tone board can select.
When played, the play_tone push event will be sent to your server's pushUrl.
Headers
Name | Value |
---|---|
Content-Type |
|
Authorization |
|
Body
Name | Type | Description |
---|---|---|
| string | Community ID |
| string | Community API Key |
| array of | In-Game Tone Locations |
Response
Last updated