Jump to: navigation, search

UploadFile

This operation is part of the Chat API section of the Web Services API.

Overview

This request uploads an attached document to the specified chat.

Important
Before executing this operation, you must link the particular chat interaction with the file that the agent wants to send. To link an existing file from standard response, use the AddAttachment operation.
Request URL /api/v2/me/chats/{id}
HTTP Method POST
Required Features api-multimedia

Parameters

Parameter Value
operationName UploadFile
documentId The ID of the document.
uploadType Optional. The file upload type. Possible values include standard-response or file-system.
uploadPath Optional. The file upload path. Possible values include:
  • ID of SR for standard-response upload type
  • Location on HDD where file was taken from for file-system upload type.
description Optional. A description of the file.

Sample

Request

POST api/v2/me/chats/0001PaBMYY3600R8 
 
{
 "operationName": "UploadFile", 
 "documentId": "0001PaBMYY3600RC"
}

Response

{
  "statusCode": 0
}

Notification

{
    "chatPath": "/chats/0001PaBMYY3600R8",
    "chatUri": "http://.../api/v2/chats/0001PaBMYY3600R8",
    "messageType": "MessageLogUpdated",
    "messages": [
        {
            "attachment": {
                "fileId": "009F5790DAD80068",
                "id": "0001PaBMYY3600RC",
                "name": "testfileUploadAgent.txt",
                "path": "/attachments/0001PaBMYY3600RC",
                "size": 46,
                "uri": "http://.../api/v2/attachments/0001PaBMYY3600RC"
            },
            "from": {
                "id": "009F5790DA8D0066",
                "nickname": "TestName",
                "participantId": "009F5790DA8D0066",
                "path": "/users/0bcb93c9854f41d6ad89344047ec3223",
                "type": "Agent",
                "uri": "http://.../api/v2/users/0bcb93c9854f41d6ad89344047ec3223",
                "visibility": "All"
            },
            "index": 7,
            "noticeText": "file-uploaded",
            "timestamp": "2016-07-21 17:23:20.000+0300",
            "timestampSeconds": 1469111000000,
            "type": "SystemCommand",
            "visibility": "All"
        }
    ],
    "notificationType": "NewMessages"
}

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on September 2, 2016, at 11:10.