Agent Private Message
Agent Private Messages
- Agent Private Messages Manage
POST livechat/agentPrivateMessages:Search
Model
Agent Private Message JSON Format
Agent Private Message is represented as simple flat JSON objects with the following keys:
| Name | Type | Description |
|---|---|---|
id |
integer | Id of the private message. |
formAgentId |
guid | Id of the sender agent. |
toAgentId |
guid | Id of the recipient agent. |
content |
string | Content of the private message. |
attachmentFileKey |
string | Key value of the attachment. |
time |
datetime | Time of the private message. |
Endpoint
Search Agent Private Messages
POST livechat/agentPrivateMessages:Search
Parameters:
| Name | Type | In | Required | Description |
|---|---|---|---|---|
pageIndex |
integer | query | no | Page index. |
filters |
array | body | no | Filter array. Available items are: requestedTime, agent. |
pageSize |
integer | query | no | Page size. |
include |
string | query | no | Available values for Include are: "campaign", "chatAgent", "chatWrapupCategory", "contactIdentity", "department", "fromAgent", "toAgent". |
Response:
An array of Agent Private Message
Example
Sample Request:
curl https://api15.comm100.io/v4/livechat/agentPrivateMessages:search \
-X
'POST'
\
-H
'Authorization: Bearer {access_token}'
\
-H
'Content-Type: application/json'
\
-D
'{"filters":[{"name":"time","operator":"is","value":["2021-04-24T07:00:00.000Z","2021-04-25T07:00:00.000Z"]},{"name":"keywords","operator":"is","value":["hello"]}]}'
Response:
HTTP/1.1 200 OK