Establishing a Connection

The REST API is accessed over HTTPS using JSON. To connect, send an HTTP request to the endpoint https://gateway-host/api/v1/aia/sg/call-summary/summaries with the required headers and JSON payload, where gateway-host is replaced with your applicable host information. Refer to the available REST endpoints documentation for supported methods and other endpoint requirements.

Authentication

Access to the AIA Call Summarization API requires a valid bearer token. To obtain this token, you use your Client ID, Client Secret, Token URL, and Scope. The following values are made available for download through a Pre-Authenticated Request link that is sent as part of initiating the use of the AIA services:
  • Client ID
  • Client Secret
  • Scope
  • Token URL
  • Client Identifier for auth-token

With this authentication information, you can generate a bearer token using the OAuth 2.0 Client Credentials flow. Use the Token URL, Client ID, Client Secret, and Scope provided to you within a curl command as shown below.

curl -i -H "Authorization: Basic base_64(<client_id>:<client_secret>)" -H "Content-Type: application/x-www-form-urlencoded; charset=utf-8" --request POST "<token-url>" -d "grant_type=client_credentials&scope=<scope>

This command provides a response with the following syntax.

{"access_token":"xxxxx","token_type":"Bearer","expires_in":3600}
Use the value in the access_token field as your bearer token. Include the following headers with every request:
  • auth-token: client-identifier
  • Authorization: Bearer your-auth-token
  • Accept: application/json
  • Content-Type: application/json