About Service Settings

A typical chat agent app in Oracle B2C Service leverages the functionality of the various REST API operations documented in this guide. The chat agent app uses serviceSettings, a REST endpoint in Oracle B2C Service to retrieve endpoint information used to establish an agent session. Let's walk through the operational flow:

1. The chat agent app makes a GET REST request to the Oracle B2C Service serviceSettings endpoint using Basic authentication. Basic authentication requires the username and password defined in the CX configuration for the agent attempting to make the request.
2. ServiceSettings returns the endpoint information required to run the Agent REST API operations.

Here's the URI for the serviceSettings endpoint in Oracle B2C Service:

/services/rest/crossChannelServices/latest/serviceSettings/1

Supported Request Headers

The required request headers for the serviceSettings call are:

• Authorization - This HTTP header is used to specify the Basic authentication credentials for the request.
• Host - This HTTP header is used to specify the host of the site.
• OSvC-CREST-Application-Context - This HTTP header is used to add comments to REST API requests in Oracle B2C Service. The Application Context information can be viewed from the PAPI Meters Debug Log report. This report is available in the Reports Explorer at \Public Reports\Common\Site Administration\Public API. The maximum text length is 40 characters. If you provide more than 40 characters, then a Bad-Request error occurs.

Sample Payloads

Here's an example of the REST response body for the serviceSettings call:

{
    "domain": "10.90.144.220",
    "pool": "123:4",
    "port": 8084,
    "siteName": "sample_site_name",
    "links": [
        {
            "rel": "describedby",
            "href": "http://sample_site_name.com/services/rest/crossChannelServices/v1.4/serviceSettings",
            "mediaType": "application/schema+json"
        }
    ]
}