Contents
- Introduction
- API Methods
- General Information
- Check Availability
- Expected Parameters
- Request Chat
- Request SMS Chat Session
- Get Active Chat
- Send Events
- Get Chat History
- Get New Chat Events
- 1 Upload File
- Get File
- Get Agent Profile Photo
- API Events
Upload File
Upload File 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.
URI
http[s]://<host>:<port>/clientweb/api/v1/files?tenantUrl=<tenantUrl>
HTTP Method
POST
Authentication
Authorization: MOBILE-API-140-327-PLAIN appId="<Unique app identifier>", clientId="<Unique client ID>"
Parameters
tenantUrl – Specifies the tenant if the request was not sent to the tenant’s domain
Request Body
File to be uploaded (content type: mulitpart/form-data)
Example
file={file to upload} |
Returns
200 – file ID to be used in the chat_session_file message (content type: application/json)
Example
| {
"file_id":”file ID to use in chat_session_file message” } |
Errors
401 – Unauthorized