JSON API » ivrs » ivrs/files/upload

Uploads a new message file or sound of an IVR menu.

Input parameters

Requires authentication and the administrator role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
ivrIntegerID of IVR menu.Yes
dataBase64Base64 encoded contents of WAV file.Yes, unless sound is set.Empty string.
soundIntegerID of sound to use.Yes, unless data is set.0

Either the data or the sound must be set, but not both.

Responses

CodeDescription
204Success.
401The authentication details provided are invalid.
402Your role does not allow this.
403Your rate plan does not allow this.
404The IVR menu does not exist, or you do not have permission to update it.

Data returned

No data is returned.

Example: With data (data truncated for brevity)

http://enswitch.example.com/api/json/ivrs/files/upload/?auth_username=user;auth_password=password;ivr=123;data=...

{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }

Example: With sound

http://enswitch.example.com/api/json/ivrs/files/upload/?auth_username=user;auth_password=password;ivr=123;sound=456

{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }

Change history

VersionChanges
3.13Function added.