createSoundFiles¶
Request Method: POST
Description: Creates one or more SoundFiles.
URL: https://api.iovox.com:444/SoundFiles?v=3&method=createSoundFiles
The following parameters can be sent in the querystring
| Parameter | Description | Default Value | Data Type | Mandatory |
| v | API version to use | INTEGER | YES |
Payload¶
The following XML payload must be sent with a createSoundFiles request:
xml
<?xml version="1.0" encoding="utf-8"?>
<request>
<sound_file>
<sound_label>Sound File 1</sound_label>
<sound_group>Sound Group 1</sound_group>
<!-- sound_file will contain the binary data, base64 encoded, of the sound file you want to create. //-->
<sound_file><!-- sound file path here //--></sound_file>
<notes>awesome notes for this awesome soundfile!</notes>
</sound_file>
<sound_file>
<sound_label>Sound File 2</sound_label>
<sound_group>Sound Group 1</sound_group>
<!-- sound_file will contain the binary data, base64 encoded, of the sound file you want to create. //-->
<sound_file><!-- sound file path here //--></sound_file>
<notes>awesome notes for this new awesome soundfile!</notes>
</sound_file>
<sound_file>
...
</sound_file>
...
</request>
Payload Description¶
| Node Name | Description | Default Value | Data Type | Mandatory |
| sound_file > sound_label | A sound label for this sound file. Every sound label is unique in its sound group. | STRING | YES | |
| sound_file > sound_group | A sound group for this soundfile. This is to group sound files which will be used in the same functions. | STRING | NO | |
| sound_file > sound_file | Base64 encoded binary data of the sound file. | STRING | YES | |
| sound_file > notes | Any notes associated with the sound file | STRING | NO |
Result¶
Error Result¶
| HTTP Code | Error String | Resolution | ||
| 400 | API Version Empty | Add a value for the v parameter in the query string | ||
| 400 | API Version Invalid | Correct v parameter | ||
| 400 | Request Method must be POST. x attempted | Switch request method x to POST | ||
| 400 | XML Empty | Add xml to the request body | ||
| 400 | XML parse error. x at line y, column z | Correct XML at point x on line y, column z | ||
| 400 | Request Empty | Add at least one contact to the request | ||
| 400 | Sound Label x of y Empty | Add sound_label to sound_file x (item) of y (total) | ||
| 400 | Sound Label x of y already exists in Sound Group | Remove or change sound_label x (item) of y (total) | ||
| 400 | Sound Group x of y Forbidden | Change sound_group x (item) of y (total) | ||
| 400 | Sound File x of y Empty | Add in sound_file base64 encoded binary data for sound_file x (item) of y (total) | ||
| 400 | Sound File x of y Exceeds maximum allowed filesize | Change sound_file x (item) of y (total) to a smaller filesize file | ||
| 400 | Duplicate Sound File Received | Remove any duplicate sound_label and sound_group combinations from the XML | ||
| 500 | Internal Server Error | Retry later | ||