Calls: send file

Sends a file to a guest during a chat.

Authentication

LibraryH3lp supports cookie-based authentication. To learn more, you can read the details on authentication.

HTTP and HTTPS

Requests are served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported.

URI

/2011-12-03/queues/{QueueName}/calls/{GuestJid}/{ConversationId}/file

HTTP GET

Not supported.

HTTP POST

Sends the specified file to a guest during a chat. Unlike other requests, this POST uses multipart/form-data as the content type rather than application/x-www-form-urlencoded.

Required Parameters

You must POST using the following parameter:

Parameter Description
file A file sent using multipart/form-data.

Response

Returns a JSON response with the following properties:

Property Description
success Boolean indicating if the request was successful.
message Optional. If success is null, message is a string describing the reason for the failed request.

Example

POST /2011-12-03/queues/example-queue/calls/5189487901334778072897@libraryh3lp.com/1790260/file
Note: POST is URL decoded above for clarity.

{
  "success": true
}

HTTP PUT

Not supported.

HTTP DELETE

Not supported.