Read which content classes of a Call the caller may see
GET /v1/calls/{call_id}/content-access
| Property | Value |
|---|---|
| Operation | get_call_content_access |
| Group | Call trace and analytics |
| Scope | calls:read |
| Route class | read |
| Idempotency | No Idempotency-Key |
| Audit | Not audited: A metadata read; it names classes and grant ids and reads no Call content. |
| Released in | 1.58.0 |
| Phase 0 host | Served (the hosted api pins 1.65.0) |
Answers, for the caller, each content class of the Call as allowed, reveal or denied, with the reveal grant that opens a class (1.58.0): a Member by its role's cell in the Compliance profile in force and its own active grants, an API key by its scopes. The Call page offers Reveal for a reveal class without a refused read. A Call of another Organization is not found.
Request
Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the calls:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.
curl "$VOCAL_API/v1/calls/call_.../content-access" \
-H "Authorization: Bearer $VOCAL_API_KEY"const response = await fetch(`${process.env.VOCAL_API}/v1/calls/call_.../content-access`, {
headers: {
Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
},
});
console.log(response.status, await response.text());import os
import requests
response = requests.get(
f"{os.environ['VOCAL_API']}/v1/calls/call_.../content-access",
headers={
"Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
},
)
print(response.status_code, response.text)Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
call_id | path | CallId | yes | The id of a Call: call_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log. |
Responses
| Status | Content type | Shape | Error codes |
|---|---|---|---|
200 | application/json | CallContentAccess | |
400 | application/json | ErrorEnvelope | invalid_request |
401 | application/json | ErrorEnvelope | unauthenticated |
403 | application/json | ErrorEnvelope | forbidden |
404 | application/json | ErrorEnvelope | not_found |
429 | application/json | ErrorEnvelope | rate_limited |
500 | application/json | ErrorEnvelope | internal_error |
Fields of the 200 answer
The shape is CallContentAccess.
| Field | Type | Required | Description |
|---|---|---|---|
call_id | CallId | yes | |
classes | array of ContentClassAccess | yes | Each content class, in the order of CONTENT_LOG_CLASSES. |
object | "call_content_access" | yes |