Skip to main content

Prerequisites

Before you begin, make sure you have:
  • An active Revenueable AI account
  • Your API key (X-API-KEY)
  • An assistant configured for outbound calls
  • A phone number assigned to your workspace

Execution

Step 1: Choose an Assistant First, retrieve a list of your assistants to find the appropriate assistant ID:
Step 2: Get Available Phone Numbers Next, retrieve the list of phone numbers in your workspace:
Step 3: Initiate the Call Now, make the call using the assistant ID and phone number ID you obtained:
Step 4: Check Call Status After initiating the call, you’ll receive a response with the call details:
The Call Status field shows the current status of your call. Here are the possible statuses:
  • registered - Call has been queued and is waiting to be processed
  • ongoing - Call is currently in progress
  • retry - System has to retry at the next_attempt_time
  • completed - User has picked the call and discussion happened
  • failed - All the retries have been exhausted
  • error - One of the terminal state. Any unknown error
  • cancelled - Call was cancelled
Step 5: Retrieve Call History You can check the call history to see the status and details of your call: