Web Callback

In order to trigger outgoing calls and connect them to an existing call bot scenario, it is possible to make an HTTP request on our Call API.

Authentication

Request an access_token by sending a POST request on https://id.uh.live/realms/uhlive/protocol/openid-connect/token with the following payload:

{
  "client_id": "{the client_id that was provided to you}",
  "client_secret": "{the client_secret that was provided to you}",
  "grant_type": "client_credentials"
}

You'll receive a response with an access_token, valid for 5 minutes.

You can copy this cURL command, and replace your client_id and client_secret to get your access token:

curl -L -X POST 'https://id.uh.live/realms/uhlive/protocol/openid-connect/token' -H 'Content-Type: application/x-www-form-urlencoded' --data-urlencode 'client_id=CLIENT_ID' --data-urlencode 'grant_type=client_credentials' --data-urlencode 'client_secret=CLIENT_SECRET' --data-urlencode 'scope=openid'

Request callback

With a valid access token request the Call API on https://call.uh.live/api/startcall with the following payload:

{
  "originate": "{the scenario codename that was provided to you}",
  "destination": "{the customer phone number to call}",
  "email": "{the customer e-mail address}"
}

You'll receive a success status in return, and the destination phone number will ring within seconds.

• originate: the name of the call bot scenario to run. Check with your account manager.
• destination: to the E164 format, for example a French phone number would be +33123456789. French special numbers (08xx, 36xx, etc...) and international numbers are not allowed.
• email: is passed back to your bot. It is used to identify the caller in the bot scenario. This value is transparent and not checked. It is provided by the call initiator and passed as is to the NLP engine.

You can copy this cURL command, and replace your access_token to trigger the call:

curl -L -X POST 'https://call.uh.live/api/startcall' -H 'accept: application/json' -H 'Content-Type: application/json' -H 'Authorization: Bearer {access_token}' -d '{"originate": "string", "destination": "string", "email": "string"}'