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.
^[a-zA-Z0-9\.\:\/\-]+$^[a-zA-Z0-9]+$POST /api/v2/chat/requestChatConfig HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 47
{
"chatServer": "text",
"chatAccountToken": "text"
}No content
Notifies the user of a new chat message.
^[a-zA-Z0-9\.\:\/\-]+$^\+?[a-zA-Z0-9\-]+$^[a-zA-Z0-9]+$8""""1false""""^[a-zA-Z 0-9]+$^\+[0-9]+$POST /api/v2/chat/notifyUserNewChatMessage HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 281
{
"chatServer": "text",
"chatSessionID": "text",
"chatAccountToken": "text",
"channelID": 8,
"message": "",
"url": "",
"messageNumber": 1,
"usedPredefinedUserInput": false,
"additionalData": "",
"externalAddressOverwrite": "",
"customerName": "text",
"emailAddress": "name@gmail.com",
"phoneNumber": "text"
}No content
Notifies the user of a new chat event.
^[a-zA-Z0-9\.\:\/\-]+$^[a-zA-Z0-9\-]+$POST /api/v2/chat/notifyUserNewChatEvent HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 68
{
"chatServer": "text",
"chatSessionID": "text",
"event": "startedtyping"
}No content
Notifies the user of a new chat URL visited.
^[a-zA-Z0-9\.\:\/\-]+$^[a-zA-Z0-9\-]+$POST /api/v2/chat/notifyUserVisited HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 57
{
"chatServer": "text",
"chatSessionID": "text",
"url": "text"
}No content
Notifies the user that the chat has ended.
^[a-zA-Z0-9\.\:\/\-]+$^[a-zA-Z0-9\-]+$POST /api/v2/chat/notifyUserEndChat HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 44
{
"chatServer": "text",
"chatSessionID": "text"
}No content
Adds an attachment to the chat.
^[a-zA-Z0-9\.\:\/\-]+$^\+?[a-zA-Z0-9\-]+$^[a-zA-Z0-9]+$^\+?[0-9]+$POST /api/v2/chat/addAttachment?chatServer=text&chatSessionID=text&chatAccountToken=text HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 19
{
"file": "Ynl0ZXM="
}No content
Checks the origin and IP address of this user.
^[a-zA-Z0-9\.\:\/\-]+$^[a-zA-Z0-9]+$The hostname from the domain to be checked.
^[a-zA-Z0-9\.\-]+$POST /api/v2/chat/checkOriginAndIP HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 75
{
"chatServer": "text",
"chatAccountToken": "text",
"origin": "text",
"ip": "text"
}No content
Returns the chat queue.
^[a-zA-Z0-9]+$POST /api/v2/chat/requestChatQueue HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 27
{
"chatAccountToken": "text"
}No content