Installation
  • 28 Jul 2022
  • 1 Minute to read
  • Dark
    Light

Installation

  • Dark
    Light

Article summary

Installation

You need the Manage campaigns permission to get live chat code.

  • Installations - Installations Manage

Installation JSON Format

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

NameTypeDescription
installationCodestringThe main live chat code.
installationSecondCodestringThe second live chat code.
installationChatLinkstringThe chat window link of visitor side.

Installation Code

GET livechat/campaigns/{id}/installation

  • Parameters:

NameTypeinRequiredDescription
idstringpathyesId of the Campaign.
  • Response:

Installation

  • Example

Sample Request:

curl https://api11.comm100.io/v4/LiveChat/campaigns/22f0b296-69e9-4b81-abe4-4bb9ed5ec9ef/installation \ 
    -X 'GET' \ 
    -H 'Authorization: Bearer {access_token}' \ 

Response:

HTTP/1.1 200 OK

{
  "installationCode": "\r\n<div></div>\r\n\r\n",
  "installationSecondCode": "\r\n<div></div>\r\n\r\n"
  "installationChatLink": "\r\n<div></div>\r\n\r\n"
} 

Was this article helpful?