Logo

Outrival

Authentication Type: API Key

Description: Initiate outbound AI phone calls with configurable assistants, custom metadata, and user variables.

Beta Tool: Please contact support to get this Beta tool added to your account.


Authentication

To authenticate, you'll need an Outrival API key from Outrival.

Use the X-API-Key header for authentication.


Phone Calls

Initiate Phone Call

Initiate an outbound phone call using an AI assistant.

Operation Type: Mutation (Write)

Parameters:

  • assistantId string (required): Identifier for the AI assistant to use for the call
  • phoneNumber string (required): Target phone number for the call
  • metadata object (required): Additional metadata object for the call
  • userName string (optional): Name of the user initiating the call
  • userId string (optional): Unique user identifier
  • variables object (optional): Custom variables for the call
  • externalId string (optional): External reference identifier
  • anonymousId string (optional): Anonymous user identifier

Returns:

  • id string: Unique call identifier

Example Usage:

{
  "assistantId": "asst_abc123",
  "phoneNumber": "+14155551234",
  "metadata": {
    "campaign": "outreach-q1",
    "source": "crm"
  },
  "userName": "John Doe",
  "variables": {
    "companyName": "Acme Corp",
    "meetingTime": "3pm Tuesday"
  }
}

Common Use Cases

Sales Outreach:

  • Automate initial outreach calls with AI-powered conversations
  • Scale personalized calls with custom variables for each prospect
  • Track call outcomes with metadata and external IDs

Customer Success:

  • Proactive check-in calls with existing customers
  • Automated appointment reminders and confirmations
  • Follow-up calls after support tickets

Lead Qualification:

  • Initial qualification calls to inbound leads
  • Gather information before routing to sales team
  • Schedule follow-up meetings with qualified prospects