VoiceGateway

Read configured budgets, retention and embed origins

GET
/api/v1/org/{orgId}/project/{projectId}/settings

Authorization

cookievg_session<token>

The console's session cookie, set when you sign in. Every operation accepts it, at the role the operation names.

Path Parameters

orgId*string

Authorised orgId; the server must verify organisation/project ownership before any read.

Length1 <= length
projectId*string

Authorised projectId; the server must verify organisation/project ownership before any read.

Length1 <= length

Response Body

Authorised read result. Null means unreported, never zero. Source-specific coverage limits remain visible.

application/json
  1. response
revision*integer

Revision checked atomically on save to prevent lost updates.

Range0 <= value <= 9007199254740991
thresholds*
storageBucket*|

Configured storage destination label only, null when not configured. Never return access credentials.

transcriptRetentionDays*|

Configured transcript retention, null when no policy is configured. No default retention is selected by this contract.

Range1 <= value
traceRetentionDays*|

Configured trace/metric retention, null when no policy is configured.

Range1 <= value
recordingRetentionDays*|

Configured audio retention, null when no policy is configured.

Range1 <= value
allowedOrigins*array<>|

Configured embed framing origin allow-list, null when not configured. Missing configuration never authorises arbitrary origins.

allowedOriginsRevision*integer

Version of allowedOrigins alone, sent back with updateAllowedOrigins. Saving sites never moves revision, which versions the thresholds.

Range0 <= value <= 9007199254740991
Example Request
curl -X GET 'https://example.com/api/v1/org/string/project/string/settings'
Example Response
{  "revision": 0,  "thresholds": {    "answerMs": 1500,    "joinMs": 2000,    "ttsStartMs": 1000  },  "storageBucket": "string",  "transcriptRetentionDays": 1,  "traceRetentionDays": 1,  "recordingRetentionDays": 1,  "allowedOrigins": [    "http://example.com"  ],  "allowedOriginsRevision": 0}

Was this page helpful?