VocalDocscontracts 1.65.0

Read the platform settings entries

GET /v1/platform/settings

PropertyValue
Operationget_platform_settings
GroupPlatform
Scopeplatform:read
Route classread
IdempotencyNo Idempotency-Key
AuditNot audited: A configuration read; the entries are platform data.
Released in1.9.0
Phase 0 hostServed (the hosted api pins 1.65.0)

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the platform:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/platform/settings" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

Responses

StatusContent typeShapeError codes
200application/jsonPlatformSettings
400application/jsonErrorEnvelopeinvalid_request
401application/jsonErrorEnvelopeunauthenticated
403application/jsonErrorEnvelopeforbidden
429application/jsonErrorEnveloperate_limited
500application/jsonErrorEnvelopeinternal_error

Fields of the 200 answer

The shape is PlatformSettings.

FieldTypeRequiredDescription
carrier_legCarrierLegSecurity or nullnoWhat the deployment sets the SIP trunks to (1.34.0), read-only and not part of the entries or their version: PATCH /v1/platform/settings refuses a body that names it. Null when the deployment sets none; a reader treats its absence as null, as from an api before 1.34.0.
entriesarray of PlatformEntryyes
object"platform_settings"yes
price_ceiling_factorPriceCeilingFactornoThe factor of the price ceiling in force (1.38.0, PriceCeilingFactor): a new vendor price entry above it times the highest price in force of the same unit is refused with price_above_ceiling. The api from 1.38.0 always sends it; a reader treats its absence as 2, the default.
updated_atTimestamp or nullyes
updated_byActorRef or nullyes
versionintegeryes0 before the first replacement; the ETag.