Upload File

post

https://mytenant.cx.onecloud.com/clientweb/api/v2/files

This method uploads a file to the server. The maximum file size is 25 MB. The server will store up to 1000 files. Newly received files will replace the oldest files. This method can be used, for example, to send pictures from the client mobile application to the contact center agents.

Returns

Code	Description
200	File ID to be used in the chat_session_file message (content type: application/json)

Errors

Code	Description
400	Bad Request
403	Forbidden

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

tenantUrl

string

Identifies your contact center. It corresponds to the domain name of your contact center that you see in the upper right corner of the Contact Center Administrator application after login. Additionally, this variable allows service providers to specify a particular tenant (i.e., if the request is not sent to the tenant's domain).

Body Params

file

The file or text to be uploaded

Headers

Authorization

string

appId is the unique identifier of the Messaging/Chat scenario entry that will be used to associate your application with a specific scenario. clientId is the unique identifier of the client application. It is used to identify communication sessions of a particular instance of the mobile application (i.e., of a specific mobile device). It must be generated by the mobile application and should be unique for each client application/device combination. If clientId is set to "WebChat", HTTP cookies will be used for client identification.

User-Agent

string

Response

defaultdefault