Get Attachment Upload Link

Start the attachment upload process by requesting an upload link generation.

📘

Supported Regions and Base URLs

👍

Access and Registration

Authentication

Scope

attachments:request

Body Request - Example

{
  "allowed_mime_types": [
    "audio/mp3",
    "audio/wav"
  ]
}

Body Schema - Response

200 OK (the newly generated upload link and request ID)

ParameterTypeDescriptionRequired
request_idstringID that should be used as the request identifier (request_id) when creating the attachmentyes
urlstringUpload link addressyes

400 (invalid validation constraints values), 401 (unauthorized access - invalid or unverifiable JWT), 403 (forbidden)

ParameterTypeDescriptionRequired
codestringn/ayes
messagestringn/ayes
descriptionstringn/ano
fieldsarray[object]"fields" subdivides into:

"name" (string)

"description" (string)
yes (name and description)

❗️

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 Sucess Manager.

The Attachments API has been in GA since May 2022.

🚧

Troubleshooting

If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.

Language
Authorization
Header
Click Try It! to start a request and see the response here!