Attachments API
Overview
The Attachments API allows third-party users to securely upload and download attachments such as videos and images. The Attachments API is primarily used with the Digital Connect API.
Business Context
What Can You Achieve with the Attachments API?
The Attachments API allows the contact person to upload or download attachments, such as multimedia files. Any file can be uploaded or downloaded through the Attachments API, with the attachments being stored in Amazon AWS S3.
Business Problems the Attachments API Solves
The Attachments API allows agents and contacts to easily send and receive attachments. The attachment ID in the Attachments API is passed through the Digital Connect API.
What the Attachments API doesn't Support
The Attachments API does not perform a security scan on attachments. It is the user's responsibility to ensure the security of the attached files.
Use Case
As a real-life example, consider the scenario where a third-party partner needs to upload or download attachments and send them through the Digital Cconnect API. The Attachments API can be used to execute this task. For example, agents can attach screenshots or video tutorials to help customers troubleshoot issues, or sales agents can send product brochures or demos to prospects.
Usage
To upload an attachment file, you need to call the Attachments API to obtain an upload link, and then upload the attachment to AWS S3 using the link (as shown in Figure 1). After the attachment is uploaded, an attachment ID is generated, which can be passed via the Digital Connect API to Talkdesk for download.
Figure 1 - Send a message with attachments
When a message with the attachment ID is received (as shown in Figure 2), the ID can be used to call the Attachment APIs to obtain the download link and download the attachment from AWS S3. More details on each of the Attachments API endpoints can be found below.
Figure 2 - Receive a message with attachments
- Get the attachment upload link - this endpoint generates an upload link that can be used to upload attachments to the Amazon server.
- Create an attachment - based on the
request_idparameter obtained from the Get Attachment Upload Link response. - Get an attachment by ID.
- Get the attachment download link - this endpoint generates a temporary download link (valid for 10 minutes) to access the attachment's data.
API Availability
The Attachments API is only available for customers enrolled in Talkdesk's Early Access (EA) program. To enter the EA program, contact a Customer Success Manager.
The Attachments API has been in EA since May 2023.
Troubleshooting
If you have questions or technical issues, please open a ticket using this form.
Updated 7 months ago