Appearance
pbx-speech
16 endpoints.
GET /api/v1/pbx-speech/calls/{call_id}
Get Call
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
call_id | path | yes | integer |
200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Get Call Api V1 Pbx Speech Calls Call Id Get"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/pbx-speech/settings/{domain}
Get Settings
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
domain | path | yes | string |
200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Get Settings Api V1 Pbx Speech Settings Domain Get"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}PUT /api/v1/pbx-speech/settings/{domain}
Put Settings
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
domain | path | yes | string |
Request body
json
{
"properties": {
"rubric": {
"anyOf": [
{
"items": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"label": {
"type": "string",
"maxLength": 120,
"title": "Label"
},
"weight": {
"type": "integer",
"maximum": 5,
"minimum": 1,
"title": "Weight",
"default": 1
},
"description": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "null"
}
],
"title": "Description"
}
},
"type": "object",
"required": [
"label"
],
"title": "RubricItem"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Rubric"
},
"reset_rubric": {
"type": "boolean",
"title": "Reset Rubric",
"default": false
},
"keywords": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Keywords"
},
"monthly_minute_cap": {
"anyOf": [
{
"type": "integer",
"maximum": 100000,
"minimum": 0
},
{
"type": "null"
}
],
"title": "Monthly Minute Cap"
},
"enabled_override": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Enabled Override"
},
"clear_override": {
"type": "boolean",
"title": "Clear Override",
"default": false
},
"min_seconds": {
"anyOf": [
{
"type": "integer",
"maximum": 3600,
"minimum": 0
},
{
"type": "null"
}
],
"title": "Min Seconds"
},
"retention_days": {
"anyOf": [
{
"type": "integer",
"maximum": 3650,
"minimum": 1
},
{
"type": "null"
}
],
"title": "Retention Days"
},
"notify_enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Notify Enabled"
},
"notify_to": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "null"
}
],
"title": "Notify To"
}
},
"type": "object",
"title": "SettingsUpdate"
}200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Put Settings Api V1 Pbx Speech Settings Domain Put"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/pbx-speech/live
Get Live
Calls in progress on the caller's own PBX domains, with their captions. ?since=<uuid>:<seq>,<uuid>:<seq> returns only lines newer than those.
200 — Successful Response
json
{
"additionalProperties": true,
"type": "object",
"title": "Response Get Live Api V1 Pbx Speech Live Get"
}GET /api/v1/pbx-speech/actions/summary
Actions Summary
The Transcriptions dashboard tab: totals, weekly created vs completed, open per extension — over the caller's own PBX domains.
200 — Successful Response
json
{
"additionalProperties": true,
"type": "object",
"title": "Response Actions Summary Api V1 Pbx Speech Actions Summary Get"
}POST /api/v1/pbx-speech/actions/{action_id}
Set Action Status
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
action_id | path | yes | integer |
Request body
json
{
"properties": {
"status": {
"type": "string",
"pattern": "^(open|done|dismissed)$",
"title": "Status"
}
},
"type": "object",
"required": [
"status"
],
"title": "ActionStatusBody"
}200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Set Action Status Api V1 Pbx Speech Actions Action Id Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/pbx-speech/worker/wanted
Worker Wanted
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
limit | query | no | integer |
200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Worker Wanted Api V1 Pbx Speech Worker Wanted Get"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/pbx-speech/worker/audio/{call_id}
Worker Audio
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
call_id | path | yes | integer |
200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Worker Audio Api V1 Pbx Speech Worker Audio Call Id Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/pbx-speech/worker/missing/{call_id}
Worker Missing
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
call_id | path | yes | integer |
Request body
json
{
"properties": {
"reason": {
"type": "string",
"title": "Reason",
"default": "audio_unavailable"
}
},
"type": "object",
"title": "MissingBody"
}200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Worker Missing Api V1 Pbx Speech Worker Missing Call Id Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/pbx-speech/worker/deletable
Worker Deletable
Originals the PBX agent should delete: transcribed, and not kept for Call Recording. See pbx_speech.deletable.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
limit | query | no | integer |
200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Worker Deletable Api V1 Pbx Speech Worker Deletable Get"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/pbx-speech/worker/deleted/{call_id}
Worker Deleted
The agent removed (or could no longer find) this call's original.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
call_id | path | yes | integer |
200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Worker Deleted Api V1 Pbx Speech Worker Deleted Call Id Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/pbx-speech/worker/live-targets
Worker Live Targets
{domain: [extensions] | null} — what the PBX agent should caption.
200 — Successful Response
json
{
"additionalProperties": true,
"type": "object",
"title": "Response Worker Live Targets Api V1 Pbx Speech Worker Live Targets Get"
}POST /api/v1/pbx-speech/worker/live/{call_uuid}/start
Worker Live Start
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
call_uuid | path | yes | string |
Request body
json
{
"properties": {
"domain": {
"type": "string",
"title": "Domain"
},
"extension": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Extension"
},
"direction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Direction"
},
"other_number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Other Number"
}
},
"type": "object",
"required": [
"domain"
],
"title": "LiveStartBody"
}200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Worker Live Start Api V1 Pbx Speech Worker Live Call Uuid Start Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/pbx-speech/worker/live/{call_uuid}/slice
Worker Live Slice
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
call_uuid | path | yes | string |
200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Worker Live Slice Api V1 Pbx Speech Worker Live Call Uuid Slice Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/pbx-speech/worker/live/{call_uuid}/end
Worker Live End
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
call_uuid | path | yes | string |
200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Worker Live End Api V1 Pbx Speech Worker Live Call Uuid End Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/pbx-speech/worker/live/{call_uuid}/audio
Worker Live Audio
The agent's WHOLE capture of a finished call — what the permanent transcript is made from, so the extension need not record. Always 200: final tells the agent whether to drop its file or try again.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
call_uuid | path | yes | string |
200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Worker Live Audio Api V1 Pbx Speech Worker Live Call Uuid Audio Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}