Place an outbound AI phone call. By default, the request returns immediately with an interactionId while the call continues in the background. Set waitForCallEnd to true to keep the request open until the call ends and return the call summary.
Documentation Index
Fetch the complete documentation index at: https://docs.pokulabs.com/llms.txt
Use this file to discover all available pages before exploring further.
Authentication header containing your Poku API key. Find it in the Poku dashboard. The format is "Bearer YOUR_API_KEY"
The prompt defines the AI's personality, conversation topic, and objective.
Example:
You are a friendly voice assistant calling on behalf of Joe to make a dinner reservation.
Make a dinner reservation for a party of 2 people on [day] at [time], under the name Joe Smith.
- If that time is available, confirm the reservation and ask if a note is needed for a special occasion.
- If [time] is unavailable, ask what times are open and accept an alternative within one hour of the original if reasonable. Confirm the new time back clearly before ending the call.
- If no one answers, leave this voicemail: "Hi, this is a message on behalf of Joe — I'm hoping to make a dinner reservation for 2 on [day] at [time]. Please call back to confirm. Thank you."The number you want to call, in E.164 format.
Defaults to your Poku reserved number. If you don't have one, falls back to a Poku shared number.
You can also bring your own number from Twilio or Messagebird. Configure your credentials on the Integrations page and pass the number here in E.164 format.
The number the agent will transfer the call to if the other party asks to speak with a human. Must be in E.164 format.
Specifies the language. For example, fr-FR for French. Defaults to en-US if unset.
Available options: en-US, de-DE, es-ES, hi-IN, fr-FR, ja-JP, pt-PT, zh-CN, ru-RU, it-IT, ko-KR, nl-NL, pl-PL, tr-TR, vi-VN, ro-RO, bg-BG, ca-ES, th-TH, da-DK, fi-FI, el-GR, hu-HU, id-ID, no-NO, sk-SK, sv-SE, lt-LT, lv-LV, cs-CZ, ms-MY, af-ZA, ar-SA, az-AZ, bs-BA, cy-GB, fa-IR, fil-PH, gl-ES, he-IL, hr-HR, hy-AM, is-IS, kk-KZ, kn-IN, mk-MK, mr-IN, ne-NP, sl-SI, sr-RS, sw-KE, ta-IN, ur-IN, yue-CN, uk-UA
"en-US"
Selects the voice used for the call. Defaults to female if unset.
male, female When false or omitted, the request returns immediately with an interactionId while the call continues in the background. Use Get Interaction Status to check whether the call has ended.
When true, the HTTP request stays open until the call ends, then returns the call summary and recording URL when available.
true
Call started or completed successfully.