Quote the price of a call - TopCalls Voice API

GET

/

v1

/

pricing

/

quote

Quote the price of a call

curl --request GET \
  --url https://api.topcalls.ai/v1/pricing/quote \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.topcalls.ai/v1/pricing/quote', 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.topcalls.ai/v1/pricing/quote",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.topcalls.ai/v1/pricing/quote"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.topcalls.ai/v1/pricing/quote")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "to": "+14155551234",
  "allowed": true,
  "zone": 1,
  "price_per_minute_usd": "0.25",
  "reason": null
}

Authorizations

Authorization

string

header

required

Use Authorization: Bearer tc_live_xxxxx

Query Parameters

to

string

required

The number to call, in E.164. In a URL, write the + as %2B.

Pattern: ^\+[1-9]\d{1,14}$

from

string

The caller ID you would present, one of your own numbers, in E.164. Without it the call is priced from the default number.

Pattern: ^\+[1-9]\d{1,14}$

Response

The quote. A number that can't be called is a 200 with allowed: false and a reason, so you can check before dialing.

What a minute of an AI call to to costs on this account, or why the number can't be called. Nothing is dialed, held or saved.

to

string

required

The number you asked about, in E.164.

Example:

"+14155551234"

allowed

boolean

required

True when a call to this number would be placed. False when it would be refused with 422 destination_not_allowed.

Example:

true

zone

enum<integer> | null

required

The destination's zone, from 1 (cheapest line) to 3. A number in a dearer range than its country is quoted at the zone of the range. Null when allowed is false.

Available options:

1,

2,

3,

null

Example:

1

price_per_minute_usd

string | null

required

What one minute costs in US dollars, as an exact decimal string. The AI part plus the line of the zone, the AI part alone when from is a number on your own carrier, or your negotiated price. Null when allowed is false.

Example:

"0.25"

reason

enum<string> | null

required

Why the number can't be called; the same value POST /v1/calls returns in reason (see DestinationRefusalReason for what each means). Null when allowed is true.

Available options:

invalid_number,

short_code,

number_type,

country_not_enabled,

not_available,

range_above_cap,

null

Quote the price of a call

curl --request GET \
  --url https://api.topcalls.ai/v1/pricing/quote \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.topcalls.ai/v1/pricing/quote', 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.topcalls.ai/v1/pricing/quote",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.topcalls.ai/v1/pricing/quote"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.topcalls.ai/v1/pricing/quote")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "to": "+14155551234",
  "allowed": true,
  "zone": 1,
  "price_per_minute_usd": "0.25",
  "reason": null
}