Make a call - Insighto.ai Docs

Make a call

curl --request POST \
  --url 'https://api.example.com/api/v1/call/{widget_id}?api_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt_dynamic_variables": {
    "appointment_day": "tomorrow",
    "name": "Bob",
    "reason": "for confirmation of appointment"
  },
  "to": "919810012345"
}
'

import requests

url = "https://api.example.com/api/v1/call/{widget_id}?api_key="

payload = {
    "prompt_dynamic_variables": {
        "appointment_day": "tomorrow",
        "name": "Bob",
        "reason": "for confirmation of appointment"
    },
    "to": "919810012345"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    prompt_dynamic_variables: {
      appointment_day: 'tomorrow',
      name: 'Bob',
      reason: 'for confirmation of appointment'
    },
    to: '919810012345'
  })
};

fetch('https://api.example.com/api/v1/call/{widget_id}?api_key=', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/call/{widget_id}?api_key=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'prompt_dynamic_variables' => [
        'appointment_day' => 'tomorrow',
        'name' => 'Bob',
        'reason' => 'for confirmation of appointment'
    ],
    'to' => '919810012345'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/call/{widget_id}?api_key="

	payload := strings.NewReader("{\n  \"prompt_dynamic_variables\": {\n    \"appointment_day\": \"tomorrow\",\n    \"name\": \"Bob\",\n    \"reason\": \"for confirmation of appointment\"\n  },\n  \"to\": \"919810012345\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/call/{widget_id}?api_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"prompt_dynamic_variables\": {\n    \"appointment_day\": \"tomorrow\",\n    \"name\": \"Bob\",\n    \"reason\": \"for confirmation of appointment\"\n  },\n  \"to\": \"919810012345\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/call/{widget_id}?api_key=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"prompt_dynamic_variables\": {\n    \"appointment_day\": \"tomorrow\",\n    \"name\": \"Bob\",\n    \"reason\": \"for confirmation of appointment\"\n  },\n  \"to\": \"919810012345\"\n}"

response = http.request(request)
puts response.read_body

{
  "message": "Data created successfully",
  "meta": {},
  "data": {
    "conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "widget_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "direction": "<string>",
    "from_number": "<string>",
    "to_number": "<string>",
    "telephony_provider": {
      "provider_name": "twilio",
      "call_id": "<string>",
      "response_body": {}
    },
    "prompt_dynamic_variables": {}
  }
}

{
  "detail": "Couldn't authenticate your Twilio account"
}

{
  "detail": "Invalid authentication credentials"
}

{
  "detail": "Invalid Widget ID"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": "Too Many Requests"
}

POST

api

call

{widget_id}

Make a call

curl --request POST \
  --url 'https://api.example.com/api/v1/call/{widget_id}?api_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt_dynamic_variables": {
    "appointment_day": "tomorrow",
    "name": "Bob",
    "reason": "for confirmation of appointment"
  },
  "to": "919810012345"
}
'

import requests

url = "https://api.example.com/api/v1/call/{widget_id}?api_key="

payload = {
    "prompt_dynamic_variables": {
        "appointment_day": "tomorrow",
        "name": "Bob",
        "reason": "for confirmation of appointment"
    },
    "to": "919810012345"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    prompt_dynamic_variables: {
      appointment_day: 'tomorrow',
      name: 'Bob',
      reason: 'for confirmation of appointment'
    },
    to: '919810012345'
  })
};

fetch('https://api.example.com/api/v1/call/{widget_id}?api_key=', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/call/{widget_id}?api_key=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'prompt_dynamic_variables' => [
        'appointment_day' => 'tomorrow',
        'name' => 'Bob',
        'reason' => 'for confirmation of appointment'
    ],
    'to' => '919810012345'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/call/{widget_id}?api_key="

	payload := strings.NewReader("{\n  \"prompt_dynamic_variables\": {\n    \"appointment_day\": \"tomorrow\",\n    \"name\": \"Bob\",\n    \"reason\": \"for confirmation of appointment\"\n  },\n  \"to\": \"919810012345\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/call/{widget_id}?api_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"prompt_dynamic_variables\": {\n    \"appointment_day\": \"tomorrow\",\n    \"name\": \"Bob\",\n    \"reason\": \"for confirmation of appointment\"\n  },\n  \"to\": \"919810012345\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/call/{widget_id}?api_key=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"prompt_dynamic_variables\": {\n    \"appointment_day\": \"tomorrow\",\n    \"name\": \"Bob\",\n    \"reason\": \"for confirmation of appointment\"\n  },\n  \"to\": \"919810012345\"\n}"

response = http.request(request)
puts response.read_body

{
  "message": "Data created successfully",
  "meta": {},
  "data": {
    "conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "widget_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "direction": "<string>",
    "from_number": "<string>",
    "to_number": "<string>",
    "telephony_provider": {
      "provider_name": "twilio",
      "call_id": "<string>",
      "response_body": {}
    },
    "prompt_dynamic_variables": {}
  }
}

{
  "detail": "Couldn't authenticate your Twilio account"
}

{
  "detail": "Invalid authentication credentials"
}

{
  "detail": "Invalid Widget ID"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": "Too Many Requests"
}

Authorizations

api_key

string

query

required

Your API key for authentication. You can generate it from the Settings page. Format: starts with in-.

Path Parameters

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

Body

application/json

Payload containing the phone number and other details.

string

required

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

prompt_dynamic_variables

Prompt Dynamic Variables · object | null

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

Response

Call successfully initiated

message

string | null

default:Data created successfully