Recordings API

Generated from api/openapi.public.yaml, the same spec the API serves. Try these operations in the API console; errors are Problem Details.

List the call audio library

GET /api/v1/workspaces/{workspaceId}/recordings

Recordings that a team’s settings play are listed only for that team’s members, Owner and Admin.

Operation id	listRecordings
Authentication	A secret key (sk_live_… or sk_test_…), an SDK session token (sdk_…), or a secret partner key for one of the partner’s stores.
Permission (key scope)	recordings:view
Plan feature	recordings.library

Parameters

Name	In	Type	Required	Description
workspaceId	path	string	yes	Workspace id (UUID)
kind	query	"greeting" | "option" | "fallback_closed" | "fallback_prayer" | "fallback_missed" | "hold" | "custom"		Only recordings of this kind
language	query	"en" | "so" | "ar"		Only recordings in this language

Responses

Status	Description	Body
200	OK	application/json: ListOutputBody
default	Error	application/problem+json: Problem

Example

curl -X GET "https://api.nexafone.so/api/v1/workspaces/{workspaceId}/recordings" \
  -H "Authorization: Bearer $NEXAFON_SECRET_KEY"

Get a recording

GET /api/v1/workspaces/{workspaceId}/recordings/{recordingId}

Operation id	getRecording
Authentication	A secret key (sk_live_… or sk_test_…), an SDK session token (sdk_…), or a secret partner key for one of the partner’s stores.
Permission (key scope)	recordings:view
Plan feature	recordings.library

Parameters

Name	In	Type	Required	Description
workspaceId	path	string	yes	Workspace id (UUID)
recordingId	path	string	yes	Recording id (UUID)

Responses

Status	Description	Body
200	OK	application/json: RecordingBody
404	Not Found	application/problem+json: Problem
422	Unprocessable Entity	application/problem+json: Problem
500	Internal Server Error	application/problem+json: Problem

Example

curl -X GET "https://api.nexafone.so/api/v1/workspaces/{workspaceId}/recordings/{recordingId}" \
  -H "Authorization: Bearer $NEXAFON_SECRET_KEY"