Download a Photo

Purpose

To download a photo associated with a module.

Request Details

Request URL

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

Supported module

Contacts, Companies, Products

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

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

Possible module names

contacts, companied, products

Possible operation types

ALL - Full access to images
READ - Get photo data

Possible Errors

  • INVALID_MODULEHTTP 400

    The module name given seems to be invalid
    Resolution: You have specified an invalid module name. Specify a valid module API name. Refer to the possible module names section above.

  • 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. Refer to the possible module names section above.

  • 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.{module_name}.READ scope. Create a new client with valid scope. Refer to scope section above.

  • NO_PERMISSIONHTTP 403

    Permission denied to download images
    Resolution: The user does not have permission to download images. 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 images
    Resolution: The user does not have the permission to download images. Contact your system administrator.

Sample Request

Copiedcurl "https://www.zohoapis.com/bigin/v1/Contacts/3000000038009/photo"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
CopiedZBiginRecord record = ZBiginRecord.getInstance("Contacts",123456l);//module api name with record id
FileAPIResponse response = record.downloadPhoto();
InputStream inputStream = response.getFileAsStream();
CommonUtil.saveStreamAsFile(inputStream, "/absolute/path/to/store/file", response.getFileName());
Copiedtry{
$record=ZBiginRecord::getInstance(“Contacts”,”410405000001111007”);
$fileResponseIns=$record->downloadPhoto();
echo "HTTP Status Code:".$fileResponseIns->getHttpStatusCode();
echo "File Name:".$fileResponseIns->getFileName();
$fp=fopen($filePath.$fileResponseIns->getFileName(),"w"); // $filePath - absolute path where the downloaded photo is stored.
$stream=$fileResponseIns->getFileContent();
fputs($fp,$stream);
fclose($fp);
}catch(ZBiginException $e)
{
echo $e->getCode();
echo $e->getMessage();
echo $e->getExceptionCode();
}
Copieddef download_photo(self):
    try:
        record=ZBiginRecord.get_instance('Contacts',1386586000001856002)
        resp=record.download_photo()
        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", 3372164000001632020); //module apiname with record id
FileAPIResponse response = recordIns.DownloadPhoto();
Stream photoStream = response.GetFileAsStream();
CommonUtil.SaveStreamAsFile("/Desktop/test", photoStream, response.GetFileName());
Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/bigin/v1/Contacts/3000000038009/photo"
	type: GET
	connection:"bigin_oauth_connection"
];
info response;

The required photo from the Contacts record with id 3000000038009 will be downloaded.