post https://api.talkdeskapp.com/attachments/2023-03/upload-link
Start the attachment upload process by requesting an upload link generation.
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)
| Parameter | Type | Description | Required |
|---|---|---|---|
| request_id | string | ID that should be used as the request identifier (request_id) when creating the attachment | yes |
| url | string | Upload link address | yes |
400 (invalid validation constraints values), 401 (unauthorized access - invalid or unverifiable JWT), 403 (forbidden)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | no |
| fields | array[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.