Getting started

Introduction

Call

Outbound Call (Dev)

Outbound Call (User)

Aurora

Aurora Function

Embedding Aurora

Via iFrame

Back to documentations

Outbound Call API Developer Documentation:

These endpoints are used to programmatically initiate outbound calls to clients.

The /outbound-call-uat Endpoint

Authentication

A valid API key is required in the request headers. You can use either the internal or external key, depending on the nature of your application.

External Key: x-api-key (KEY GENERATION REQUIRED)

If no valid key is provided, the request will be rejected with a 401 Unauthorized status.

This endpoint initiates an outbound call for a specific AI assistant, whose ID is provided in the request body. This is a general-purpose endpoint often used for testing or on-demand calls where the assistant can change.

URL: {base_url}/api/outbound-call
Method: POST
Body: A JSON object that must include a client object with contact details and the assistantId to make the call.

Example Request:

Headers:
  Content-Type : application/json
  x-api-key : <GENERATED-KEY

{
  "client": {
    "phoneNumber": "+12244895125",
    "name": "John Doe",
    "email": "john.doe@example.com",
    "companyName" : "Doe Tech" (optional)
  },
  "assistantId": "533e2509-9685-4677-973f-5dc2efa642d6"

Responses:

200 OK: A successful response indicating the call was initiated. The data field contains details from the external VoIP handler.
400 Bad Request: Occurs if any required fields in the request body are missing.

Assistant Prompt

The assistant's prompt can include these variables:

{{customer_name}}
{{customer_info}}
{{company_name}}
{{company_details}}

These are necessary for supabase comany_name and company_details if the user wants to include them:

Supabase project URL
service_role key
Database table names relevant to company_details

Example Request:

Prompt

You can book meetings using the users name: {{customer_name}} and user’s email: {{customer_info}}.
You can give details about the company: {{company_name}}, {{company_details}}

They can also be added in the assistantFirstMessage:

Hey {{customer_name}}. your Aurora is ready to be tested! Do you have a minute to get a meeting booked to test it out

Introduction

Outbound Call (User)

Smarter Conversations Start Here

With VoxSuite, you can deliver better customer service while saving time and money. Let Aurora do the heavy lifting, so you can focus on what matters most.

Book an Aurora Demo