Play Tone

This endpoint plays a tone (or multiple tones) in the radio.

Get Community Channels

POST /api/play-tone

This endpoint plays a tone (or multiple tones) for participants of the radio

Headers

Name
Value

Content-Type

application/json

Request (Body)

interface Request {
  /** The community ID */
  id: string;
  /** The community API key */
  key: string;

  /** Which room (server id) to play tones for */
  roomId: number;
  /** the IDs of tones to play */
  tones: number[];
  
  /** where to play the tones */
  playTo: {
    type: "channel" | "group" | "game";
    /**
      if type === 'channel', the channel ID
      if type === 'group', the group ID
      if type === 'game', the speaker ID (in speakers.json)
    */
    value: any;
  }[];
}

Response

Last updated

Was this helpful?