Make a Call Using an Agent
Initiates an outbound AI-based phone call using a specific agent.
Authorizations
Your API key, e.g. caldLiveDe39a3accb206dd615f30d118e519df0
Path Parameters
The agent ID of the agent
Body
The phone number of the individual or business you're calling. - For international numbers, include the country code without extra formatting (such as parentheses or dashes), for example, '+441234567890'. - For U.S. numbers, although formatting is allowed, it's advisable to remove any additional characters for consistency.
The prospectName is the default variable that is always present for all agents. It can be used in your agent scripts on the MyCald Dashboard by typing {prospectName}.
The email address of the contact, this is optional
Feel free to add more custom variables to the list, depending on the use case. Once configured in the agent page of the MyCald Dashboard, they will automatically become available in the API
Response
Whether the call was successfully initiated, can be either success or failed
Unique identifier for the call (only returned if the call was successfully initiated)