Get serenity chat channel configuration.

GET 
/api/v2/channel/serenity-chat/:agentCode

Get serenity chat channel configuration.

Request

Path Parameters

agentCode stringrequired

Query Parameters

culture string

Use this param to override the culture of the response. Options: - en (default) - es

Responses

200

Success

text/plain

Schema

Schema

expanded boolean
allowUpload boolean
storeConversation boolean
stream boolean
extractPageContent boolean
userIdentifier stringnullable
logoURL stringnullable
mode stringnullable

engagementMessage

object

enabled boolean

message stringnullable

showAfter int32

locale

object

uploadFileErrorMessage stringnullable

uploadFilesErrorMessage stringnullable

chatErrorMessage stringnullable

chatInitConversationErrorMessage stringnullable

headerTitle stringnullable

finalizedMessage stringnullable

limitExceededMessage stringnullable

waitUntilMessage stringnullable

remainingMessage stringnullable

inputPlaceholder stringnullable

internalLinkMessage stringnullable

newChatBtnMessage stringnullable

exceededMaxNumberOfFilesMessage stringnullable

exceededMaxFileStatusChecksMessage stringnullable

theme

object

header

object

bgColor stringnullable

textColor stringnullable

resetChatBtn

object

bgColor stringnullable

hoverBgColor stringnullable

textColor stringnullable

minimizeBtn

object

iconStrokeColor stringnullable

fabButton

object

bgColor stringnullable

iconStrokeColor stringnullable

buttonSize int32

iconSize int32

sendButton

object

bgColor stringnullable

iconStrokeColor stringnullable

engagementMessage

object

bgColor stringnullable

textColor stringnullable

conversationStarters

object

bgColor stringnullable

textColor stringnullable

containerBgColor stringnullable

initialMessageBgColor stringnullable

initialMessageTextColor stringnullable

scrollToBottomIndicator

object

bgColor stringnullable

iconStrokeColor stringnullable

uploadFileBtn

object

iconStrokeColor stringnullable

messageBubble

object

user

object

bgColor stringnullable

textColor stringnullable

assistant

object

bgColor stringnullable

textColor stringnullable

Example (from schema)

{
  "expanded": true,
  "allowUpload": true,
  "storeConversation": true,
  "stream": true,
  "extractPageContent": true,
  "userIdentifier": "string",
  "logoURL": "string",
  "mode": "string",
  "engagementMessage": {
    "enabled": true,
    "message": "string",
    "showAfter": 0
  },
  "locale": {
    "uploadFileErrorMessage": "string",
    "uploadFilesErrorMessage": "string",
    "chatErrorMessage": "string",
    "chatInitConversationErrorMessage": "string",
    "headerTitle": "string",
    "finalizedMessage": "string",
    "limitExceededMessage": "string",
    "waitUntilMessage": "string",
    "remainingMessage": "string",
    "inputPlaceholder": "string",
    "internalLinkMessage": "string",
    "newChatBtnMessage": "string",
    "exceededMaxNumberOfFilesMessage": "string",
    "exceededMaxFileStatusChecksMessage": "string"
  },
  "theme": {
    "header": {
      "bgColor": "string",
      "textColor": "string",
      "resetChatBtn": {
        "bgColor": "string",
        "hoverBgColor": "string",
        "textColor": "string"
      },
      "minimizeBtn": {
        "iconStrokeColor": "string"
      }
    },
    "fabButton": {
      "bgColor": "string",
      "iconStrokeColor": "string",
      "buttonSize": 0,
      "iconSize": 0
    },
    "sendButton": {
      "bgColor": "string",
      "iconStrokeColor": "string"
    },
    "engagementMessage": {
      "bgColor": "string",
      "textColor": "string"
    },
    "conversationStarters": {
      "bgColor": "string",
      "textColor": "string",
      "containerBgColor": "string",
      "initialMessageBgColor": "string",
      "initialMessageTextColor": "string"
    },
    "scrollToBottomIndicator": {
      "bgColor": "string",
      "iconStrokeColor": "string"
    },
    "uploadFileBtn": {
      "iconStrokeColor": "string"
    },
    "messageBubble": {
      "user": {
        "bgColor": "string",
        "textColor": "string"
      },
      "assistant": {
        "bgColor": "string",
        "textColor": "string"
      }
    }
  }
}

application/json

Schema

Schema

expanded boolean
allowUpload boolean
storeConversation boolean
stream boolean
extractPageContent boolean
userIdentifier stringnullable
logoURL stringnullable
mode stringnullable

engagementMessage

object

enabled boolean

message stringnullable

showAfter int32

locale

object

uploadFileErrorMessage stringnullable

uploadFilesErrorMessage stringnullable

chatErrorMessage stringnullable

chatInitConversationErrorMessage stringnullable

headerTitle stringnullable

finalizedMessage stringnullable

limitExceededMessage stringnullable

waitUntilMessage stringnullable

remainingMessage stringnullable

inputPlaceholder stringnullable

internalLinkMessage stringnullable

newChatBtnMessage stringnullable

exceededMaxNumberOfFilesMessage stringnullable

exceededMaxFileStatusChecksMessage stringnullable

theme

object

header

object

bgColor stringnullable

textColor stringnullable

resetChatBtn

object

bgColor stringnullable

hoverBgColor stringnullable

textColor stringnullable

minimizeBtn

object

iconStrokeColor stringnullable

fabButton

object

bgColor stringnullable

iconStrokeColor stringnullable

buttonSize int32

iconSize int32

sendButton

object

bgColor stringnullable

iconStrokeColor stringnullable

engagementMessage

object

bgColor stringnullable

textColor stringnullable

conversationStarters

object

bgColor stringnullable

textColor stringnullable

containerBgColor stringnullable

initialMessageBgColor stringnullable

initialMessageTextColor stringnullable

scrollToBottomIndicator

object

bgColor stringnullable

iconStrokeColor stringnullable

uploadFileBtn

object

iconStrokeColor stringnullable

messageBubble

object

user

object

bgColor stringnullable

textColor stringnullable

assistant

object

bgColor stringnullable

textColor stringnullable

Example (from schema)

{
  "expanded": true,
  "allowUpload": true,
  "storeConversation": true,
  "stream": true,
  "extractPageContent": true,
  "userIdentifier": "string",
  "logoURL": "string",
  "mode": "string",
  "engagementMessage": {
    "enabled": true,
    "message": "string",
    "showAfter": 0
  },
  "locale": {
    "uploadFileErrorMessage": "string",
    "uploadFilesErrorMessage": "string",
    "chatErrorMessage": "string",
    "chatInitConversationErrorMessage": "string",
    "headerTitle": "string",
    "finalizedMessage": "string",
    "limitExceededMessage": "string",
    "waitUntilMessage": "string",
    "remainingMessage": "string",
    "inputPlaceholder": "string",
    "internalLinkMessage": "string",
    "newChatBtnMessage": "string",
    "exceededMaxNumberOfFilesMessage": "string",
    "exceededMaxFileStatusChecksMessage": "string"
  },
  "theme": {
    "header": {
      "bgColor": "string",
      "textColor": "string",
      "resetChatBtn": {
        "bgColor": "string",
        "hoverBgColor": "string",
        "textColor": "string"
      },
      "minimizeBtn": {
        "iconStrokeColor": "string"
      }
    },
    "fabButton": {
      "bgColor": "string",
      "iconStrokeColor": "string",
      "buttonSize": 0,
      "iconSize": 0
    },
    "sendButton": {
      "bgColor": "string",
      "iconStrokeColor": "string"
    },
    "engagementMessage": {
      "bgColor": "string",
      "textColor": "string"
    },
    "conversationStarters": {
      "bgColor": "string",
      "textColor": "string",
      "containerBgColor": "string",
      "initialMessageBgColor": "string",
      "initialMessageTextColor": "string"
    },
    "scrollToBottomIndicator": {
      "bgColor": "string",
      "iconStrokeColor": "string"
    },
    "uploadFileBtn": {
      "iconStrokeColor": "string"
    },
    "messageBubble": {
      "user": {
        "bgColor": "string",
        "textColor": "string"
      },
      "assistant": {
        "bgColor": "string",
        "textColor": "string"
      }
    }
  }
}

text/json

Schema

Schema

expanded boolean
allowUpload boolean
storeConversation boolean
stream boolean
extractPageContent boolean
userIdentifier stringnullable
logoURL stringnullable
mode stringnullable

engagementMessage

object

enabled boolean

message stringnullable

showAfter int32

locale

object

uploadFileErrorMessage stringnullable

uploadFilesErrorMessage stringnullable

chatErrorMessage stringnullable

chatInitConversationErrorMessage stringnullable

headerTitle stringnullable

finalizedMessage stringnullable

limitExceededMessage stringnullable

waitUntilMessage stringnullable

remainingMessage stringnullable

inputPlaceholder stringnullable

internalLinkMessage stringnullable

newChatBtnMessage stringnullable

exceededMaxNumberOfFilesMessage stringnullable

exceededMaxFileStatusChecksMessage stringnullable

theme

object

header

object

bgColor stringnullable

textColor stringnullable

resetChatBtn

object

bgColor stringnullable

hoverBgColor stringnullable

textColor stringnullable

minimizeBtn

object

iconStrokeColor stringnullable

fabButton

object

bgColor stringnullable

iconStrokeColor stringnullable

buttonSize int32

iconSize int32

sendButton

object

bgColor stringnullable

iconStrokeColor stringnullable

engagementMessage

object

bgColor stringnullable

textColor stringnullable

conversationStarters

object

bgColor stringnullable

textColor stringnullable

containerBgColor stringnullable

initialMessageBgColor stringnullable

initialMessageTextColor stringnullable

scrollToBottomIndicator

object

bgColor stringnullable

iconStrokeColor stringnullable

uploadFileBtn

object

iconStrokeColor stringnullable

messageBubble

object

user

object

bgColor stringnullable

textColor stringnullable

assistant

object

bgColor stringnullable

textColor stringnullable

Example (from schema)

{
  "expanded": true,
  "allowUpload": true,
  "storeConversation": true,
  "stream": true,
  "extractPageContent": true,
  "userIdentifier": "string",
  "logoURL": "string",
  "mode": "string",
  "engagementMessage": {
    "enabled": true,
    "message": "string",
    "showAfter": 0
  },
  "locale": {
    "uploadFileErrorMessage": "string",
    "uploadFilesErrorMessage": "string",
    "chatErrorMessage": "string",
    "chatInitConversationErrorMessage": "string",
    "headerTitle": "string",
    "finalizedMessage": "string",
    "limitExceededMessage": "string",
    "waitUntilMessage": "string",
    "remainingMessage": "string",
    "inputPlaceholder": "string",
    "internalLinkMessage": "string",
    "newChatBtnMessage": "string",
    "exceededMaxNumberOfFilesMessage": "string",
    "exceededMaxFileStatusChecksMessage": "string"
  },
  "theme": {
    "header": {
      "bgColor": "string",
      "textColor": "string",
      "resetChatBtn": {
        "bgColor": "string",
        "hoverBgColor": "string",
        "textColor": "string"
      },
      "minimizeBtn": {
        "iconStrokeColor": "string"
      }
    },
    "fabButton": {
      "bgColor": "string",
      "iconStrokeColor": "string",
      "buttonSize": 0,
      "iconSize": 0
    },
    "sendButton": {
      "bgColor": "string",
      "iconStrokeColor": "string"
    },
    "engagementMessage": {
      "bgColor": "string",
      "textColor": "string"
    },
    "conversationStarters": {
      "bgColor": "string",
      "textColor": "string",
      "containerBgColor": "string",
      "initialMessageBgColor": "string",
      "initialMessageTextColor": "string"
    },
    "scrollToBottomIndicator": {
      "bgColor": "string",
      "iconStrokeColor": "string"
    },
    "uploadFileBtn": {
      "iconStrokeColor": "string"
    },
    "messageBubble": {
      "user": {
        "bgColor": "string",
        "textColor": "string"
      },
      "assistant": {
        "bgColor": "string",
        "textColor": "string"
      }
    }
  }
}

401

The user is unauthorized or the session expired

403

The user does not have permission

404

The entity was not found

500

There was an unexpected error

Loading...