Generate signed URL to download an attachment

Overview

This API allows to get signed URL to download a single attachment.

Actor can download attachments using 'contentUrl' returned in the response of this API.

Permissions

Actor Permission
User All of the following are required:
  • If logged in user is a department user:
    • User must have 'View Agent Console' action on 'System' resource.
    • An activity of requested attachment must belong to either the user's home department, or to the department where the user is a foreign user.
  • If logged in user is a global user, one of the following is required:
    • User must have 'Administer' permission on the department of activity of requested attachment.
    • User must have 'Manage partition resources' privilege.
Customer One of the following is required:
  • An activity of requested attachment must belong to logged in customer.
  • An activity of requested attachment must belong to the customer whose activity can be viewed by logged in customer.
Client Application No additional permission is required.
SecurityoAuthUser or oAuthClient
Request
header Parameters
Accept
required
string
Default: application/json

Content type accepted by client.

Enum: "application/json" "application/xml"
Accept-Language
required
string
Default: en-US

Language locale accepted by client (used for locale specific fields in resource representation and in error responses).

Enum: "en-US" "es-ES" "fr-FR" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR" "sv-SE"
Request Body schema: application/json
object (link)

Self link that can be used to retrieve this attachment

fileName
string (fileName)

File name of the attachment

name
string [ 1 .. 255 ] characters [a-zA-Z0-9]|@|\s|:|.|_|-|&|[\x80-\xFF]

Name of file with extension.

contentType
string (contentType)

Mime-type of the attachment

size
integer <int64> (size)

Attachment size in bytes

app
required
string

Application type

Enum: "email" "task" "calltrack"
type
required
string

Attachment type

Enum: "attachment.inbound" "attachment.outbound" "attachment"
signedUrlExpiry
string <date-time>

Signed URL expiry time in GMT.

encodingType
string (encodingType)

Content-transfer-encoding of the attachment

charset
string (charset)

character-set encoding of the attachment

blocked
boolean (blocked)

Field to convey if the attachment is blocked

inline
boolean (inline)

Field to convey if the attachment is an inline attachment

contentId
string (contentId)

Cid of the inline attachment

contentUrl
string (contentUrl)

Url of the content

created
string <date-time>

Created time in GMT

content
string (content)

content of the attachment

messageText
string (messageText)

Informational text about the attachment.

id
string (id)

ID of the attachment

altId
required
string (altId)

Alternate ID of the attachment

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

post/assets/predownload
Request samples
application/json
{
  • "app": "email",
  • "type": "attachment.inbound",
  • "altId": "7b6c5fff-036e-4a40-b68a-a67c592fc079"
}
Response samples