Voxify

Getting started

Introduction

Call

Lumatic AI Call

Back to documentations

API Documentation: Lumatic.ai Outbound Call

These endpoints are used to programmatically initiate outbound calls to clients on behalf of a Lumatic.ai assistant.

Authentication

Both endpoints require a valid API key in the request headers. You can use either the internal or external key, depending on the nature of your application.

Internal Key: BINARYTINT-INTERNAL-API-KEY
External Key: BINARYTINT-EXTERNAL-API-KEY

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

1. The /outbound-call-uat Endpoint

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-uat
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
  BINARYTINT-EXTERNAL-API-KEY: <BINARYTINT-EXTERNAL-API-KEY> or
  BINARYTINT-INTERNAL-API-KEY : <BINARYTINT-INTERNAL-API-KEY

{
  "client": {
    "phoneNumber": "+12244895125",
    "name": "John Doe",
    "email": "john.doe@example.com"
  },
  "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.

2. The /outbound-call Endpoint

This endpoint is designed for a specific use case where the AI assistant is hardcoded. It initiates an outbound call to a client using a fixed assistantId but allows you to provide dynamic client information.

URL: {base_url}/api/hyperscale/outbound-call
Method: POST
Body: A JSON object that must include the client's phoneNumber, name, and additional info.

Example Request:

Headers:
  Content-Type : application/json
  BINARYTINT-EXTERNAL-API-KEY: <BINARYTINT-EXTERNAL-API-KEY> or
  BINARYTINT-INTERNAL-API-KEY : <BINARYTINT-INTERNAL-API-KEY

{
  "phoneNumber": "+12244895125",
  "name": "Jane Smith",
  "info": "This is a follow-up call regarding their recent inquiry."
}

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.

Introduction

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