Outbound call

Places a real, billable phone call and waits until the destination answers or dialing fails. A successful response means the call was answered.

Authorization

ApiKeyAuth

x-api-key<token>

Create an organization API key in the Neuroline dashboard.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Starts a real outbound phone call. A successful request may incur telephony and AI usage charges.

from*string

An active Neuroline phone number owned by the API key's organization, in E.164 format.

Match^\+[1-9]\d{1,14}$

to*string

The destination phone number in E.164 format.

Match^\+[1-9]\d{1,14}$

language*string

The language used by the outbound assistant. It must be configured on the selected assistant.

Value in

"en"
"nl"

opening?string

Optional spoken opening that overrides the assistant's configured default.

Length1 <= length <= 2000

context?

Freeform JSON made available to the outbound assistant. The encoded object may be at most 16 KiB.

Default{}

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/outbound" \  -H "Content-Type: application/json" \  -d '{    "from": "+31201234567",    "to": "+31612345678",    "language": "en"  }'

{  "ok": true,  "status": "answered",  "call_sid": "SIP_abc123"}

Outbound call

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

408application/json

409application/json

413application/json

415application/json

422application/json

502application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`