logo
Documentation Powered by ReDoc

Tones Service API Reference

Download OpenAPI specification:Download

Create a Tone

Returns a URL (valid for twenty-four hours) used to retrieve the tone. All tones have a bit depth of twenty-four bits.

header Parameters
Authorization
required
string
Example: JWT eyJ...

An API Token prefixed by "JWT".
Note: There is a transaction type that will be associated with this created tone. The transaction type value comes from the App with which the API token was created. Only if your Account has multiple available transaction types, ensure your API Token was created under an App with the appropriate transaction type.

Request Body schema: application/json
profile
required
string
Enum: "zone66" "zone266" "point1000" "point2000" "pkab2" "pkab2_wideband" "standard2" "standard2_wideband"

Profile of tone. The Tones API supports the creation of the above tone profiles. Refer to the SDK documentation for profile compatibility.

payload
required
string

Bytes of tone payload, specified in hexadecimal.

Profile Byte Limit
Zone66 255
Zone266/Point1000/Point2000 3000
Standard 2.0/Wideband 255
PKAB 2.0/Wideband 3000

Note that a hexadecimal string representation has twice as many characters as it does bytes. For example, a1b2c3 is six characters, but only three bytes.

format
string
Default: "wav"
Enum: "wav" "mp3"

File format of tone.

zip
boolean
Default: true

Whether the tone should be compressed to a ZIP file.

prependSilence
boolean
Default: false

Whether the tone should be prepended with 200 milliseconds of silence. Due to iOS limitations, this is necessary for API-generated tones to successfully broadcast from iOS browsers.

channel
integer

Channel the provided tone profile will transmit on. Zone66 and Point1000 accept channel values of 0, 1, or 2. Zone266 and Point2000 automatically broadcast on channel 1. Channel can only be used with Zone66, Zone266, Point1000, and Point2000 tone profiles.

tonelockType
string
Enum: "account_based" "custom_value" "time_based"

Type of ToneLock that will be used on the provided tone payload. If custom_value type is selected, the tonelockValue must be provided. Refer to the SDK documentation for ToneLock type functionality details.

tonelockValue
string

ToneLock value for the provided tone when using custom_value ToneLock type. Format should be a 36 character string composed of 32 hexadecimal digits and 4 hyphens (RFC4122 Compliant UUID). Any receiving devices cannot demodulate a tone enabled with ToneLock unless they are enabled with a matching ToneLock value.

encrypt
boolean
Default: false

Whether the tone payload should be encrypted using AES256. In order to receive and demodulate the encrypted tone, the receiving application must initialize it's Radius object using an SDK token from the same account the API token was created from.

Responses

Request samples

Content type
application/json
{
  • "profile": "point1000",
  • "payload": "68656c6c6f20776f726c64",
  • "format": "wav",
  • "zip": true,
  • "prependSilence": false,
  • "channel": 0,
  • "tonelockType": "account_based",
  • "tonelockValue": "2d5cbbc0-5e97-437c-aabc-5891f7a74683",
  • "encrypt": false
}

Response samples