DeleteFile
This operation is part of the Chat API section of the Web Services API.
Important
After you execute this operation, use the RemoveAttachment operation in to remove the unused document from Universal Contact Server database. If the related document is no longer referenced by any attachment in any interaction or standard response, the document record is removed from database.Overview
This request deletes an uploaded document from the specified chat.
Request URL | /api/v2/me/chats/{id} |
---|---|
HTTP Method | POST |
Required Features | api-multimedia |
Parameters
Parameter | Value |
---|---|
operationName | DeleteFile |
fileId | The document's identity in the chat. |
Sample
Request
POST api/v2/me/chats/0001PaBMYY3600R8
{
"operationName": "DeleteFile",
"fileId": "009F5790DAD80068"
}
Response
{
"statusCode": 0
}
Notification
{
"chatPath": "/chats/0001PaBMYY3600R8",
"chatUri": "http://.../api/v2/chats/0001PaBMYY3600R8",
"messageType": "MessageLogUpdated",
"messages": [
{
"attachment": {
"fileId": "009F5790DAD80068"
},
"from": {
"id": "009F5790DA8D0066",
"nickname": "TestName",
"participantId": "009F5790DA8D0066",
"path": "/users/0bcb93c9854f41d6ad89344047ec3223",
"type": "Agent",
"uri": "http://.../api/v2/users/0bcb93c9854f41d6ad89344047ec3223",
"visibility": "All"
},
"index": 8,
"noticeText": "file-deleted",
"timestamp": "2016-07-21 17:24:06.000+0300",
"timestampSeconds": 1469111046000,
"type": "SystemCommand",
"visibility": "All"
}
],
"notificationType": "NewMessages"
}
This page was last edited on September 2, 2016, at 19:10.
Comments or questions about this documentation? Contact us for support!