Download an Attachment

Purpose

To download a file attached to a record.

Request Details

Request URL

https://www.zohoapis.com/bigin/v1/{module_api_name}/{record_id}/Attachments/{attachment_id}

Supported Modules

Modules supported in Get List of Attachments are supported here.

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoBigin.modules.ALL
(or)
scope=ZohoBigin.modules.{module_name}.{operation_type}
(and)
scope=ZohoBigin.modules.attachments.{operation_type}

Possible module names

companies, contacts, deals, tasks, events, calls, products, notes and activities.

Possible operation types

ALL - Full access to attachments
READ - Get attachment data

Possible Errors

  • INVALID_MODULEHTTP 400

    The module name given seems to be invalid
    Resolution: You have specified an invalid module name or there is no tab permission, or the module could have been removed from the available modules. Specify a valid module API name.

  • INVALID_MODULEHTTP 400

    The given module is not supported in API
    Resolution: The modules such as Documents and Projects are not supported in the current API. (This error will not be shown, once these modules are been supported). Specify a valid module API name.

  • INVALID_URL_PATTERNHTTP 404

    Please check if the URL trying to access is a correct one
    Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section above.

  • OAUTH_SCOPE_MISMATCHHTTP 401

    Unauthorized
    Resolution: Client does not have ZohoBigin.modules.attachments.READ scope. Create a new client with valid scope. Refer to scope section above.

  • NO_PERMISSIONHTTP 403

    Permission denied to download attachment
    Resolution: The user does not have permission to download attachments. Contact your system administrator.

  • INTERNAL_ERRORHTTP 500

    Internal Server Error
    Resolution: Unexpected and unhandled exception in Server. Contact support team.

  • INVALID_REQUEST_METHODHTTP 400

    The http request method type is not a valid one
    Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to endpoints section above.

  • AUTHORIZATION_FAILEDHTTP 400

    User does not have sufficient privilege to download attachments
    Resolution: The user does not have the permission to download attachments. Contact your system administrator.

Sample Request

Copiedcurl "https://www.zohoapis.com/bigin/v1/Contacts/100023009/Attachments/100013547"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
CopiedZBiginRecord record = ZBiginRecord.getInstance("Products",12345l); //module api name with record id
FileAPIResponse response = record.downloadAttachment(456789l); //attachmentID
InputStream inputStream = response.getFileAsStream();
CommonUtil.saveStreamAsFile(inputStream, "/absolute/path/to/store/file",response.getFileName());
Copiedtry{
$record=ZBiginRecord::getInstance(“Accounts”,410405000001519001);
$fileResponseIns=$record->downloadAttachment(410405000001519501); // 410405000001519501 - Attachment ID.
$fp=fopen($filePath.$fileResponseIns->getFileName(),"w"); // $filePath - absolute path where downloaded file has to be stored.
echo "HTTP Status Code:".$fileResponseIns->getHttpStatusCode();
echo "File Name:".$fileResponseIns->getFileName();
$stream=$fileResponseIns->getFileContent();
fputs($fp,$stream);
fclose($fp);
}catch (ZBiginException $e)
{
echo $e->getMessage();
echo $e->getExceptionCode();
echo $e->getCode();
}
Copieddef download_attachment(self):
        try:
            record = ZBiginRecord.get_instance('Contacts', 3719520000000326007)
            resp = record.download_attachment(3719520000000518001)
            print(resp.response_headers)
            if resp.status_code == 200:
                print(resp.file_name)
                with open('/Users/Downloads/' + resp.file_name, 'wb') as f:
                    for chunk in resp.response:
                        f.write(chunk)
                        f.close()

        except ZBiginException as ex:
            print(ex.status_code)
            print(ex.error_message)
            print(ex.error_code)
            print(ex.error_details)
            print(ex.error_content)
CopiedZBiginRecord recordIns = ZBiginRecord.GetInstance("Contacts", 3372164000000614001); //module api name with record id
FileAPIResponse response = recordIns.DownloadAttachment(3372164000001624007); //attachmentID
Stream file = response.GetFileAsStream();
CommonUtil.SaveStreamAsFile("FilePath", file, response.GetFileName());
Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/bigin/v1/Contacts/100023009/Attachments/100013547"
	type: GET
	connection:"bigin_oauth_connection"
];
info response;

The required file will be downloaded.