Place a call

curl --request POST \
  --url https://api.vocily.ai/v1/calls \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "agent_id": "9b1c3d5e-7a90-4c21-8b6d-2e4f6a8c0d11",
  "to_number": "+919876543210",
  "from_number": "+911171366867",
  "variables": {
    "customer_name": "Rahul"
  },
  "metadata": {
    "order_id": "88431"
  }
}
'

import requests

url = "https://api.vocily.ai/v1/calls"

payload = {
    "agent_id": "9b1c3d5e-7a90-4c21-8b6d-2e4f6a8c0d11",
    "to_number": "+919876543210",
    "from_number": "+911171366867",
    "variables": { "customer_name": "Rahul" },
    "metadata": { "order_id": "88431" }
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    agent_id: '9b1c3d5e-7a90-4c21-8b6d-2e4f6a8c0d11',
    to_number: '+919876543210',
    from_number: '+911171366867',
    variables: {customer_name: 'Rahul'},
    metadata: {order_id: '88431'}
  })
};

fetch('https://api.vocily.ai/v1/calls', 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.vocily.ai/v1/calls",
  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([
    'agent_id' => '9b1c3d5e-7a90-4c21-8b6d-2e4f6a8c0d11',
    'to_number' => '+919876543210',
    'from_number' => '+911171366867',
    'variables' => [
        'customer_name' => 'Rahul'
    ],
    'metadata' => [
        'order_id' => '88431'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$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.vocily.ai/v1/calls"

	payload := strings.NewReader("{\n  \"agent_id\": \"9b1c3d5e-7a90-4c21-8b6d-2e4f6a8c0d11\",\n  \"to_number\": \"+919876543210\",\n  \"from_number\": \"+911171366867\",\n  \"variables\": {\n    \"customer_name\": \"Rahul\"\n  },\n  \"metadata\": {\n    \"order_id\": \"88431\"\n  }\n}")

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	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.vocily.ai/v1/calls")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agent_id\": \"9b1c3d5e-7a90-4c21-8b6d-2e4f6a8c0d11\",\n  \"to_number\": \"+919876543210\",\n  \"from_number\": \"+911171366867\",\n  \"variables\": {\n    \"customer_name\": \"Rahul\"\n  },\n  \"metadata\": {\n    \"order_id\": \"88431\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vocily.ai/v1/calls")

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

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"agent_id\": \"9b1c3d5e-7a90-4c21-8b6d-2e4f6a8c0d11\",\n  \"to_number\": \"+919876543210\",\n  \"from_number\": \"+911171366867\",\n  \"variables\": {\n    \"customer_name\": \"Rahul\"\n  },\n  \"metadata\": {\n    \"order_id\": \"88431\"\n  }\n}"

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

{
  "id": "c7a1e2b3-4d5f-6789-a0b1-c2d3e4f5a6b7",
  "status": "started",
  "metadata": {
    "order_id": "88431"
  }
}

{
  "detail": {
    "code": "idempotency_key_required",
    "message": "`idempotency_key_required` when the Idempotency-Key header is missing; `invalid_to_number` when `to_number` is not a full international number (`+` and the country code, e.g. `+919876543210`)."
  },
  "code": "BAD_REQUEST"
}

{
  "detail": "Invalid API key",
  "code": "UNAUTHORIZED"
}

{
  "detail": {
    "code": "insufficient_balance",
    "message": "Wallet balance is below the reserve required for this call."
  }
}

{
  "detail": {
    "code": "test_number_not_allowed",
    "message": "`from_number` is the shared Vocily Test Number, which is usable only from the dashboard."
  },
  "code": "FORBIDDEN"
}

{
  "detail": {
    "code": "agent_not_found",
    "message": "Agent not found in this workspace."
  },
  "code": "NOT_FOUND"
}

{
  "detail": {
    "code": "concurrency_exceeded",
    "message": "Refused for capacity, with `Retry-After`: `concurrency_exceeded` when every outbound line of the organization is busy; `workspace_concurrency_exceeded` when the organization has lines free but this workspace's allocated ceiling is full (`X-Vocily-Workspace-Concurrency-Limit` carries the ceiling)."
  },
  "code": "CONFLICT"
}

{
  "detail": {
    "code": "validation_error",
    "message": "<string>",
    "errors": [
      {
        "field": "<string>",
        "message": "<string>",
        "type": "<string>"
      }
    ]
  },
  "code": "VALIDATION_ERROR"
}

{
  "code": "rate_limited"
}

{
  "detail": {
    "code": "provider_not_configured",
    "message": "The telephony provider is not configured."
  }
}

{
  "detail": {
    "code": "carrier_capacity_exceeded",
    "message": "Vocily's carrier account is momentarily at its channel cap. Not the organization's limit; retry after `Retry-After`."
  },
  "code": "SERVICE_UNAVAILABLE"
}