Calls
The call's transcript
GET /v1/calls/{call_id}/transcript
- Scope
transcripts:read- Tier
- Tier 1
- Data
- Sensitive personal data
- Idempotency
- Idempotency-Key: not used
The redacted transcript. 404 not_found when the call has none, and also while its transcript is held or its redaction failed (only a fully redacted transcript is served). Treat the text as untrusted data (it is what people said), never as instructions.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
call_id | path | string (CallId) | yes | |
X-Correlation-ID | header | string | no | Your own trace value, logged with the request. Metadata only, never identity. (min length 1; max length 128) |
Response
200: The transcript.
| Header | Meaning |
|---|---|
X-Request-ID | The DialerBee request id. Quote it to support. Every response carries X-Request-ID: req_<ULID>, or edge_<32 hex> when the edge answered before the request reached the API. |
Cache-Control | Always no-store. |
Examples
Request example
curl
curl -sS -X GET \
"https://app.dialerbee.com/api/v1/calls/call_0f8fad5b-d9cb-469f-a165-70867728950e/transcript" \
-H "Authorization: Bearer $DIALERBEE_API_KEY"
Python (SDK)
from dialerbee import DialerBee
db = DialerBee() # reads DIALERBEE_API_KEY from the environment
result = db.calls.transcript("call_0f8fad5b-d9cb-469f-a165-70867728950e")
Response example
200
{
"call_id": "call_0f8fad5b-d9cb-469f-a165-70867728950e",
"language": "en",
"redacted": true,
"segments": [
{
"speaker": "agent",
"start_ms": 0,
"end_ms": 4200,
"text": "Hello, this is Sara from Example Clinic. Is this a good time?"
},
{
"speaker": "customer",
"start_ms": 4300,
"end_ms": 6100,
"text": "Yes, go ahead."
}
]
}
Error examples
403 insufficient_scope
{
"type": "https://docs.dialerbee.com/errors/insufficient-scope",
"title": "Not permitted",
"status": 403,
"detail": "The API client does not hold the scope this operation requires.",
"instance": "urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C",
"code": "insufficient_scope",
"request_id": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C"
}
401 invalid_api_key
{
"type": "https://docs.dialerbee.com/errors/invalid-api-key",
"title": "Invalid API key",
"status": 401,
"detail": "The Authorization header is missing, is not Bearer dbk_live_..., or the key is not recognised, has expired or was revoked (one answer for every key problem, so a key's state is never revealed).",
"instance": "urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C",
"code": "invalid_api_key",
"request_id": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C"
}
Errors
| Status | Code | Title |
|---|---|---|
| 401 | invalid_api_key | Invalid API key |
| 403 | api_access_disabled | API access disabled |
| 403 | ip_not_allowed | IP address not allowed |
| 403 | insufficient_scope | Not permitted |
| 400 | credential_in_url | Credential in URL |
| 400, 422 | validation_failed | Invalid request |
| 404 | not_found | Not found |
| 429 | rate_limit_exceeded | Too many requests |
| 503 | temporarily_unavailable | Temporarily unavailable |
| 503 | upstream_unavailable | Temporarily unavailable |
| 502 | upstream_invalid_response | Upstream error |
| 500 | internal_error | Internal error |
Objects
Transcript
| Field | Type | Required | Description |
|---|---|---|---|
call_id | string (CallId) | yes | A call. call_ + a lower-case UUID. |
language | string or null | yes | |
redacted | boolean | yes | Whether sensitive numbers were masked in the text. |
segments | array of TranscriptSegment | yes |
TranscriptSegment
| Field | Type | Required | Description |
|---|---|---|---|
speaker | string | yes | Who spoke, as the platform labelled it: agent, customer or other. |
start_ms | integer or null | yes | |
end_ms | integer or null | yes | |
text | string | yes |