Arreya offers a REST style API. Our API has accepts URL encoded data, form-encoded request bodies, JSON formatted bodies, and uses standard HTTPS responses and authentication.
[YOUR API KEY] – The API key for the channel you want to issue alerts for
Supports GET and POST requests
Supports POST of CAP xml
Supports parameters as url parameters, form data, or JSON post
Parameter
Description
icon
Optional, available icons – https://fontawesome.com/v4.7/icons/
title
Title text
message
Message body
color
Optional, controls the text color
background
Optional, uses CSS color values, can also use images with CSS url property
timeout
How long the message stays on the display. Send a timeout of 0 to clear any active alerts.
animation
Optional, animate the icon using one of the animations from https://animate.style/
apiKey
Your channel API Key
Beep
Parameter
Value
Range
Description
soundEffect
beep
n/a
The sound effect you want to play during the alert.
soundPitch
1500
0-10000
Controls the pitch of the sound effect.
soundDelay
0
0-100
Delay the sound effect (in seconds) from when the alert is active.
soundVolume
0.5
0.0-1.0
Controls the volume of the sound effect.
soundLoop
FALSE
TRUE/FALSE
Controls whether or not the sound effect loops for the duration of the alert.
Tap
Parameter
Value
Range
Description
soundEffect
tap
n/a
The sound effect you want to play during the alert.
soundPitch
2000
0-10000
Controls the pitch of the sound effect.
soundDelay
0
0-100
Delay the sound effect (in seconds) from when the alert is active.
soundVolume
0.05
0.0-1.0
Controls the volume of the sound effect.
soundLoop
FALSE
TRUE/FALSE
Controls whether or not the sound effect loops for the duration of the alert.
Click
Parameter
Value
Range
Description
soundEffect
click
n/a
The sound effect you want to play during the alert.
soundPitch
1000
0-10000
Controls the pitch of the sound effect.
soundDelay
0
0-100
Delay the sound effect (in seconds) from when the alert is active.
soundVolume
0.5
0.0-1.0
Controls the volume of the sound effect.
soundLoop
FALSE
TRUE/FALSE
Controls whether or not the sound effect loops for the duration of the alert.
Fire
Parameter
Value
Range
Description
soundEffect
fire
n/a
The sound effect you want to play during the alert.
soundPitch
2850
0-10000
Controls the pitch of the sound effect.
soundDelay
0
0-100
Delay the sound effect (in seconds) from when the alert is active.
soundVolume
0.5
0.0-1.0
Controls the volume of the sound effect.
soundLoop
FALSE
TRUE/FALSE
Controls whether or not the sound effect loops for the duration of the alert.
Intermittent Tone
Parameter
Value
Range
Description
soundEffect
intermittentTone
n/a
The sound effect you want to play during the alert.
soundPitch
800
0-10000
Controls the pitch of the sound effect.
soundDelay
0
0-100
Delay the sound effect (in seconds) from when the alert is active.
soundVolume
0.5
0.0-1.0
Controls the volume of the sound effect.
soundLoop
FALSE
TRUE/FALSE
Controls whether or not the sound effect loops for the duration of the alert.
Continuous Tone
Parameter
Value
Range
Description
soundEffect
continuousTone
n/a
The sound effect you want to play during the alert.
soundPitch
1500
0-10000
Controls the pitch of the sound effect.
soundDelay
0
0-100
Delay the sound effect (in seconds) from when the alert is active.
soundVolume
0.02
0.0-1.0
Controls the volume of the sound effect.
soundLoop
FALSE
TRUE/FALSE
Controls whether or not the sound effect loops for the duration of the alert.
soundDuration
0(∞)
0-100
The duration of the sound effect to be played.
timeout
604800(1 week)
0-??
The duration of the alert.
Speech
Parameter
Value
Range
Description
soundEffect
speech
n/a
The sound effect you want to play during the alert.
soundText
This-is-some-default-text.
n/a
The text that will be spoken for the alert.
soundVoicePitch
1
0.0-2.0
Controls the pitch of the voice for text to speech
soundDelay
0
0-100
Delay the sound effect (in seconds) from when the alert is active.
soundVolume
0.5
0.0-1.0
Controls the volume of the sound effect.
soundLoop
FALSE
TRUE/FALSE
Controls whether or not the sound effect loops for the duration of the alert.
soundRate
1
0.1-10
Represents the speed the text is spoken.
Audio File
Parameter
Value
Range
Description
soundEffect
audioFile
n/a
The sound effect you want to play during the alert.
soundUrl
https://example.com/example.wav
n/a
The audio file you want to play for the alert.
soundAudioVolume
0.5
0.0-1.0
Controls the volume of the sound effect.
soundLoop
FALSE
TRUE/FALSE
Controls whether or not the sound effect loops for the duration of the alert.
Example request URL:
https://[YOUR CHANNEL].arreya.com/api/v1/channel/alert?apikey=[YOUR API KEY]&icon=exclamation-triangle&message=This%20is%20a%20test&background=red&color=white&title=ALERT%20TESTING& timeout=15&animation=wobble
You can run this simple test in your browser by inserting your API key and your channel name