curl --request POST \
--url https://api.pyai.com/v1/telephony/compliance/consents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"destination": "+14155550123",
"purposes": [],
"timezone": "America/Los_Angeles",
"evidence_ref": "<string>",
"captured_at": 123,
"status": "active",
"call_idempotency_key": "<string>",
"expires_at": 123
}
'import requests
url = "https://api.pyai.com/v1/telephony/compliance/consents"
payload = {
"destination": "+14155550123",
"purposes": [],
"timezone": "America/Los_Angeles",
"evidence_ref": "<string>",
"captured_at": 123,
"status": "active",
"call_idempotency_key": "<string>",
"expires_at": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
destination: '+14155550123',
purposes: [],
timezone: 'America/Los_Angeles',
evidence_ref: '<string>',
captured_at: 123,
status: 'active',
call_idempotency_key: '<string>',
expires_at: 123
})
};
fetch('https://api.pyai.com/v1/telephony/compliance/consents', 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.pyai.com/v1/telephony/compliance/consents",
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([
'destination' => '+14155550123',
'purposes' => [
],
'timezone' => 'America/Los_Angeles',
'evidence_ref' => '<string>',
'captured_at' => 123,
'status' => 'active',
'call_idempotency_key' => '<string>',
'expires_at' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.pyai.com/v1/telephony/compliance/consents"
payload := strings.NewReader("{\n \"destination\": \"+14155550123\",\n \"purposes\": [],\n \"timezone\": \"America/Los_Angeles\",\n \"evidence_ref\": \"<string>\",\n \"captured_at\": 123,\n \"status\": \"active\",\n \"call_idempotency_key\": \"<string>\",\n \"expires_at\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
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.pyai.com/v1/telephony/compliance/consents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"destination\": \"+14155550123\",\n \"purposes\": [],\n \"timezone\": \"America/Los_Angeles\",\n \"evidence_ref\": \"<string>\",\n \"captured_at\": 123,\n \"status\": \"active\",\n \"call_idempotency_key\": \"<string>\",\n \"expires_at\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pyai.com/v1/telephony/compliance/consents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"destination\": \"+14155550123\",\n \"purposes\": [],\n \"timezone\": \"America/Los_Angeles\",\n \"evidence_ref\": \"<string>\",\n \"captured_at\": 123,\n \"status\": \"active\",\n \"call_idempotency_key\": \"<string>\",\n \"expires_at\": 123\n}"
response = http.request(request)
puts response.read_body{
"object": "telephony.consent",
"id": "<string>",
"destination": "<string>",
"level": "express",
"purposes": [
"transactional"
],
"status": "active",
"timezone": "<string>",
"captured_at": 123,
"expires_at": 123,
"call_idempotency_key": "<string>",
"inbound_forward": {
"project_id": "<string>",
"phone_number_id": "<string>"
}
}{
"title": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"request_id": "<string>"
}{
"error": {
"message": "<string>",
"type": "<string>",
"code": "invalid_request_error",
"param": "<string>"
}
}Record destination consent
Store tenant-scoped consent evidence. Supported destinations include North America (+1), India (+91), and Australian geographic/mobile numbers (+61, without the domestic trunk zero). Sales requires express written consent. The response masks the destination and echoes call_idempotency_key (null for broad consent). Optional call_idempotency_key restricts evidence to the exact Idempotency-Key of one durable single-attempt call; client_reference is not a unique call identity. Allocate and save that call key before capturing a self-request. A recipient-requested immediate support test may run outside scheduled calling hours when its exact-call grant has only the support purpose and expires no later than 120 seconds after capture. The grant must already be captured and unexpired; all other admission controls still apply, and the saved calling policy is unchanged. Other call-specific records do not affect this call or broad consent. The latest applicable broad or exact-call record governs, including withdrawal and expiry. Withdrawal blocks later admissions; cancellation of an already admitted call is a separate operation. Ordinary outbound or AI-transfer legs require applicable broad consent. Optional inbound_forward restricts support consent to forwarding from one owned project and number; it is mutually exclusive with call_idempotency_key, does not authorize ordinary outbound calls, and does not bypass calling windows or quotas. The latest applicable broad or exact scoped record governs; broad withdrawal affects all scopes.
curl --request POST \
--url https://api.pyai.com/v1/telephony/compliance/consents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"destination": "+14155550123",
"purposes": [],
"timezone": "America/Los_Angeles",
"evidence_ref": "<string>",
"captured_at": 123,
"status": "active",
"call_idempotency_key": "<string>",
"expires_at": 123
}
'import requests
url = "https://api.pyai.com/v1/telephony/compliance/consents"
payload = {
"destination": "+14155550123",
"purposes": [],
"timezone": "America/Los_Angeles",
"evidence_ref": "<string>",
"captured_at": 123,
"status": "active",
"call_idempotency_key": "<string>",
"expires_at": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
destination: '+14155550123',
purposes: [],
timezone: 'America/Los_Angeles',
evidence_ref: '<string>',
captured_at: 123,
status: 'active',
call_idempotency_key: '<string>',
expires_at: 123
})
};
fetch('https://api.pyai.com/v1/telephony/compliance/consents', 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.pyai.com/v1/telephony/compliance/consents",
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([
'destination' => '+14155550123',
'purposes' => [
],
'timezone' => 'America/Los_Angeles',
'evidence_ref' => '<string>',
'captured_at' => 123,
'status' => 'active',
'call_idempotency_key' => '<string>',
'expires_at' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.pyai.com/v1/telephony/compliance/consents"
payload := strings.NewReader("{\n \"destination\": \"+14155550123\",\n \"purposes\": [],\n \"timezone\": \"America/Los_Angeles\",\n \"evidence_ref\": \"<string>\",\n \"captured_at\": 123,\n \"status\": \"active\",\n \"call_idempotency_key\": \"<string>\",\n \"expires_at\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
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.pyai.com/v1/telephony/compliance/consents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"destination\": \"+14155550123\",\n \"purposes\": [],\n \"timezone\": \"America/Los_Angeles\",\n \"evidence_ref\": \"<string>\",\n \"captured_at\": 123,\n \"status\": \"active\",\n \"call_idempotency_key\": \"<string>\",\n \"expires_at\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pyai.com/v1/telephony/compliance/consents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"destination\": \"+14155550123\",\n \"purposes\": [],\n \"timezone\": \"America/Los_Angeles\",\n \"evidence_ref\": \"<string>\",\n \"captured_at\": 123,\n \"status\": \"active\",\n \"call_idempotency_key\": \"<string>\",\n \"expires_at\": 123\n}"
response = http.request(request)
puts response.read_body{
"object": "telephony.consent",
"id": "<string>",
"destination": "<string>",
"level": "express",
"purposes": [
"transactional"
],
"status": "active",
"timezone": "<string>",
"captured_at": 123,
"expires_at": 123,
"call_idempotency_key": "<string>",
"inbound_forward": {
"project_id": "<string>",
"phone_number_id": "<string>"
}
}{
"title": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"request_id": "<string>"
}{
"error": {
"message": "<string>",
"type": "<string>",
"code": "invalid_request_error",
"param": "<string>"
}
}Authorizations
Headers
Use a stable key for one consent grant. Repeating the same normalized evidence returns the original consent, including after a lost response or key rotation. Reuse with different evidence returns 409. Identity is retained with the consent record, independently of request-cache expiration. A replay does not renew, reactivate, or extend consent.
1 - 255Body
Optional exact Idempotency-Key of the one permitted durable call. Omit for ordinary broad consent. The permitted call has one carrier attempt; ServiceAgent integration calls already enforce this without changing tenant calling policy. Changing this field on a consent replay returns 409.
1 - 255Response
Consent recorded or the original matching grant replayed