JSON API » bulk » bulk/files/download

Downloads the message file for a bulk campaign.

Input parameters

Requires authentication and the user role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
campaign	Integer	ID of campaign.	Yes
check	Integer	1 to just check if the file exists, 0 to download it.	No	0
encoding	String	"base64" to return file base64 encoded, "raw" to return raw data.	No	"raw"
wrap	String	"json" to return file in a JSON object, "none" to return plain file. Setting this to "none" cancels setting the check parameter to 1.	No	"json"

Responses

Code	Description
200	Success.
401	The authentication details provided are invalid.
402	Your role does not allow this.
404	The campaign or its file does not exist, or you do not have permission to view it.

If check=1 was specified and the file does not exist, 200 is returned.

Data returned

If checking, whether the file was found or not. If not checking, the sound file data plus name and mime-type.

Example: Download file (data truncated for brevity)

http://enswitch.example.com/api/json/bulk/files/download/?auth_username=user;auth_password=password;campaign=123

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "id":123, "name":"example.wav", "mimetype":"audio/x-wav", "data":"RIFFn..." } }

Example: Check if file exists, and it does

http://enswitch.example.com/api/json/bulk/files/download/?auth_username=user;auth_password=password;campaign=123;check=1

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "found":1 } }

Example: Check if file exists, and it doesn't

http://enswitch.example.com/api/json/bulk/files/download/?auth_username=user;auth_password=password;campaign=123;check=1

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "found":0 } }

Change history

Version	Changes
3.15	wrap parameter added.
3.13	Function added.