1. Engagement Cloud Chat REST APIREST API for Chat in Oracle Fusion Service
  2. Reference
  3. URL Path

URL Path

A URL (Uniform Resource Locator) path identifies the REST API endpoint that you want to call. A complete URL path consists of the domain name and the endpoint path:

https://<domain>/<endpoint-path>

The <domain> is the REST server domain, for example: 

https://chat_rest_server_domain.com

The <endpoint-path> is the relative path of the resource endpoint you're working with. For example, for requestEngagement endpoint, the endpoint path is as follows: 

/engagement/api/consumer/sdi_11_20_18_2022_21-3586727808788512-Fusion/v1/requestEngagement
Where:
  • sdi_11_20_18_2022_21-3586727808788512-Fusion is the value of the fqSiteName. The fqSiteName is the name of the site returned in the response of the initial call to chatAuthenticate endpoint in Engagement Cloud
  • v1 is the valid value for the API version

So, the combined request URL for the requestEngagement endpoint becomes: 

https://chat_rest_server_domain.com/engagement/api/consumer/sdi_11_20_18_2022_21-3586727808788512-Fusion/v1/requestEngagement

If a pool ID is configured for the site then you need to specify it in the request URL, as follows: 

https://chat_rest_server_domain.com/engagement/api/consumer/sdi_11_20_18_2022_21-3586727808788512-Fusion/v1/requestEngagement?pool=353:2

Where the pool ID is 353:2. The pool ID indicates the ID of the cluster where the chat service is running.