Offline Message
You need the Delete Transcripts permission to delete Offline Messages.
Offline Messages
- Offline Messages Manage
GET livechat/offlineMessages/{id}
POST livechat/offlineMessages:search
POST livechat/offlineMessages/{id}:AttachToTicket
PUT livechat/offlineMessages/{id}
DELETE livechat/offlineMessages
DELETE livechat/offlineMessages/{id}
Model
Offline Message JSON Format
Offline Message is represented as simple flat JSON objects with the following keys:
| Name | Type | Description |
|---|---|---|
id |
integer | Id of the offline message. |
sessionId |
guid | Id of the session. |
createdTime |
datetime | Created time of the offline message. |
name |
string | Name of the visitor. |
email |
string | Email of the visitor. |
phone |
string | Phone of the visitor. |
company |
string | Company of the visitor. |
departmentId |
guid | Department of the offline message. |
agentId |
guid | Id of the agent. |
ticketId |
integer | Id of the ticket to which this offline message is attached. |
subject |
string | Subject of the offline message. |
message |
string | Content of the offline message. |
attachmentId |
guid | Id of the attachment. |
requestingPageTitle |
string | Request page title of the offline message. |
requestingPageURL |
string | Request page URL of the offline message. |
source |
string | Allowed values are "chatButton", "autoInvitation", "manualInvitation", "bot", "queue". |
autoInvitationId |
guid | Id of the auto invitation. |
campaignId |
guid | Id of the campaign. |
guid |
guid | Guid of the offline message. |
attachmentFileName |
string | Attachment file name of the offline message. |
visitorId |
guid | Id of the visitor. |
contactIdentityId |
guid | Id of the contact identity. |
Endpoint
Get a single Offline Message
GET livechat/offlineMessages/{id}
Parameters:
| Name | Type | In | Required | Description |
|---|---|---|---|---|
id |
int or guid | path | yes | Id of the offline message or Guid of the offline message. |
include |
string | query | no | Available values for Include are: "agent", "autoInvitation", "campaign", "contactIdentity", "department", "offlineMessageFieldResult", "offlineMessageSegmentResult", "session", "visitor". |
Response:
Example
Sample Request:
curl https://api15.comm100.io/v4/livechat/offlineMessages/1148 \
-X
'GET'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 200 OK
Search Offline Messages
POST livechat/offlineMessages:search
Parameters:
| Name | Type | In | Required | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
filters |
array | body | no | Filter array. Available items are: createdTime, departmentId, agent, campaignId, segmentId.
|
||||||||||||||||||
pageSize |
integer | query | no | Page size. The available value is from 10 to 500, and the default value is 50. | ||||||||||||||||||
include |
string | query | no | Available values for Include are: "agent", "autoInvitation", "campaign", "contactIdentity", "department", "offlineMessageFieldResult", "offlineMessageSegmentResult", "session", "visitor". | ||||||||||||||||||
pageIndex |
integer | query | no | Page index. |
Response:
An array of Offline Message
Example
Sample Request:
curl https://api15.comm100.io/v4/livechat/offlineMessages:search?pageIndex=1&pageSize=50 \
-X
'POST'
\
-H
'Authorization: Bearer {access_token}'
\
-H
'Content-Type: application/json'
\
-D
'{"filters":[{"name":"createdTime","operator":"is","value":["2021-03-23T00:00:00-07:00","2021-04-25T00:00:00-07:00"]}]}'
Response:
HTTP/1.1 200 OK
Attach to Ticket
POST livechat/offlineMessages/{id}:AttachToTicket
Parameters:
| Name | Type | In | Required | Description |
|---|---|---|---|---|
targetId |
integer | body | yes | Id of the ticket to which this offline message is attached. |
id |
int | path | yes | Id of the offline message. |
utcOffset |
int | body | yes | UTC Offset of the user. |
dateTimeFormat |
string | body | yes | Datetime format of the user. |
Response:
No Content
Example
Sample Request:
curl https://api15.comm100.io/v4/livechat/offlineMessages/1:AttachToTicket \
-X
'POST'
\
-H
'Authorization: Bearer {access_token}'
\
-H
'Content-Type: application/json'
\
-D
'{"targetId":"2858","utcOffset":-420,"datetimeFormat":"YYYY/MM/DD HH:mm:ss"}'
Response:
HTTP/1.1 200 OK
Update the Offline Message
PUT livechat/offlineMessages/{id}
Parameters:
| Name | Type | In | Required | Description |
|---|---|---|---|---|
sessionId |
guid | body | no | Id of the session. |
createdTime |
datetime | body | no | Created time of the offline message. |
name |
string | body | no | Name of the visitor. |
email |
string | body | no | Email of the visitor. |
phone |
string | body | no | Phone of the visitor. |
company |
string | body | no | Company of the visitor. |
departmentId |
guid | body | no | Department of the offline message. |
agentId |
guid | body | no | Id of the agent. |
ticketId |
integer | body | no | Id of the ticket to which this offline message is attached. |
subject |
string | body | no | Subject of the offline message. |
message |
string | body | no | Content of the offline message. |
attachmentId |
guid | body | no | Id of the attachment. |
requestingPageTitle |
string | body | no | Request page title of the offline message. |
requestingPageURL |
string | body | no | Request page URL of the offline message. |
source |
string | body | no | Allowed values are "chatButton", "autoInvitation", "manualInvitation", "bot", "queue". |
autoInvitationId |
guid | body | no | Id of the auto invitation. |
campaignId |
guid | body | no | Id of the campaign. |
guid |
guid | body | no | Guid of the offline message. |
attachmentFileName |
string | body | no | Attachment file name of the offline message. |
visitorId |
guid | body | no | Id of the visitor. |
contactIdentityId |
guid | body | no | Id of the contact identity. |
Response:
Example
Sample Request:
curl https://api15.comm100.io/v4/livechat/offlineMessages/1 \
-X
'PUT'
\
-H
'Authorization: Bearer {access_token}'
\
-H
'Content-Type: application/json'
\
-D
'{"sessionId":"CFB15329-7C46-EB11-8100-00155D081D0B","createdTime":"2021-04-28T09:15:01.71Z","name":"Jason","email":"jason@comm100.com","phone":"1234567890","company":"Comm1000","departmentId":"Sale","agentId":"D6B15329-7C46-EB11-8100-00155D081D0B","ticketId":1,"subject":"test","message":"message content","attachmentId":"15ad5e8b-fcd5-44bc-8c91-ebc86c6cfb65","requestingPageTitle":"","requestingPageURL":"","source":"chatButton","autoInvitationId":"00000000-0000-0000-0000-000000000000","campaignId":"DFB15329-7C46-EB11-8100-00155D081D0B","guid":"C3B35329-7C46-EB11-8100-00155D081D0B","attachmentFileName":"","visitorId":"F0B35329-7C46-EB11-8100-00155D081D0B","contactIdentityId":"F1B35329-7C46-EB11-8100-00155D081D0B"}'
Response:
HTTP/1.1 200 OK
Batch Delete Offline Messages
DELETE livechat/offlineMessages
Parameters:
| Name | Type | In | Required | Description |
|---|---|---|---|---|
Request body |
json string | body | yes | Id array of the offline messages. |
Response:
No Content
Example
Sample Request:
curl https://api15.comm100.io/v4/livechat/offlineMessages \
-X
'DELETE'
\
-H
'Authorization: Bearer {access_token}'
\
-D
'[1184,1183]'
Response:
HTTP/1.1 200 OK
Remove the Offline Message
DELETE livechat/offlineMessages/{id}
Parameters:
| Name | Type | In | Required | Description |
|---|---|---|---|---|
id |
int | path | yes | Id of the offline message. |
Response:
No Content
Example
Sample Request:
curl https://api15.comm100.io/v4/livechat/offlineMessages/1 \
-X
'DELETE'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 204 No Content