INinsighto
Calling

Make a call

Changed on

To make an outbound call to a given telephone number

post/api/v1/call/{widget_id}

Request

Path parameters

widget_idstring uuid required

Widget ID to be used for initiating the call. It must be connected to Twilio, Plivo or Telnyx.

Request body

tostring required

The phone number to call. Must be in E.164 format. Ex: 16501234567

prompt_dynamic_variablesobject nullable

Dynamic variables to be used in the prompt. Ex: {'name': 'Bob', 'appointment_day': 'tomorrow', 'reason': 'for confirmation of appointment'}

Example request

{
  "prompt_dynamic_variables": {
    "appointment_day": "tomorrow",
    "name": "Bob",
    "reason": "for confirmation of appointment"
  },
  "to": "919810012345"
}

Response

Call successfully initiated

messagestring nullable

Changes

  • 5964b7a445acRevision changes
    • info

      added to the response property anyOf list for the response status

    • info

      removed from the response property anyOf list for the response status