Note: This page has not yet been converted to the new developer portal format. Please use Swagger to test this API.
Audio
The Audio API is unique in
that it expects a binary-formatted upload as the POST body.
This API is used to upload audio resources to use within the context of voice
paths.
GET /audio/{organizationId}/{audioId}
Description
Retrieve a specific audio.
Return type
audio instance
Parameters
| Name | Data Type | Required? | Description |
|---|---|---|---|
credentials | string | y | Basic Authorization header. |
organizationId | long | y | The ID of the organization in which to find the audio. |
audioId | string | n | The ID of the audio. |
returnType | string | n | Return the raw audio file or the record associated with that file. |
HttpServletResponse | HttpServletResponse | n | File upload body. |
POST /audio/{organizationId}
Description
Load and store an audio file to your Everbridge Organization. The response to this
operation is the unique audioKey for the file.
This key can be used as the value of notification message.audioKey objects to
indicate that this audio should be used as the message for voice contact paths.
Input type
Multipart MIME‐Encoded POST data containing the audio file to use for
notifications.Testing this method requires the use of command‐line tools such as curl to properly format the
POST body.
Assuming there is a wav file called upload in the current directory, an example of
the necessary curl syntax would be something like this:
curl --header "Authorization: Basic bW9iaaE6bw9iMME6MTE"
-F "[email protected]"
https://://api.everbridge.net/rest/audio/8800387989534
Return type
audio instance
Parameters
| Name | Data Type | Required? | Description |
|---|---|---|---|
credentials | string | y | Basic Authorization header. |
organizationId | long | y | The ID of the organization containing the contact filters. |
fileRequest | MultipartHttpServetRequest | y | Multipart file upload body. Note that this is not possible to test using Swagger; command-line tools must be used. |