Sign in

v1

latestOpenAPI 3.0.02026-07-1494623.7 KB
Calls

Create an outbound call

Create an outbound Call

post/

Request body

OR

Example request

{
  "ncco": [
    {
      "action": "talk",
      "text": "Hello World"
    }
  ],
  "event_url": [
    "https://example.com/event"
  ],
  "from": {
    "number": "14155550100",
    "type": "phone"
  },
  "machine_detection": "continue",
  "to": [
    {
      "dtmfAnswer": "p*123#",
      "number": "14155550100",
      "type": "phone"
    }
  ]
}

Response

Created

conversation_uuidstring uuid

The unique identifier for the conversation this call leg is part of.

direction'outbound' | 'inbound'

Possible values are outbound or inbound

statusstring

The status of the call. See possible values

uuidstring uuid

The unique identifier for this call leg. The UUID is created when your call request is accepted by Vonage. You use the UUID in all requests for individual live calls

Example response

{
  "conversation_uuid": "CON-f972836a-550f-45fa-956c-12a2ab5b7d22",
  "direction": "outbound",
  "status": "completed",
  "uuid": "63f61863-4a51-4f6b-86e1-46edebcf9356"
}