Storefronts
- Invoices
- Credit Notes
Customer Management
VoIP Bundle (Subscriptions)
- VoIP Subscription Bundle
SIP Account Management
Audio Management
- Sounds
- Playlists
Phone Numbers & Call Routing
Phone Calls & CDR Data
VoIP Phone Short Code
- Short Codes
eFax Management
- Fax Messages
- Fax Authorized Senders
Voicemails & Mailboxes
Caller ID
- Caller IDs
- Caller ID Requests
SIP Trunks
- Trunk Authentication
- VoIP Trunks
Wallboard Statistics
VoIP Phone Provisioning
- Devices
Call Queueing
Phone Books
- Phone Book
- Phone Book Contact
VoIP Phone Speed Dial
- Speed Dials
Text (SMS) Messaging
- Text Message Campaign

API Access

Build custom apps using our JSON API

Configure API

Sounds

A Sound represents an audio file used by the system for prompts, greetings and hold music

Become a Reseller

Filter:

All
GET
POST
PUT
DELETE
Chargeable *

* You will be charged every time this command is run.

GET/voip/sound

Gets a list of all sounds on an account

Request Details

Response Details

Request Details

This command has no URL/Query String parameters

Response Details

200 Response

{
    "result" : [
        {
            "audio_type" : 1,
            "created_on" : "2023-06-07",
            "file_name" : "hold_track_1.mp3",
            "name" : "Track 1",
            "shared" : false,
            "tag" : "Hold Music",
            "updated_on" : "2023-06-07",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
        }
    ],
    "status_code" : 200,
    "status_message" : "OK"
}

GET/voip/sound/{uuid}

Gets the details for a specific sound on an account

Request Details

Response Details

Request Details

URL and Query String Parameters

Name
Type
Required

- uuid
- String
- True
The UUID of the Sound to be queried

Response Details

200 Response

{
    "result" : {
        "audio_type" : 1,
        "created_on" : "2023-06-07",
        "file_name" : "hold_track_1.mp3",
        "name" : "Track 1",
        "shared" : false,
        "tag" : "Hold Music",
        "updated_on" : "2023-06-07",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 200,
    "status_message" : "OK"
}

404 Response

{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}

GET/voip/sound/{uuid}/content

Generates a temporary URL to the sound's audio content
Back to top

Request Details

Response Details
Request Details

URL and Query String Parameters
- Name
- Type
- Required
- uuid
  
  String
  
  True
  
  The UUID of the Sound to be queried
Response Details

200 Response
```
{
    "result" : {
        "content_url" : "content.yay.com/40c6614b-8c5d-48a0-ab6d-cdc4d47f914d"
    },
    "status_code" : 200,
    "status_message" : "OK"
}
```
404 Response
```
{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}
```

POST/voip/sound

Creates a new sound on an account

Request Details

Response Details

Request Details

This command has no URL/Query String parameters

POST body

Name
Type
Required

- audio_type
- int
- False
What type of audio is this?
- content
- String
- True
The Base64 encoded sound content
- file_name
- String
- True
The file name of the Sound
- name
- String
- True
The name of this Sound
- tag
- String
- False
A tag for this Sound file

JSON all-fields example:

{
    "audio_type" : 1,
    "content" : "VEhJUyBJUyBURVNUIFRFWFQgRk9SIEFVRElPIEZJTEUgQ09OVEVOVA==",
    "file_name" : "hold_track_1.mp3",
    "name" : "Track 1",
    "tag" : "Hold Music"
}

Response Details

201 Response

{
    "result" : {
        "audio_type" : 1,
        "created_on" : "2023-06-07",
        "file_name" : "hold_track_1.mp3",
        "name" : "Track 1",
        "shared" : false,
        "tag" : "Hold Music",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 201,
    "status_message" : "Created"
}

400 Response

{
    "result" : {},
    "status_code" : 400,
    "status_message" : "Bad Request"
}

PUT/voip/sound/{uuid}

Updates the specified sound on an account

Request Details

Response Details

Request Details

URL and Query String Parameters

Name
Type
Required

- uuid
- String
- True
The UUID of the Sound to be updated

PUT body

Name
Type
Required

- audio_type
- int
- False
What type of audio is this?
- content
- String
- True
The Base64 encoded sound content
- file_name
- String
- True
The file name of the Sound
- name
- String
- True
The name of this Sound
- tag
- String
- False
A tag for this Sound file

JSON all-fields example:

{
    "audio_type" : 1,
    "content" : "VEhJUyBJUyBURVNUIFRFWFQgRk9SIEFVRElPIEZJTEUgQ09OVEVOVA==",
    "file_name" : "hold_track_1.mp3",
    "name" : "Track 1",
    "tag" : "Hold Music"
}

Response Details

200 Response

{
    "result" : {
        "audio_type" : 1,
        "created_on" : "2023-06-07",
        "file_name" : "hold_track_1.mp3",
        "name" : "Track 1",
        "shared" : false,
        "tag" : "Hold Music",
        "updated_on" : "2023-06-07",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 200,
    "status_message" : "OK"
}

400 Response

{
    "result" : {},
    "status_code" : 400,
    "status_message" : "Bad Request"
}

404 Response

{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}

DELETE/voip/sound/{uuid}

Deletes the specified sound from an account
Back to top

Request Details

Response Details
Request Details

URL and Query String Parameters
- Name
- Type
- Required
- uuid
  
  String
  
  True
  
  The UUID of the Sound to be deleted
Response Details

204 Response
```
{
    "result" : {},
    "status_code" : 204,
    "status_message" : "No Content"
}
```
404 Response
```
{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}
```