Outbound Call API

The over.ai API conforms to REST protocol. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors.

Authentication

Authenticate your account when using the API by including your secret API key in the request. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Find your over.ai API Key from the top right menu while viewing any of your agents

post
Request Parameters

https://api.over.ai/api/outbound/makecall
The over.ai API provides access to over.ai's natural language understanding (NLU) abilities and telephony actions.
Request
Response
Headers
api-key
required
string
API key obtained from developer platform
Content-Type
required
string
application/json
Body Parameters
callStatusCallbackUrl
optional
string
URL where the call status will be submitted to
botPhoneNumber
required
number
E164 phone number of your agent Sign in to the over.ai console to retrieve the agent phone number
destPhonenumber
required
number
E164 phone number to call
parameters
optional
array
{ "name": string, "type": string, "value": string }
sessionId
optional
string
Force specific session id for the call
disconnectAfterXSecond
optional
integer
Max. number of seconds before disconnecting call if no answer or call is stale
200: OK
{
  "status": "okay",
  "statusCode": 200,
  "provider": 0,
  "requestId": "06f97b1a-6c82-48a5-be10-b82b15b9567b"
}

Sample API Call

curl -X POST \
https://api.over.ai/api/outbound/makecall \
-H 'content-type: application/json' \
-d '{
"destPhonenumber": "972544395914",
"botPhoneNumber": "18186550035",
"callStatusCallbackUrl": "https://somedomain.com/callback",
"disconnectAfterXSecond": 3600,
"parameters": [
{
"name": "@COMPANY_NAME",
"type": "@sys.any",
"value": "demo company name"
}
]
}'