JSON API » codes » codes/files/upload

Uploads a new feature code sound file.

Input parameters

Requires authentication and the administrator or user role privileges.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
code	String	Feature code.	Yes
file	String	Which file to upload. "message" or "screen".	Yes
data	Base64	Base64 encoded contents of WAV file.	Yes, unless sound is set.	Empty string.
sound	Integer	ID of sound to use.	Yes, unless data is set.	0
customer	Integer	ID of customer owning feature code.	No	Customer of authentication user.

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

Responses

Code	Description
204	Success.
400	Invalid input parameters specified. Check the key and message fields for more details.
401	The authentication details provided are invalid.
402	Your role does not allow this.
403	Your rate plan does not allow this.
404	The feature code 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/codes/files/upload/?auth_username=user;auth_password=password;code=100;file=message;data=...

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

Example: With sound

http://enswitch.example.com/api/json/codes/files/upload/?auth_username=user;auth_password=password;code=100;file=message;sound=456

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

Change history

Version	Changes
3.13	Function added.