Romulus icon

Romulus

Consume Romulus API

Actions20

Agent → Start Agent Call

AI-generated

Overview

This node operation initiates a phone call through a selected agent using the Romulus API. It is useful in scenarios where automated or programmatic calls need to be made by specific agents, such as in customer support, telemarketing, or notification systems. For example, a business can use this node to start calls to customers by selecting an agent and specifying the phone number to dial.

Use Case Examples

  1. Start a call from a sales agent to a customer by selecting the agent from a list and providing the customer's phone number.
  2. Trigger an automated call from a support agent to a user with additional user properties like email, name, and timezone for personalized interaction.

Properties

Name Meaning
Agent Name or ID Select the agent to make the call, either from a list or by specifying an ID using an expression.
To Phone Number The phone number to call in E.164 format, which must start with a '+' followed by the country code.
Properties Additional user properties such as email, name, and timezone to provide context or personalization for the call.

Output

JSON

  • callId - Unique identifier of the initiated call.
  • status - Current status of the call (e.g., initiated, ringing, connected).
  • agentId - Identifier of the agent who started the call.
  • to - Phone number that was called.
  • properties
    • email - Email of the user associated with the call, if provided.
    • name - Name of the user associated with the call, if provided.
    • timezone - Timezone of the user associated with the call, if provided.

Dependencies

  • Romulus API access with appropriate authentication credentials

Troubleshooting

  • Ensure the 'Agent Name or ID' is valid and corresponds to an existing agent in the system.
  • Verify the 'To Phone Number' is in correct E.164 format starting with '+', followed by country code and number.
  • Check that the Romulus API credentials are correctly configured and have permissions to initiate calls.
  • If the call fails to start, review API response messages for specific error details such as agent availability or phone number restrictions.

Discussion