Rivier/ Reference/ voice

Change the voice settings

put/calls/settings

Change the voice settings. Recording cannot be turned on until the project confirms its counsel has read the recording rules.

Before you call

Credential
Authorization: Bearer $KEY
Scope
voice:write
Graphql
Mutation.voiceCallSettingsUpdate
Sdk
calls.settings.update
Cli
calls settings-set

Request bodyapplication/json, required

  • callerIdslist of string
  • recordingobject
    • enabledboolean
      Off unless turned on. Cannot be on until counselReviewed is true
    • counselReviewedboolean
      Your counsel has read the recording rules for the places your callers are in
    • retentionDaysinteger
      At least 1. At most 365.
  • allowCountrieslist of string
  • denyCountrieslist of string
  • blockPremiumboolean
  • maxCallsPerHourinteger
    At least 1. At most 10000.
  • maxSecondsPerCallinteger
    At least 30. At most 3600.
  • callerNamestring or null
    The name every call opens with: This is an automated call from ...
  • quietHoursobject or null

Responses

  • 200application/json
    Success
    • 400application/json
      The request was malformed
      • errorstringrequired
      • messagestring
    • 401application/json
      No valid credential
      • errorstringrequired
      • messagestring
    • 403application/json
      The credential lacks the scope, origin or address
      • errorstringrequired
      • messagestring
    • 429application/json
      Over the key's rate limit; see Retry-After
      • errorstringrequired
      • messagestring

    This page as Markdown