1. Service Cloud Chat REST APIREST API for Chat in B2C Service
  2. Reference
  3. URL Path

URL Path

You use a URL (Uniform Resource Locator) path to identify 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

Based on your usage, click on one of the following links:

URL Path for Agent API

The <endpoint-path> is the relative path of the REST endpoint. Here's an example of the endpoint path for createAutomatedAgentSession endpoint: 

/engagement/api/agent/day119_181100_sql_238h/v1/createAutomatedAgentSession
Where:
  • day119_181100_sql_238h is the value of the fqSiteName. The fqSiteName is the name of the site returned in the response of the initial call to agentTokens endpoint in B2C Service
  • v1 is the valid value for the API version

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

https://chat_rest_server_domain.com/engagement/api/agent/day119_181100_sql_238h/v1/createAutomatedAgentSession?pool=297:1

Where the pool ID is 297:1. The pool ID indicates the ID of the cluster where the chat service is running.

URL Path for Consumer API

The <endpoint-path> is the relative path of the REST endpoint. Here's an example of the endpoint path for requestEngagement endpoint: 

/engagement/api/consumer/day119_181100_sql_238h/v1/requestEngagement
Where:
  • day119_181100_sql_238h is the value of the fqSiteName. The fqSiteName is the name of the site returned in the response of the initial call to establishSessions endpoint in B2C Service
  • 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/day119_181100_sql_238h/v1/requestEngagement?pool=297:1

Where the pool ID is 297:1. The pool ID indicates the ID of the cluster where the chat service is running.