Calling Add-ons
curl --request GET \
--url https://app.tuco.ai/api/lines/{id}/calling-addons \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.tuco.ai/api/lines/{id}/calling-addons"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.tuco.ai/api/lines/{id}/calling-addons', 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://app.tuco.ai/api/lines/{id}/calling-addons",
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://app.tuco.ai/api/lines/{id}/calling-addons"
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))
}HttpResponse<String> response = Unirest.get("https://app.tuco.ai/api/lines/{id}/calling-addons")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.tuco.ai/api/lines/{id}/calling-addons")
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_bodyLines & Leads
Calling Add-ons
List and buy per-line calling add-ons — the FaceTime Audio add-on and the Registered caller ID add-on — for a phone line in your workspace.
GET
/
api
/
lines
/
{id}
/
calling-addons
Calling Add-ons
curl --request GET \
--url https://app.tuco.ai/api/lines/{id}/calling-addons \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.tuco.ai/api/lines/{id}/calling-addons"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.tuco.ai/api/lines/{id}/calling-addons', 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://app.tuco.ai/api/lines/{id}/calling-addons",
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://app.tuco.ai/api/lines/{id}/calling-addons"
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))
}HttpResponse<String> response = Unirest.get("https://app.tuco.ai/api/lines/{id}/calling-addons")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.tuco.ai/api/lines/{id}/calling-addons")
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_bodyThe Try it panel runs against production with the key you paste.
POST charges your card, unless it uses an add-on you already paid for at checkout.addon | Price | What it does |
|---|---|---|
facetime_audio | $100/mo per line | Calls go over FaceTime Audio — no carrier spam label. Costs more because it needs different hardware than iMessage. |
caller_id_registration | $50 setup + $50/mo per line + $0.075 per call | A separate, fully-attested calling number registered with carriers (Branded Calling) that shows your business name on US-to-US calls to T-Mobile and Verizon mobiles. Calls come from that number, not your iMessage number. Carrier vetting can take a few business days. Needs your business details before it can go live. |
prepaidFree below.
List — GET /api/lines/{id}/calling-addons
{
"lineId": "6a091e74542d9e3d645925ae",
"recordingDisclosure": {
"enabled": false,
"message": null,
"defaultMessage": "This call may be recorded for quality and training purposes.",
"maxLength": 300
},
"included": ["500 outgoing minutes per line per month, with call recording.", "…"],
"addons": [
{ "key": "facetime_audio", "label": "FaceTime Audio add-on", "beta": false, "price": "$100/mo per line",
"monthlyCents": 10000, "setupCents": 0, "perCallCents": 0, "status": "none", "prepaidFree": 1,
"paymentUrl": null },
{ "key": "caller_id_registration", "label": "Registered caller ID add-on", "beta": false,
"price": "$50 setup + $50/mo + $0.075/call per line", "monthlyCents": 5000, "setupCents": 5000,
"perCallCents": 7.5, "status": "active", "prepaidFree": 0, "paymentUrl": null,
"callingNumber": "+12125550199" }
]
}
status is one of none, awaiting_payment (pay paymentUrl), pending_setup (paid — we’re
setting it up), active, or canceled.
prepaidFree is how many of this add-on the workspace already paid for (at checkout) that no line
uses yet. More than 0 means adding it to this line costs nothing today. It is 0 if billing
can’t be read at that moment.
Each add-on also carries points, the plain-English description shown in the dashboard. The
response also has potentialSpam, the dashboard’s explanation of the “Potential spam” label.
recordingDisclosure is the line’s free call recording notice setting (message: null = the
default text). Turn it on or change the text with
Update a Line. It isn’t an add-on and
costs nothing. It doesn’t play on FaceTime Audio calls.
Add to a line — POST /api/lines/{id}/calling-addons
There are two ways to add an add-on to a line.
Use one you already paid for at checkout. No charge, no consent needed:
curl -X POST "https://app.tuco.ai/api/lines/6a091e74542d9e3d645925ae/calling-addons" \
-H "Authorization: Bearer tuco_xxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{ "addon": "caller_id_registration", "usePrepaidSlot": true }'
curl -X POST "https://app.tuco.ai/api/lines/6a091e74542d9e3d645925ae/calling-addons" \
-H "Authorization: Bearer tuco_xxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{ "addon": "facetime_audio", "acceptCharges": true }'
addon—facetime_audioorcaller_id_registration.usePrepaidSlot—trueto use an add-on already paid for at checkout. Never charges. If none is left (prepaidFreeis0), it returns409with"code": "PREPAID_SLOT_TAKEN"and nothing is charged.acceptCharges— must betrueto buy a new one: you agree to the setup fee plus today’s prorated share of the monthly, then monthly. Non-refundable. Without it, and with no add-on already paid for:422.
prepaidFree is more than 0,
any POST for that add-on uses it and charges nothing, even if you sent acceptCharges: true. If
another order took the last one a moment earlier, a request with acceptCharges: true (and no
usePrepaidSlot) goes on to buy a new one. Any other request gets 409 PREPAID_SLOT_TAKEN and is
not charged.
{
"addon": "caller_id_registration",
"ok": true,
"status": "pending_setup",
"billingMode": "stripe",
"chargedCents": 0,
"usedPrepaidSlot": true
}
chargedCents is what this request charged (0 when a paid-for add-on was used), and
usedPrepaidSlot is true when it used one.
A new purchase charges the card on file immediately. It returns 201 with status: "pending_setup" once paid, or
202 with status: "awaiting_payment" and a paymentUrl only when the card is declined or the bank
requires authentication (3-D Secure) — the customer confirms there, and the add-on starts once paid.
An unpaid paymentUrl lapses after about 23 hours; the add-on then goes back to none and can be
bought again. Registered caller ID calls are billed at $0.075 each, added to your next invoice.
Registered caller ID can’t go live until the workspace’s
caller ID details are submitted.
Errors
Errors return{ "error": "…", "code": "…" }.
| Status | code | When |
|---|---|---|
400 | — | addon isn’t facetime_audio or caller_id_registration |
400 | NOT_A_PHONE_LINE | The line is an email line |
402 | NO_BILLING_ACCOUNT | The workspace has no active billing account |
404 | LINE_NOT_FOUND | No such line in this workspace |
409 | ALREADY_ACTIVE | The line already has this add-on |
409 | PAYMENT_IN_PROGRESS | This add-on, or another add-on payment on the workspace, is still waiting on payment. Pay or let it lapse first |
409 | PREPAID_SLOT_TAKEN | usePrepaidSlot was sent (or the last paid-for add-on was just used) and none is left. Nothing was charged |
422 | — | acceptCharges isn’t true and there’s no add-on already paid for |
500 | — | Your agreement to the charge couldn’t be recorded. Nothing was charged. Try again |
502 | — | Billing failed. The add-on was not added |
Removing an add-on
Add-ons can’t be removed after purchase. Contact support@tuco.ai to change them.
DELETE /api/lines/{id}/calling-addons returns 403 with "code": "ADDON_REMOVAL_SUPPORT_ONLY".Ordering add-ons with a new line
SendcallingAddons and acceptCallingAddonCharges: true on
Create Line Request. Add-ons bought with your plan at
checkout attach to new phone lines automatically, with no second charge, so leave those out of
callingAddons. Calling Add-on Slots shows how many
are left.