Context Service Registration API

Cisco Context Service is a cloud-based omnichannel solution for Cisco Contact Center Enterprise Solutions. It enables you to capture your customer’s interaction history by providing flexible storage of customer-interaction data across any channel.

Various components in the CCE Solution provide out of the box integration with Context Service. Context Service also provides an API for integration with your own applications or third-party applications to capture end-to-end customer-interaction data.

For more information about Context Service and to check service availability, see http:/​/​cisco.com/​go/​contextservice.

Use the Context Service Registration API to register SocialMiner with Context Service and get the current registration status.

URL

https://<server>/unifiedconfig/config/contextserviceregistration

Operations

Parameters

Sample API Workflow

  1. The user navigates to a custom Context Service web page.
  2. The page calls the Get API to get the current registration status from Context Service. The page displays either a Register or Deregister button.
  3. The user clicks Register or Deregister.
  4. The page calls the Get API with a callback URL for a custom web page. This page can be the custom Context Service web page from step 1. The API returns either the Context Service registration or deregistration URL.
  5. The browser redirects to the Context Service registration or deregistration URL.
  6. The user completes the registration or deregistration wizard.
  7. The browser redirects back to the callback URL with a connectionData query parameter appended to it.
  8. The callback page calls the Update API with the connection data from step 7 to send the data to SocialMiner and the CCE database.
  9. Go to step 2.

Example Get Response

 <contextServiceRegistration>
   <state>registered</state>
   <managementUrl>(url)</managementUrl> <!-- Included if state is registered -->
   <registrationUrl>(url)</registrationUrl> <!-- Included if state is notRegistered 
    and callbackUrl is provided -->
   <deregistrationUrl>(url)</deregistrationUrl> <!-- Included if state is registered 
    and callbackUrl is provided -->
   <refURL>/unifiedconfig/config/contextservice</refURL>
</contextServiceRegistration>

Example Update Request

 <contextServiceRegistration>
   <connectionData>(data)</connectionData>
</contextServiceRegistration>