Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Returns the domain/service level literals for the country code specified.

Status
colourGreen
titleHTTP GET
/livechat/:domain/getLiterals

Path Variables:

Name

Mandatory

Type

Description

domain

Status
colourRed
titleyes

Status
titlestring

Unique domain identifier

Query String Parameters:

Name

Mandatory

Type

Description

country

Status
colourRed
titleYES

Status
titleSTRING

Country code

level

Status
colourRed
titleyes

Status
titlestring

Can assume one of the following values:

  • tenant

  • service

serviceId

Status
titleno

Status
titlestring

If level is set to “service“, specifies the service literals to retrieve

...

Name

Type

Description

result

Status
titleboolean

If true, the service response was performed correctly

error

Status
titlenull
/
Status
titlestring

Contains the error description if an error has occurred in the request

serviceId

Status
titlestring

service id associated to the literals retrieved

literals

Status
titleobject

Object containing the localized labels

Example:

Request

http://<hostname>:<port>/livechat/default/getLiterals?country=it&level=service&serviceId=LiveChat_Sidebar

Response

Code Block
languagejson
{
    "result": true,
    "serviceId": "LiveChat_Sidebar",
    "error": null,
    "literals": {
        "Country": "IT",
        "Separator": ",",
        "AppName": "CTLive",
        "engagement_sidebar_title": "Sidebar",
        "datacollection_cbl_first_slot_label": "Richiamami subito"
    }
}

...