API Reference

Getting started

❗️

Note

Intended Audience:

This version of Webex Engage's REST APIs are strictly restricted to the following audience:

  • Webex Engage standalone customers
  • Internal teams within Cisco to develop cross-product integrations

Note: Partners/customer of other SKUs (i.e., WxCC, CCE, etc.) are requested NOT to use leverage Webex CC's REST APIs to develop integrations

Authentication

Webex Engage's REST API endpoints leverage OAuth 2.0 protocol - client_credentials grant type to authenticate requests. To fetch an access_token you will need to have the following credentials handy.

Pre-requisites:

  • tenant_id - To be used as the client_id
  • tenant_secret - To be used as the client secret

Request

To fetch an access_token initiate an HTTP request to the token endpoint mentioned below. The base URLs are specific to the deployment region that your tenant is hosted in. Kindly construct your request accordingly.

RegionBase URL
AWS US, Oregonhttps://api-us-site-1.imiengage.io/api/v1
Azure UShttps://api-us-site-2.imichat.us/api/v1
AWS UK, Londonhttps://api-uk-site-1.imiengage.io/api/v1
AWS EU, Irelandhttps://api-eu-site-1.imiengage.io/api/v1
AWS CA, Torontohttps://api-ca-site-1.imiengage.io/api/v1
AWS ANZ, Sydneyhttps://api-syd-site-1.imiengage.com.au/api/v1
AWS APAC, Mumbaihttps://api-ind-site-1.imiengage.io/api/v1
UK Private DChttps://api-tc.imi.chat/api/v1
curl --location 'https://<deployment-specific-url>/oauth/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Cookie: AWSALB=Y6ubr0YMCbbr4jDtMLD5Xe8XXNU9Dlzr/UtM3vFgZhKOG9mHwDb7f1VCIk0C5Z7LrM420ne0eDL5yuL1CNyuNOvpy9k6jHGTiqiIqeyTx8R7CSS40R08+W5mtZq4; AWSALBCORS=Y6ubr0YMCbbr4jDtMLD5Xe8XXNU9Dlzr/UtM3vFgZhKOG9mHwDb7f1VCIk0C5Z7LrM420ne0eDL5yuL1CNyuNOvpy9k6jHGTiqiIqeyTx8R7CSS40R08+W5mtZq4' \
--data-urlencode 'client_id=<TENANT_ID>' \
--data-urlencode 'client_secret=<TENANT_SECRET>' \
--data-urlencode 'grant_type=client_credentials'

Response

{
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJncm91cElkIjoiMiIsImRvbWFpbm5hbWUiOiJzaG93LXVzLmltaS5jaGF0IiwibmJmIjoxNjgwNjc5NjY0LCJleHAiOjE2ODA2ODMyNjQsImlhdCI6MTY4MDY3OTY2NH0.xVvEF-yYYWNA_7jFjLdPeLvNEGA4gf4MM9Hc3MQ121A",
    "expires_in": 3600,
    "token_type": "Bearer",
    "scope": [
        "conversations:read",
        "conversations:write",
        "conversations-messages:read",
        "conversations-messages:write",
        "conversations-participants:write",
        "users:read",
        "users:write"
    ]
}