Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Current »

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

HTTP GET /livechat/:domain/getLiterals

Path Variables:

Name

Mandatory

Type

Description

domain

YES

STRING

Unique domain identifier

Query String Parameters:

Name

Mandatory

Type

Description

country

YES

STRING

Country code

level

YES

STRING

Can assume one of the following values:

  • tenant

  • service

serviceId

NO

STRING

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

Response:

Type: JSONP

Name

Type

Description

result

BOOLEAN

If true, the service response was performed correctly

error

NULL / STRING

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

serviceId

STRING

service id associated to the literals retrieved

literals

OBJECT

Object containing the localized labels

Example:

Request

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

Response

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

  • No labels