From Bright Pattern Documentation
< 3.17:Mobile-web-api-specification
Revision as of 22:06, 17 October 2017 by Tracy (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
• 3.10 • 3.11 • 3.12 • 3.13 • 3.14 • 3.15 • 3.16 • 3.17 • 3.18

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


< Previous | Next >
< Previous | Next >