Signals Docs
Calls and recordings
Calls and recordings

Recordings

List the organization's recording library

GET
https://api.signals.pressone.africa/v1
/recordings

List the organization's recording library › query Parameters

window
​string · enum
Enum values:
24h
7d
30d
trunk_id
​string

One trk_ trunk id; leave it out for every trunk.

direction
​string · enum
Enum values:
inbound
outbound
state
​string · enum
Enum values:
pending
capturing
stored
failed
deleting
deleted
length
​string · enum
Enum values:
under_30s
30s_5m
over_5m
expiry
​string · enum
Enum values:
expiring_7d
expiring_30d
legal_hold
q
​string

List the organization's recording library › Headers

X-Project-ID
​string

The project the request acts on, as prj_ and its lowercase UUID; optional while the organization has one active project.

List the organization's recording library › Responses

The matching recordings with policy and price.

RecordingsPage
​required
​Recording[] · required
​required
recorded_ms_this_month
​integer · int64 · required
total
​integer · int64 · min: 0 · required

Delete one stored recording

DELETE
https://api.signals.pressone.africa/v1
/recordings/{recording_id}

Delete one stored recording › path Parameters

recording_id
​string · required

Recording id

Delete one stored recording › Headers

Idempotency-Key
​string · required

One nonblank key of at most 128 characters; a retry with the same key repeats the outcome.

X-Project-ID
​string

The project the request acts on, as prj_ and its lowercase UUID; optional while the organization has one active project.

Delete one stored recording › Responses

The deletion was accepted; the recording is deleting until its object is gone.

A recording as a deletion request leaves it.
RecordingDetail
id
​string · required
state
​RecordingLifecycleState · enum · required
Enum values:
pending
capturing
stored
failed
deleting
deleted

Stream recording media with metered delivery

GET
https://api.signals.pressone.africa/v1
/recordings/{recording_id}/media

Stream recording media with metered delivery › path Parameters

recording_id
​string · required

Recording id

Stream recording media with metered delivery › query Parameters

purpose
​string · enum
Enum values:
playback
download

Stream recording media with metered delivery › Headers

X-Project-ID
​string

The project the request acts on, as prj_ and its lowercase UUID; optional while the organization has one active project.

Range
​string

One byte range: bytes=start-end, start- or -suffix.

If-Range
​string

Serve the range only while this ETag matches.

Stream recording media with metered delivery › Responses

The whole recording audio.

string · binary

The raw bytes of a file, for bodies that are not JSON.

Calls