Download an Attachment
Purpose
To download a file attached to a record.
Request Details
Request URL
{api-domain}/crm/{version}/{module_api_name}/{record_id}/Attachments/{attachment_id}
Supported modules
Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Events, Calls, Solutions, Products, Vendors, Price Books, Quotes, Sales Orders, Purchase Orders, Invoices, Custom, and Notes
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Scope
scope=ZohoCRM.modules.ALL
(or)
scope=ZohoCRM.modules.{module_name}.{operation_type}
(and)
scope=ZohoCRM.modules.attachments.{operation_type}
Possible module names
leads, accounts, contacts, deals, campaigns, tasks, cases, events, calls, solutions, products, vendors, pricebooks, quotes, salesorders, purchaseorders, invoices, custom, notes
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 ZohoCRM.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/crm/v2.1/Leads/100023009/Attachments/100013547"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
CopiedString moduleAPIName = "Leads";
Long recordId = 3477061000005177002L;
Long attachmentId = 3477061000005177023L;
String destinationFolder = "/Users/user_name/Desktop";
//Get instance of AttachmentsOperations Class that takes moduleAPIName and recordId as parameter
AttachmentsOperations attachmentsOperations = new AttachmentsOperations(moduleAPIName, recordId);
//Call downloadAttachment method that takes attachmentId as parameters
APIResponse < ResponseHandler > response = attachmentOperations.downloadAttachment(attachmentId);
Copiedpackage com.zoho.crm.api.sample.restapi.filesandattachments;
import java.io.File;
import java.io.FileOutputStream;
import java.io.InputStream;
import java.io.OutputStream;
import javax.net.ssl.SSLContext;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpUriRequest;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.conn.ssl.NoopHostnameVerifier;
import org.apache.http.conn.ssl.SSLConnectionSocketFactory;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.util.EntityUtils;
public class DownloadanAttachment
{
public static void main(String[] args)
{
try
{
HttpClientBuilder httpClientBuilder = HttpClientBuilder.create();
SSLContext sslContext = SSLContext.getDefault();
SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(sslContext, NoopHostnameVerifier.INSTANCE);
CloseableHttpClient httpclient = httpClientBuilder.setSSLSocketFactory(sslConnectionSocketFactory).build();
URIBuilder uriBuilder = new URIBuilder("https://www.zohoapis.com/crm/v2.1/Leads/34770617711001/Attachments/34770617783004");
HttpUriRequest requestObj = new HttpGet(uriBuilder.build());
requestObj.addHeader("Authorization", "Zoho-oauthtoken 1000.xxxxxxx.xxxxxxx");
HttpResponse response = httpclient.execute(requestObj);
HttpEntity responseEntity = response.getEntity();
System.out.println("HTTP Status Code : " + response.getStatusLine().getStatusCode());
if(responseEntity != null)
{
if(response.containsHeader("Content-Disposition"))
{
String contentDisposition = response.getFirstHeader("Content-Disposition").getValue();
String fileName = contentDisposition.split("=")[1];
if(fileName.contains("''"))
{
fileName = fileName.split("''")[1];
}
if(fileName.contains("\""))
{
fileName = fileName.replace("\"", "");
}
//Create a file instance with the absolute_file_path
File file = new File("/Users/username/Desktop" + File.separatorChar + fileName);
//Get InputStream from the response
InputStream is = responseEntity.getContent();
//Create an OutputStream for the destination file
OutputStream os = new FileOutputStream(file);
byte[] buffer = new byte[1024];
int bytesRead;
//read the InputStream till the end
while((bytesRead = is.read(buffer)) != -1)
{
//write data to OutputStream
os.write(buffer, 0, bytesRead);
}
//Close the InputStream
is.close();
//Flush and close the OutputStream
os.flush();
os.close();
}
else
{
Object responseObject = EntityUtils.toString(responseEntity);
String responseString = responseObject.toString();
System.out.println(responseString);
}
}
}
catch(Exception ex)
{
ex.printStackTrace();
}
}
}
Copied//Get instance of AttachmentsOperations Class that takes recordId and moduleAPIName as parameter
$attachmentOperations = new AttachmentsOperations($moduleAPIName, $recordId);
//Call downloadAttachment method that takes attachmentId as parameters
$response = $attachmentOperations->downloadAttachment($attachmentId);
Copied<?php
class DownloadAttachment{
public function execute(){
$curl_pointer = curl_init();
$curl_options = array();
$url = "https://www.zohoapis.com/crm/v2.1/Leads/3524033000005495065/Attachments/3524033000006020005";
$curl_options[CURLOPT_URL] = $url;
$curl_options[CURLOPT_RETURNTRANSFER] = true;
$curl_options[CURLOPT_HEADER] = 1;
$curl_options[CURLOPT_CUSTOMREQUEST] = "GET";
$headersArray = array();
$headersArray[] = "Authorization". ":" . "Zoho-oauthtoken " ."1000.30f3a589XXXXXXXXXXXXXXXXXXX4077.dc5XXXXXXXXXXXXXXXXXXXee9e7c171c";
$curl_options[CURLOPT_HTTPHEADER]=$headersArray;
curl_setopt_array($curl_pointer, $curl_options);
$result = curl_exec($curl_pointer);
$responseInfo = curl_getinfo($curl_pointer);
curl_close($curl_pointer);
list ($headers, $content) = explode("\r\n\r\n", $result, 2);
if(strpos($headers," 100 Continue")!==false){
list( $headers, $content) = explode( "\r\n\r\n", $content , 2);
}
$headerArray = (explode("\r\n", $headers, 50));
$headerMap = array();
foreach ($headerArray as $key) {
if (strpos($key, ":") != false) {
$firstHalf = substr($key, 0, strpos($key, ":"));
$secondHalf = substr($key, strpos($key, ":") + 1);
$headerMap[$firstHalf] = trim($secondHalf);
}
}
$response = $content;
if ($response == null && $responseInfo['http_code'] != 204) {
list ($headers, $content) = explode("\r\n\r\n", $content, 2);
$response = json_decode($content, true);
}
$contentDisp = $headerMap['Content-Disposition'];
$fileName = substr($contentDisp, strrpos($contentDisp, "'") + 1, strlen($contentDisp));
if (strpos($fileName, "=") !== false)
{
$fileName = substr($fileName, strrpos($fileName, "=") + 1, strlen($fileName));
$fileName = str_replace(array(
'\'',
'"'
), '', $fileName);
}
$filePath = "/Users/test/PHP/PHPNativeSampleCode/";
$fp = fopen($filePath . $fileName, "w"); // $filePath - absolute path where downloaded file has to be stored.
$stream = $response;
fputs($fp, $stream);
fclose($fp);
}
}
(new DownloadAttachment())->execute();
Copied//Get instance of AttachmentsOperations Class that takes moduleAPIName and recordId as parameter
AttachmentsOperations attachmentsOperations = new AttachmentsOperations(moduleAPIName, recordId);
//Call DownloadAttachment method that takes attachmentId as parameters
APIResponse<API.Attachments.ResponseHandler> response = attachmentsOperations.DownloadAttachment(attachmentId);
Copiedusing System;
using System.IO;
using System.Net;
namespace Com.Zoho.Crm.API.Sample.RestAPI.FilesandAttachments
{
public class DownloadanAttachment
{
public static void DownloadAttachment()
{
HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://www.zohoapis.com/crm/v2.1/Leads/34770617711001/Attachments/3477061763001");
request.Method = "GET";
request.Headers["Authorization"] = "Zoho-oauthtoken 1000.abfeXXXXXXXXXXX2asw.XXXXXXXXXXXXXXXXXXsdc2";
request.KeepAlive = true;
HttpWebResponse response;
try
{
response = (HttpWebResponse)request.GetResponse();
}
catch (WebException e)
{
if (e.Response == null) { throw; }
response = (HttpWebResponse)e.Response;
}
HttpWebResponse responseEntity = response;
Console.WriteLine("HTTP Status Code : " + (int)response.StatusCode);
WebHeaderCollection collection = responseEntity.Headers;
string contentDisposition = collection["Content-Disposition"];
if (contentDisposition != null)
{
string fileName = contentDisposition.Split(new string[] { "=" }, StringSplitOptions.None)[1];
if (fileName.Contains("''"))
{
fileName = fileName.Split(new string[] { "''" }, StringSplitOptions.None)[1];
}
fileName = fileName.Trim('\"');
string fullFilePath = Path.Combine("/Users/abc-122/Desktop", fileName);
using (FileStream outputFileStream = new FileStream(fullFilePath, FileMode.Create))
{
responseEntity.GetResponseStream().CopyTo(outputFileStream);
}
responseEntity.Close();
}
else
{
string responsestring = new StreamReader(responseEntity.GetResponseStream()).ReadToEnd();
responseEntity.Close();
Console.WriteLine(responsestring);
}
}
}
}
Copied# Get instance of AttachmentsOperations Class that takes module_api_name and record_id as parameter
attachments_operations = AttachmentsOperations(module_api_name, record_id)
# Call download_attachment method that takes attachment_id as parameters
response = attachments_operations.download_attachment(attachment_id)
Copieddef download_attachment():
import requests
import os
url = 'https://www.zohoapis.com/crm/v2.1/Leads/3409643000002267003/Attachments/3409643000002847003'
headers = {
'Authorization': 'Zoho-oauthtoken 1000.04be928e4a96XXXXXXXXXXXXX68.0b9eXXXXXXXXXXXX60396e268'
}
response = requests.get(url=url, headers=headers)
if response is not None:
print("HTTP Status Code : " + str(response.status_code))
if 'Content-Type' in response.headers:
content_type = response.headers['Content-Type'].split(';')[0]
if content_type == 'application/json':
print(response.json())
else:
if 'Content-Disposition' in response.headers:
file_name = ''
content_disposition = response.headers['Content-Disposition']
if "'" in content_disposition:
start_index = content_disposition.rindex("'")
file_name = content_disposition[start_index + 1:]
elif '"' in content_disposition:
start_index = content_disposition.rindex('=')
file_name = content_disposition[start_index + 1:].replace('"', '')
destination_file = os.path.join(
'/Users/aswin-7455/Documents/SDK-workspace/latest-git-csez/python/latest/zohocrm-python-sdk',
file_name)
with open(destination_file, 'wb') as f:
for chunk in response:
f.write(chunk)
download_attachment()
Copied//Get instance of AttachmentsOperations Class that takes recordId and moduleAPIName as parameter
let attachmentsOperations = new AttachmentsOperations(moduleAPIName, recordId);
//Call downloadAttachment method that takes attachmentId as parameters
let response = await attachmentsOperations.downloadAttachment(attachmentId);
Copiedasync function downloadAttachment() {
const got = require("got");
const fs = require("fs");
const path = require("path");
let url = 'https://www.zohoapis.com/crm/v2.1/Leads/3409643000002267003/Attachments/3409643000002847003'
let headers = {
Authorization : "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
}
let requestDetails = {
method : "GET",
headers : headers,
throwHttpErrors : false
}
let response = await got(url, requestDetails)
if(response != null) {
console.log(response.statusCode);
if(response.headers.hasOwnProperty('content-type')) {
let contentType = response.headers['content-type'].split(";")[0];
if(contentType == 'application/json') {
console.log(response.body);
}
else {
let fileName = "";
let contentDisposition = (response.headers['content-disposition']);
if(contentDisposition.includes("'")){
let startIndex = contentDisposition.lastIndexOf("'");
fileName = contentDisposition.substring(startIndex + 1);
}
else if(contentDisposition.includes("\"")){
let startIndex = contentDisposition.lastIndexOf("=");
fileName = contentDisposition.substring(startIndex + 1).replace(/"/g, "");
}
fileName = path.join("/Users/abc-123/Documents/SDK/nodejs/zohocrm-nodejs-sdk", fileName);
fs.writeFileSync(fileName, response.rawBody);
}
}
}
}
downloadAttachment()
Copiedao = Attachments::AttachmentsOperations.new(module_api_name,record_id)
response = ao.download_attachment(attachment_id)
Copiedrequire 'net/http'
require 'json'
class DownloadAttachment
def execute
url = "https://www.zohoapis.com/crm/v2.1/Leads/3524033000005495065/Attachments/3524033000006019011"
url = URI(url)
req = Net::HTTP::Get.new(url.request_uri)
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
headers={}
headers["Authorization"]="Zoho-oauthtoken 1000.dfa7XXXXXXXXXXXXXXXXXX84f9665840.c176aeXXXXXXXXXXXX13f3d37a84d"
headers&.each { |key, value| req.add_field(key, value) }
response=http.request(req)
file_name = response.to_hash["content-disposition"][0].split('=')[1]
file_name = file_name.split("''")[1] if file_name.include? "''"
file_name = file_name.gsub('"', '') if file_name.include? '"'
status_code = response.code.to_i
headers = response.each_header.to_h
print status_code
print headers
unless response.body.nil?
File.open("/Users/test/RUBY/RUBYNativeSampleCode/"+file_name, 'w') { |file| file.write(response.body) }
end
end
end
DownloadAttachment.new.execute
Copiedresponse = invokeurl
[
url: "https://www.zohoapis.com/crm/v2.1/Leads/100023009/Attachments/100013547"
type: GET
connection:"crm_oauth_connection"
];
info response;
The required file will be downloaded.