MailCleaners File Transfer API


1. Upload & Process Files


API URL


http://mailcleaners.org/api/v1/jobs/create?api={api_key}&username={username}&file_name={remote_url}&timeout=10

API Results (JSON)


a. status: success|fail

b. job_id: a unique id to access job result in future

c. error: (if status was fail) describes why the query failed,
- Required parameter missing or invalid
- User authentication failed. Wrong API Key or username.
- The request was refused due to insufficent credit.
- File is not downloadable.


2. Check Status


API URL


http://mailcleaners.org/api/v1/jobs/status?api={api_key}&username={username}&job_id={job_id}

API Results (JSON)


a. status: success|processing|fail

b. error: (if status was fail) describes why the query failed,
- This Job Id not associated to your users.
- Required parameter missing or invalid
- User authentication failed. Wrong API Key or username.


3. Download Results


API URL


http://mailcleaners.org/api/v1/jobs/download?api={api_key}&username={username}&job_id={job_id}

API Results (JSON)


a. status: success|fail

b. result: It will return emaillist.csv file with "Email","Name","Status","Role Based Emails" columns.

c. error: (if status was fail) describes why the query failed,
- This Job Id not associated to your users.
- List is currently Processing. Please wait some times.
- Required parameter missing or invalid
- User authentication failed. Wrong API Key or username.