POST
/
call
This API endpoint is deprecated and will be removed in the future. Please use the Agents Call endpoint instead.

Authorizations

Authorization
string
headerrequired

Your API key, e.g. caldLiveDe39a3accb206dd615f30d118e519df0

Body

application/json
phone_number
string
required

Specify 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.

from_phone_number
string

An optional field that allows you to specify the phone number from which the call will be made. If this field is left blank, the call will be made from a randomly selected phone number that we own. In order to be able to make a call from a phone number you own, you must have previously purchased it on your MyCald dashboard or through our support team. Please include it in the same format as displayed in our MyCald dashboard, for example, +441234567890.

voice
string
default: Dave

Specify the voice you'd like to use for the call. The default is Dave. The following voices are available:

  • Dave: American English Male
  • Sarah: American English Female
  • Jack: Australian Male
  • Charlotte: Australian Female
  • Josh: British Male
  • Florence: British Female
  • Pierre: French Male
  • Juliette: French Female
  • Alice: French Canadian Female
  • Karl: German Male
  • Lena: German Female
  • Luiza: Brazilian Female
  • Carlos: Castilian Spanish Male
  • Lola: Castilian Spanish Female
  • Lucia: Latin American Spanish Female
  • Ana: North American Spanish Female
  • Anouk: Dutch Female
  • Sakura: Japanese Female
  • Seoyeon: Korean Female
task
string
required

Outline the desired behavior for the AI. Offer context and specific instructions regarding the interaction. Reminder: Regularly refine and test your prompts for optimal AI performance.

greeting
string

This field is optional and allows you to specify the first words or sentence the AI will say during the call. This initial utterance sets the tone for the conversation and can be tailored to suit the context of the call. For example, a friendly greeting like "Hello, this is the AI assistant calling" or a more formal one like "Good day, I am your automated calling service" can be used depending on the desired interaction style.

enable_ivr_check
boolean
default: true

This field is optional and allows you to enable or disable the IVR check. If enabled, the AI will attempt to detect whether a human or an answering machine has answered the call. If a human answers, the AI will begin the conversation. If an answering machine answers, the AI will hang up. The default is true. In some cases, there are false positives, so if you're experiencing issues with the AI hanging up on humans, you can disable this feature by setting this field to false.

webhook
string

The webhook needs to be an HTTP or HTTPS callback URL. Upon completion of the call, we'll transmit the callId and the transcript to this URL. This feature is beneficial for receiving real-time notifications at the conclusion of calls.

Response

200 - application/json
status
string

Whether the call was successfully initiated, can be either success or failed

callId
string

Unique identifier for the call (only returned if the call was successfully initiated)

Cancel a Campaign