post https://api.talkdeskapp.com/digital-connect/conversations//messages
Create a Digital Connect conversation inbound messages
Attachements Info
See the Attachments API (EA) if you have questions about attachments.
Scope
digital-connect:write
Body Request - Example
{
"content": "A cute message for the agent to read, with love: Contact Person",
"attachments": [
{
"id": "my-mp3-id",
"name": "test.mp3",
"type": "audio/mpeg",
"size": "1024"
},
{
"id": "my-image-id",
"name": "test.jpg",
"type": "image/jpeg",
"size": "3072"
}
]
}
Body Response - Schema
201 (success: creates a new message in the designated conversation)
| Parameter | Type | Description | Required |
|---|---|---|---|
| id | string | The identifier of the conversation. >= 1 characters <= 255 characters | no |
| created_at | string | > = 24 characters <= 24 characters | no |
| message_id | string | The identifier of the outbound message. > = 1 characters <= 255 characters |
206 (partial success: creates message success, but attachments have some problems)
| Parameter | Type | Description | Required |
|---|---|---|---|
| id | string | The identifier of the conversation. >= 1 characters <= 255 characters | no |
| created_at | string | > = 24 characters <= 24 characters | no |
| message_id | string | The identifier of the outbound message. > = 1 characters <= 255 characters | no |
| partial_fail_reason | string | The fail reason for the attachments | no |
400 (malformed request), 401 (unauthorized), 403 (forbidden), 404 (not found), 409 (conflict)
| 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 Digital Connect 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 Digital Connect API has been in EA since April 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.