Triggering an outbound SMS Virtual Agent

You can jumpstart the outbound session from any platform of your choosing, e.g. Postman.

Are you within the limits?

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

If you require an increased limit, please email [e-mail] with the following details:-

• API key

• Agent ID(/s)

• Increase request: You can choose to increase your limit to 3 or 5 sessions 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 sessions.

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!

The query will look like the following -

Endpoint (mandatory)

The endpoint depends on the region you selected for your agent

For EU agents --> https://studio-api-eu.ai.vonage.com/messaging/conversation

For US agents --> https://studio-api-us.ai.vonage.com/messaging/conversation

Method (mandatory)

POST

Headers (mandatory)

X-Vgai-Key

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

Request Body

{ 
    "to": "TO_NUMBER", 
    "agent_id": "AGENT_ID", 
    "channel": "sms",
    "status_url": "string",
    "session_parameters": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}

If you want to create an outbound campaign sending a multitude of messages to different recipients at the same time, please contact our support team for help.