Offline Message
  • 28 Jul 2022
  • 6 Minutes to read
  • Dark
    Light

Offline Message

  • Dark
    Light

Article summary

Offline Message

You need the Delete Transcripts permission to delete Offline Messages.

Offline Message JSON Format

Offline Message is represented as simple flat JSON objects with the following keys:

NameTypeDescription
idintegerId of the offline message.
sessionIdguidId of the session.
createdTimedatetimeCreated time of the offline message.
namestringName of the visitor.
emailstringEmail of the visitor.
phonestringPhone of the visitor.
companystringCompany of the visitor.
departmentIdguidDepartmentId of the offline message.
skillIdguidSkillId of the offline message.
agentIdguidId of the agent.
ticketIdintegerId of the ticket to which this offline message is attached.
subjectstringSubject of the offline message.
messagestringContent of the offline message.
attachmentIdguidId of the attachment.
requestingPageTitlestringRequest page title of the offline message.
requestingPageURLstringRequest page URL of the offline message.
sourcestringAllowed values are "chatButton", "autoInvitation", "manualInvitation", "bot", "queue".
autoInvitationIdguidId of the auto invitation.
campaignIdguidId of the campaign.
guidguidGuid of the offline message.
attachmentFileNamestringAttachment file name of the offline message.
visitorIdguidId of the visitor.
contactIdentityIdguidId of the contact identity.

Get a single Offline Message

GET livechat/offlineMessages/{id}

  • Parameters:

NameTypeinRequiredDescription
idint or guidpathyesId of the offline message or Guid of the offline message.
includestringquerynoAvailable values for Include are: "agent", "autoInvitation", "campaign", "contactIdentity", "department", "offlineMessageFieldResult", "offlineMessageSegmentResult", "session", "skill", "visitor".
  • Response:

Offline Message

  • Example

Sample Request:

curl https://api11.comm100.io/v4/livechat/offlineMessages/1148 \ 
    -X 'GET' \ 
    -H 'Authorization: Bearer {access_token}' \ 

Response:

HTTP/1.1 200 OK

{
  "id": 1184,
  "guid": "51f85e96-ae39-46dc-9973-24c61438bf48",
  "sessionId": "cc14dd5f-a305-4303-b9f6-938ba594e72f",
  "visitorId": "728b10bf-cc90-4c26-bf7d-25d1e59d278c",
  "contactIdentityId": "00000000-0000-0000-0000-000000000000",
  "createdTime": "2021-03-23T07:39:54.005738Z",
  "name": "dsfaf",
  "email": "sdfaf@sfsfaf.com",
  "phone": "",
  "company": "",
  "departmentId": "00000000-0000-0000-0000-000000000000",
  "skillId": "00000000-0000-0000-0000-000000000000",
  "agentId": "00000000-0000-0000-0000-000000000000",
  "subject": "",
  "message": "sdfsdfsadfsafdsaf",
  "attachmentFileName": "db update.txt",
  "attachmentFileKey": "lsHBSpCIOMB99Y6fAK-id2V6x8jBIddlp9rySh6_C4x6z-ktmZDMT8TMxAaSfJJIUMCJTkX2WgofvwPHTqMGPwEnAr1GC6M7oKpS0pdGNZFVpvFDGbvjcaOAXmHAvyfoeLydKlz_GhdU2y018311Ur5FpqKXi6HpdeBLMVD8zfhA                                                                                    ",
  "requestingPageTitle": "Preview",
  "requestingPageURL": "https://dash11.comm100.io/frontEnd/assets/livechat/previewpage/?campaignId=8afd6eb7-2b51-481f-bf5a-681743ffe3b1&siteId=10000&q=1616480015069",
  "source": "queue",
  "autoInvitationId": "00000000-0000-0000-0000-000000000000",
  "campaignId": "8afd6eb7-2b51-481f-bf5a-681743ffe3b1",
  "ticketId": 1845,
  "attachmentFileDownloadUrl": "https://api11.comm100.io/fileservice/v1/files/lsHBSpCIOMB99Y6fAK-id2V6x8jBIddlp9rySh6_C4x6z-ktmZDMT8TMxAaSfJJIUMCJTkX2WgofvwPHTqMGPwEnAr1GC6M7oKpS0pdGNZFVpvFDGbvjcaOAXmHAvyfoeLydKlz_GhdU2y018311Ur5FpqKXi6HpdeBLMVD8zfhA"
} 

Attach to Ticket

POST livechat/offlineMessages/{id}:AttachToTicket

  • Parameters:

NameTypeinRequiredDescription
targetIdintegerbodyyesId of the ticket to which this offline message is attached.
idintpathyesId of the offline message.
utcOffsetintbodyyesUTC Offset of the user.
dateTimeFormatstringbodyyesDatetime format of the user.
  • Response:

No Content

  • Example

Sample Request:

curl https://api11.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

Search Offline Messages

POST livechat/offlineMessages:search

  • Parameters:

NameTypeinRequiredDescription
filtersarraybodyyesFilter array. Available items are: createdTime, departmentId, skillId, agent, campaignId, segmentId.
nameoperatorvalue
createdTimeisSelected time range, e.g., ["2021-04-01T00:00:00-07:00", "2021-05-13T00:00:00-07:00"].
departmentIdisSelected department id, e.g., ["be60bd4a-850e-46ea-96eb-6dcd22893f0e"].
skillIdisSelected skill id, e.g., ["6908B37E-A023-47DC-A24C-08246C2BF22A"].
agentisSelected agent id, e.g., ["0EE2B047-3B23-4170-8186-12F74B18D491"].
campaignIdisSelected campaign id, e.g., ["e8bf0d25-eed6-4a46-a417-318e15019609"].
segmentIdisSelected segment id, e.g., ["b25000d4-844b-4b1d-8a97-ad0300e99fd7"]
pageSizeintegerquerynoPage size. The available value is from 10 to 500, and the default value is 50.
includestringquerynoAvailable values for Include are: "agent", "autoInvitation", "campaign", "contactIdentity", "department", "offlineMessageFieldResult", "offlineMessageSegmentResult", "session", "skill", "visitor".
pageIndexintegerquerynoPage index.
  • Response:

An array of Offline Message

  • Example

Sample Request:

curl https://api11.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

{
  "total": 3,
  "pageCount": 1,
  "list": [
      {
          "id": 1184,
          "guid": "51f85e96-ae39-46dc-9973-24c61438bf48",
          "sessionId": "cc14dd5f-a305-4303-b9f6-938ba594e72f",
          "visitorId": "728b10bf-cc90-4c26-bf7d-25d1e59d278c",
          "contactIdentityId": "00000000-0000-0000-0000-000000000000",
          "createdTime": "2021-03-23T07:39:54.005738Z",
          "name": "dsfaf",
          "email": "sdfaf@sfsfaf.com",
          "phone": "",
          "company": "",
          "departmentId": "00000000-0000-0000-0000-000000000000",
          "skillId": "00000000-0000-0000-0000-000000000000",
          "agentId": "00000000-0000-0000-0000-000000000000",
          "subject": "",
          "message": "sdfsdfsadfsafdsaf",
          "attachmentFileName": "db update.txt",
          "attachmentFileKey": "lsHBSpCIOMB99Y6fAK-id2V6x8jBIddlp9rySh6_C4x6z-ktmZDMT8TMxAaSfJJIUMCJTkX2WgofvwPHTqMGPwEnAr1GC6M7oKpS0pdGNZFVpvFDGbvjcaOAXmHAvyfoeLydKlz_GhdU2y018311Ur5FpqKXi6HpdeBLMVD8zfhA                                                                                    ",
          "requestingPageTitle": "Preview",
          "requestingPageURL": "https://dash11.comm100.io/frontEnd/assets/livechat/previewpage/?campaignId=8afd6eb7-2b51-481f-bf5a-681743ffe3b1&siteId=10000&q=1616480015069",
          "source": "queue",
          "autoInvitationId": "00000000-0000-0000-0000-000000000000",
          "campaignId": "8afd6eb7-2b51-481f-bf5a-681743ffe3b1",
          "ticketId": 1845,
          "session": {
              "id": "cc14dd5f-a305-4303-b9f6-938ba594e72f",
              "visitorId": "728b10bf-cc90-4c26-bf7d-25d1e59d278c",
              "contactIdentityId": "00000000-0000-0000-0000-000000000000",
              "ip": "192.168.2.29",
              "referrerURL": "https://dash11.comm100.io/frontEnd/assets/livechat/previewpage/?campaignId=8afd6eb7-2b51-481f-bf5a-681743ffe3b1&siteId=10000",
              "searchEngineId": "00000001-0000-0000-0000-000000000001",
              "keywords": "",
              "landingPageURL": "https://dash11.comm100.io/frontEnd/assets/livechat/previewpage/?campaignId=8afd6eb7-2b51-481f-bf5a-681743ffe3b1&siteId=10000&q=1616480015069",
              "landingPageTitle": "",
              "startTime": "2021-03-23T07:35:12.3633333Z",
              "browser": "Google Chrome 81.0.4044.129",
              "operatorSystem": "Windows 8.1",
              "screenResolution": "2048x1152",
              "language": "en-US",
              "timeZone": "-480"
          }
      },
      {
          "id": 1183,
          "guid": "2f29210e-f165-46e1-bff3-c4d8c795f12d",
          "sessionId": "cc14dd5f-a305-4303-b9f6-938ba594e72f",
          "visitorId": "728b10bf-cc90-4c26-bf7d-25d1e59d278c",
          "contactIdentityId": "00000000-0000-0000-0000-000000000000",
          "createdTime": "2021-03-23T07:36:01.6007445Z",
          "name": "dsfaf",
          "email": "sdfaf@sfsfaf.com",
          "phone": "",
          "company": "",
          "departmentId": "00000000-0000-0000-0000-000000000000",
          "skillId": "00000000-0000-0000-0000-000000000000",
          "agentId": "00000000-0000-0000-0000-000000000000",
          "subject": "",
          "message": "sdfsfsdfa",
          "attachmentFileName": "web.config",
          "attachmentFileKey": "0Ny4m48k_ytwouBVvs2At26OlUJQ1U8eaSaEX2yrCHSukfsCGL719gVS0ViTPn3XnMZrWcloOanOb2PvD70EZAlf1dhhax-CsPnZr01bVjs5bbehsGjV6q_20nu8cn-Y3N_DYFeUE_vgyDg3E-mLBMXaps5qsPvG-WNgJX8_SiDw                                                                                    ",
          "requestingPageTitle": "Preview",
          "requestingPageURL": "https://dash11.comm100.io/frontEnd/assets/livechat/previewpage/?campaignId=8afd6eb7-2b51-481f-bf5a-681743ffe3b1&siteId=10000&q=1616480015069",
          "source": "queue",
          "autoInvitationId": "00000000-0000-0000-0000-000000000000",
          "campaignId": "8afd6eb7-2b51-481f-bf5a-681743ffe3b1",
          "ticketId": 1840,
          "session": {
              "id": "cc14dd5f-a305-4303-b9f6-938ba594e72f",
              "visitorId": "728b10bf-cc90-4c26-bf7d-25d1e59d278c",
              "contactIdentityId": "00000000-0000-0000-0000-000000000000",
              "ip": "192.168.2.29",
              "referrerURL": "https://dash11.comm100.io/frontEnd/assets/livechat/previewpage/?campaignId=8afd6eb7-2b51-481f-bf5a-681743ffe3b1&siteId=10000",
              "searchEngineId": "00000001-0000-0000-0000-000000000001",
              "keywords": "",
              "landingPageURL": "https://dash11.comm100.io/frontEnd/assets/livechat/previewpage/?campaignId=8afd6eb7-2b51-481f-bf5a-681743ffe3b1&siteId=10000&q=1616480015069",
              "landingPageTitle": "",
              "startTime": "2021-03-23T07:35:12.3633333Z",
              "browser": "Google Chrome 81.0.4044.129",
              "operatorSystem": "Windows 8.1",
              "screenResolution": "2048x1152",
              "language": "en-US",
              "timeZone": "-480"
          }
      },
      {
          "id": 1182,
          "guid": "1713c9c5-fb2d-4c58-99c8-ec595b446d27",
          "sessionId": "321b75e9-8f61-4213-99fc-c2233148d719",
          "visitorId": "4d53ff8b-9aa6-491b-86ca-5f6fab18edcb",
          "contactIdentityId": "00000000-0000-0000-0000-000000000000",
          "createdTime": "2021-03-23T07:28:31.604738Z",
          "name": "dsfaf",
          "email": "sdfaf@sfsfaf.com",
          "phone": "",
          "company": "",
          "departmentId": "00000000-0000-0000-0000-000000000000",
          "skillId": "00000000-0000-0000-0000-000000000000",
          "agentId": "00000000-0000-0000-0000-000000000000",
          "subject": "",
          "message": "sdafsadf",
          "attachmentFileName": "",
          "attachmentFileKey": "                                                                                                                                                                                                                                                                ",
          "requestingPageTitle": "Preview",
          "requestingPageURL": "https://dash11.comm100.io/frontEnd/assets/livechat/previewpage/?campaignId=8afd6eb7-2b51-481f-bf5a-681743ffe3b1&siteId=10000&q=1616480015069",
          "source": "queue",
          "autoInvitationId": "00000000-0000-0000-0000-000000000000",
          "campaignId": "8afd6eb7-2b51-481f-bf5a-681743ffe3b1",
          "ticketId": 1847,
          "session": {
              "id": "321b75e9-8f61-4213-99fc-c2233148d719",
              "visitorId": "4d53ff8b-9aa6-491b-86ca-5f6fab18edcb",
              "contactIdentityId": "00000000-0000-0000-0000-000000000000",
              "ip": "192.168.2.29",
              "referrerURL": "https://dash11.comm100.io/frontEnd/assets/livechat/previewpage/?campaignId=8afd6eb7-2b51-481f-bf5a-681743ffe3b1&siteId=10000",
              "searchEngineId": "00000001-0000-0000-0000-000000000001",
              "keywords": "",
              "landingPageURL": "https://dash11.comm100.io/frontEnd/assets/livechat/previewpage/?campaignId=8afd6eb7-2b51-481f-bf5a-681743ffe3b1&siteId=10000&q=1616480015069",
              "landingPageTitle": "",
              "startTime": "2021-03-23T07:28:02.08Z",
              "browser": "Google Chrome 81.0.4044.129",
              "operatorSystem": "Windows 8.1",
              "screenResolution": "2048x1152",
              "language": "en-US",
              "timeZone": "-480"
          }
      }
  ],
  "pageIndex": 0,
  "pageSize": 50
} 

Update the Offline Message

PUT livechat/offlineMessages/{id}

  • Parameters:

NameTypeinRequiredDescription
sessionIdguidbodynoId of the session.
createdTimedatetimebodynoCreated time of the offline message.
namestringbodynoName of the visitor.
emailstringbodynoEmail of the visitor.
phonestringbodynoPhone of the visitor.
companystringbodynoCompany of the visitor.
departmentIdguidbodynoDepartmentId of the offline message.
skillIdguidbodynoSkillId of the offline message.
agentIdguidbodynoId of the agent.
ticketIdintegerbodynoId of the ticket to which this offline message is attached.
subjectstringbodynoSubject of the offline message.
messagestringbodynoContent of the offline message.
attachmentIdguidbodynoId of the attachment.
requestingPageTitlestringbodynoRequest page title of the offline message.
requestingPageURLstringbodynoRequest page URL of the offline message.
sourcestringbodynoAllowed values are "chatButton", "autoInvitation", "manualInvitation", "bot", "queue".
autoInvitationIdguidbodynoId of the auto invitation.
campaignIdguidbodynoId of the campaign.
guidguidbodynoGuid of the offline message.
attachmentFileNamestringbodynoAttachment file name of the offline message.
visitorIdguidbodynoId of the visitor.
contactIdentityIdguidbodynoId of the contact identity.
  • Response:

Offline Message

  • Example

Sample Request:

curl https://api11.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":"D0624110-6F9F-4DD5-A03C-A703AD1339FC","skillId":"6908B37E-A023-47DC-A24C-08246C2BF22A","agentId":"D6B15329-7C46-EB11-8100-00155D081D0B","ticketId":1,"subject":"test","message":"message content","attachmentId":"1c066608-71b8-4f07-90a7-6cc1306602dc","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

{
  "id": 1,
  "sessionId": "CFB15329-7C46-EB11-8100-00155D081D0B",
  "createdTime": "2021-04-28T09:15:01.71Z",
  "name": "Jason",
  "email": "jason@comm100.com",
  "phone": "1234567890",
  "company": "Comm1000",
  "departmentId": "D0624110-6F9F-4DD5-A03C-A703AD1339FC",
  "skillId":"6908B37E-A023-47DC-A24C-08246C2BF22A",
  "agentId": "D6B15329-7C46-EB11-8100-00155D081D0B",
  "ticketId": 1,
  "subject": "test",
  "message": "message content",
  "attachmentId": "1c066608-71b8-4f07-90a7-6cc1306602dc",
  "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"
} 

Batch Delete Offline Messages

DELETE livechat/offlineMessages

  • Parameters:

NameTypeinRequiredDescription
Request bodyjson stringbodyyesId array of the offline messages.
  • Response:

No Content

  • Example

Sample Request:

curl https://api11.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:

NameTypeinRequiredDescription
idintpathyesId of the offline message.
  • Response:

No Content

  • Example

Sample Request:

curl https://api11.comm100.io/v4/livechat/offlineMessages/1 \ 
    -X 'DELETE' \ 
    -H 'Authorization: Bearer {access_token}' \ 

Response:

HTTP/1.1 204 No Content


Was this article helpful?

What's Next