How to trigger Outbound Call API in AI Studio How to trigger Outbound Call API in AI Studio

How to trigger Outbound Call API in AI Studio

Paul Bird

Objective

Utilize your telephony virtual assistant to trigger an outgoing call to any PSTN number.

Applies To

  • Vonage AI Studio

Content

  1. How to prepare your Outbound Call Query

Procedure

For the launch of the outbound call to work, make sure you have published your agent 
and that it has a phone number attached to it.
Are you using postman?

When using curly braces in the query parameters, make sure you encode the content of
your curly braces. If sent without the encoding, your request will return empty.

Are you within the limits?

Studio’s outbound call limits that is! We currently only allow one call/session per second however if your virtual agent needs to make more calls we can increase the limit up to 5 outbound calls per second.

If you require an increased limit, please email support@aistudio.vonage.com or submit a request using this form with the following details:-

  • API key
  • Agent ID(/s)
  • Increase request: You can choose to increase your limit to 3 or 5 calls per second
  • Once you receive confirmation from our teams that your request has been processed, please publish your agents and wait for about 5 minutes before you start triggering any new outbound calls.

Please note that if your agent is not approved for a higher limit, any call made over the 1 call per second limit will fail and return a 429 error!

How to prepare your Outbound Call Query

Endpoint (mandatory)

For Agents deployed in EU region -->
https://studio-api-eu.ai.vonage.com/telephony/make-call

For Agents deployed in US region -->
https://studio-api-us.ai.vonage.com/telephony/make-call

Method (mandatory)

POST

Headers (mandatory)

X-Vgai-Key (Don't forget to add the value of the Vgai key after you generated it)

You can find the X-Vgai-Key on the top right of your canvas. Click on the "user" icon, 
and then "Generate API Key".