Chat
All the endpoints that can be called on the Chat controller.
All endpoints require the API_CHAT permission.
Requests chat configuration by this chat's details.
type: ^[a-zA-Z0-9\.\:\/\-]+$
type: ^[a-zA-Z0-9]+$
Successful response
POST /api/v2/chat/requestChatConfig HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 47
{
"chatServer": "text",
"chatAccountToken": "text"
}Successful response
Notifies the user of a new chat message.
type: ^[a-zA-Z0-9\.\:\/\-]+$
type: ^\+?[a-zA-Z0-9\-]+$
type: ^[a-zA-Z0-9]+$
type: number = 8
type: string
type: string = ' '
type: number = 1
type: string = false
type: string = ' '
type: string = ' '
type: ^[a-zA-Z 0-9]+$ = null
type: email
type: ^\+[0-9]+$ = null
Successful response
POST /api/v2/chat/notifyUserNewChatMessage HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 295
{
"chatServer": "text",
"chatSessionID": "text",
"chatAccountToken": "text",
"channelID": " ",
"message": "text",
"url": "text",
"messageNumber": "text",
"usedPredefinedUserInput": "text",
"additionalData": "text",
"externalAddressOverwrite": "text",
"customerName": "text",
"emailAddress": "text",
"phoneNumber": "text"
}Successful response
Notifies the user of a new chat event.
type: ^[a-zA-Z0-9\.\:\/\-]+$
type: ^[a-zA-Z0-9\-]+$
type: ^startedtyping|stoppedtyping|expandedchat|minimizedchat$
Successful response
POST /api/v2/chat/notifyUserNewChatEvent HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 59
{
"chatServer": "text",
"chatSessionID": "text",
"event": "text"
}Successful response
Notifies the user of a new chat URL visited.
type: ^[a-zA-Z0-9\.\:\/\-]+$
type: ^[a-zA-Z0-9\-]+$
type: string
Successful response
POST /api/v2/chat/notifyUserVisited HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 57
{
"chatServer": "text",
"chatSessionID": "text",
"url": "text"
}Successful response
Notifies the user that the chat has ended.
type: ^[a-zA-Z0-9\.\:\/\-]+$
type: ^[a-zA-Z0-9\-]+$
Successful response
POST /api/v2/chat/notifyUserEndChat HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 44
{
"chatServer": "text",
"chatSessionID": "text"
}Successful response
Adds an attachment to the chat.
type: binary
Successful response
POST /api/v2/chat/addAttachment HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17
{
"file": "binary"
}Successful response
Checks the origin and IP address of this user.
type: ^[a-zA-Z0-9\.\:\/\-]+$
type: ^[a-zA-Z0-9]+$
type: ^[a-zA-Z0-9\.\-]+$
The hostname from the domain to be checked.
type: string
Successful response
POST /api/v2/chat/checkOriginAndIP HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 75
{
"chatServer": "text",
"chatAccountToken": "text",
"origin": "text",
"ip": "text"
}Successful response
Returns all the whitelisted domains and blacklisted IP addresses.
Successful response
GET /api/v2/chat/whitelistedDomainsAndBlacklistedIPs HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Accept: */*
Successful response
Returns the chat queue.
type: ^[a-zA-Z0-9]+$
Successful response
POST /api/v2/chat/requestChatQueue HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 27
{
"chatAccountToken": "text"
}Successful response
Last updated