HollrAI APICalls

Start a single call

View as Markdown

Start one outbound call using the agent configured for the campaign. The campaign and its agent are configured in the HollrAI platform first; use this endpoint when your application needs to trigger a call programmatically.

Authentication

hollr-api-keystring

API key issued for your account. Every request is logged and rate-limited against this key.

Request

This endpoint expects an object.
campaign_idstringRequiredformat: "uuid"
UUID of the campaign to place the call under. Campaigns are created in the HollrAI platform.
tostringRequired
Destination phone number to call.
metadatamap from strings to anyOptional
Arbitrary metadata forwarded to the call server.

Response

Call successfully forwarded to the call server.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error