Calls

Replace per-instance call settings

Updates settings stored by instance_id. Global CALLS_* flags remain master locks and may keep effective fields disabled.

Pro

PUThttp://localhost:8084/call/{instanceName}/config

Autenticação

InstanceBearerobrigatório

JWT HS256 da própria instância.

Header: Authorization
Exemplo: Bearer <INSTANCE_TOKEN>

Parâmetros

instanceNamepathobrigatório

string

Nome publico da instancia

minLength 1

Request body

obrigatório

bodyallOf

opção 1object

callsEnabledbooleanobrigatóriopadrão: false

incomingCallsEnabledbooleanobrigatóriopadrão: false

outgoingCallsEnabledbooleanobrigatóriopadrão: false

audioobjectobrigatório

enabledbooleanobrigatóriopadrão: true

receiveEnabledbooleanobrigatóriopadrão: true

sendEnabledbooleanobrigatóriopadrão: true

playbackEnabledbooleanobrigatóriopadrão: true

streamingEnabledbooleanobrigatóriopadrão: true

videoobjectobrigatório

enabledbooleanobrigatóriopadrão: false

receiveEnabledbooleanobrigatóriopadrão: false

sendEnabledbooleanobrigatóriopadrão: false

upgradeEnabledbooleanobrigatóriopadrão: false

playbackEnabledbooleanobrigatóriopadrão: false

reactionsEnabledbooleanobrigatóriopadrão: true

groupobject

enabledbooleanpadrão: false

audioEnabledbooleanpadrão: false

videoEnabledbooleanpadrão: false

adHocEnabledbooleanpadrão: false

callLinksobject

enabledbooleanpadrão: false

previewEnabledbooleanpadrão: false

approvalEnabledbooleanpadrão: false

participantsobject

inviteEnabledbooleanpadrão: false

reringEnabledbooleanpadrão: false

lateJoinEnabledbooleanpadrão: false

raisedHandEnabledbooleanpadrão: false

extendedReactionsEnabledbooleanpadrão: false

scheduledCallsEnabledbooleanpadrão: false

screenShareobject

enabledbooleanpadrão: false

sendEnabledbooleanpadrão: false

receiveEnabledbooleanpadrão: false

recordingEnabledbooleanpadrão: false

recordingobjectobrigatório

enabledbooleanobrigatóriopadrão: false

audioEnabledbooleanobrigatóriopadrão: false

videoEnabledbooleanobrigatóriopadrão: false

retentionDaysinteger | nullmín: 1

diagnosticsEnabledbooleanobrigatóriopadrão: false

autoAnswerobjectobrigatório

enabledbooleanobrigatóriopadrão: false

delayMsintegerobrigatóriopadrão: 0 · mín: 0

audioMediaIdstring | null

videoMediaIdstring | null

limitsobjectobrigatório

maxConcurrentCallsintegerobrigatóriomín: 1

maxGroupCallsintegermín: 1

maxGroupCallParticipantsintegermín: 2

maxWaitingParticipantsintegermín: 1

maxParticipantReringAttemptsintegermín: 1

participantReringCooldownSecondsintegermín: 5

ringTimeoutSecondsintegerobrigatóriomín: 5 · máx: 300

connectTimeoutSecondsintegerobrigatóriomín: 5 · máx: 120

maxCallDurationSecondsintegerobrigatóriomín: 30

opção 2object

terminateActiveCallsbooleanpadrão: false

When callsEnabled changes from true to false, terminate active calls instead of only blocking new calls.

Exemplo JSONgerado do schema

{
  "callsEnabled": false,
  "incomingCallsEnabled": false,
  "outgoingCallsEnabled": false,
  "audio": {
    "enabled": true,
    "receiveEnabled": true,
    "sendEnabled": true,
    "playbackEnabled": true,
    "streamingEnabled": true
  },
  "video": {
    "enabled": false,
    "receiveEnabled": false,
    "sendEnabled": false,
    "upgradeEnabled": false,
    "playbackEnabled": false
  },
  "reactionsEnabled": true,
  "group": {
    "enabled": false,
    "audioEnabled": false,
    "videoEnabled": false,
    "adHocEnabled": false
  },
  "callLinks": {
    "enabled": false,
    "previewEnabled": false,
    "approvalEnabled": false
  },
  "participants": {
    "inviteEnabled": false,
    "reringEnabled": false,
    "lateJoinEnabled": false
  },
  "raisedHandEnabled": false,
  "extendedReactionsEnabled": false,
  "scheduledCallsEnabled": false,
  "screenShare": {
    "enabled": false,
    "sendEnabled": false,
    "receiveEnabled": false,
    "recordingEnabled": false
  },
  "recording": {
    "enabled": false,
    "audioEnabled": false,
    "videoEnabled": false,
    "retentionDays": 1
  },
  "diagnosticsEnabled": false,
  "autoAnswer": {
    "enabled": false,
    "delayMs": 0,
    "audioMediaId": "string",
    "videoMediaId": "string"
  },
  "limits": {
    "maxConcurrentCalls": 1,
    "maxGroupCalls": 1,
    "maxGroupCallParticipants": 2,
    "maxWaitingParticipants": 1,
    "maxParticipantReringAttempts": 1,
    "participantReringCooldownSeconds": 5,
    "ringTimeoutSeconds": 5,
    "connectTimeoutSeconds": 5,
    "maxCallDurationSeconds": 30
  },
  "terminateActiveCalls": false
}

Respostas

application/json

200

Updated instance call settings

response 200object

instanceobjectobrigatório

idintegerobrigatório

namestringobrigatório

settingsobjectobrigatório

callsEnabledbooleanobrigatóriopadrão: false

incomingCallsEnabledbooleanobrigatóriopadrão: false

outgoingCallsEnabledbooleanobrigatóriopadrão: false

audioobjectobrigatório

enabledbooleanobrigatóriopadrão: true

receiveEnabledbooleanobrigatóriopadrão: true

sendEnabledbooleanobrigatóriopadrão: true

playbackEnabledbooleanobrigatóriopadrão: true

streamingEnabledbooleanobrigatóriopadrão: true

videoobjectobrigatório

enabledbooleanobrigatóriopadrão: false

receiveEnabledbooleanobrigatóriopadrão: false

sendEnabledbooleanobrigatóriopadrão: false

upgradeEnabledbooleanobrigatóriopadrão: false

playbackEnabledbooleanobrigatóriopadrão: false

reactionsEnabledbooleanobrigatóriopadrão: true

groupobject

enabledbooleanpadrão: false

audioEnabledbooleanpadrão: false

videoEnabledbooleanpadrão: false

adHocEnabledbooleanpadrão: false

callLinksobject

enabledbooleanpadrão: false

previewEnabledbooleanpadrão: false

approvalEnabledbooleanpadrão: false

participantsobject

inviteEnabledbooleanpadrão: false

reringEnabledbooleanpadrão: false

lateJoinEnabledbooleanpadrão: false

raisedHandEnabledbooleanpadrão: false

extendedReactionsEnabledbooleanpadrão: false

scheduledCallsEnabledbooleanpadrão: false

screenShareobject

enabledbooleanpadrão: false

sendEnabledbooleanpadrão: false

receiveEnabledbooleanpadrão: false

recordingEnabledbooleanpadrão: false

recordingobjectobrigatório

enabledbooleanobrigatóriopadrão: false

audioEnabledbooleanobrigatóriopadrão: false

videoEnabledbooleanobrigatóriopadrão: false

retentionDaysinteger | nullmín: 1

diagnosticsEnabledbooleanobrigatóriopadrão: false

autoAnswerobjectobrigatório

enabledbooleanobrigatóriopadrão: false

delayMsintegerobrigatóriopadrão: 0 · mín: 0

audioMediaIdstring | null

videoMediaIdstring | null

limitsobjectobrigatório

maxConcurrentCallsintegerobrigatóriomín: 1

maxGroupCallsintegermín: 1

maxGroupCallParticipantsintegermín: 2

maxWaitingParticipantsintegermín: 1

maxParticipantReringAttemptsintegermín: 1

participantReringCooldownSecondsintegermín: 5

ringTimeoutSecondsintegerobrigatóriomín: 5 · máx: 300

connectTimeoutSecondsintegerobrigatóriomín: 5 · máx: 120

maxCallDurationSecondsintegerobrigatóriomín: 30

effectiveobjectobrigatório

Result of global CALLS_* master locks combined with stored instance settings.

callsEnabledboolean

incomingCallsEnabledboolean

outgoingCallsEnabledboolean

audioEnabledboolean

audioReceiveEnabledboolean

audioSendEnabledboolean

audioPlaybackEnabledboolean

audioStreamingEnabledboolean

videoEnabledboolean

videoReceiveEnabledboolean

videoSendEnabledboolean

videoUpgradeEnabledboolean

videoPlaybackEnabledboolean

reactionsEnabledboolean

groupCallsEnabledboolean

groupAudioEnabledboolean

groupVideoEnabledboolean

adHocGroupCallsEnabledboolean

callLinksEnabledboolean

callLinkPreviewEnabledboolean

callLinkApprovalEnabledboolean

scheduledCallsEnabledboolean

participantInviteEnabledboolean

participantReringEnabledboolean

lateJoinEnabledboolean

raisedHandEnabledboolean

screenShareEnabledboolean

screenShareSendEnabledboolean

screenShareReceiveEnabledboolean

screenShareRecordingEnabledboolean

extendedReactionsEnabledboolean

recordingEnabledboolean

audioRecordingEnabledboolean

videoRecordingEnabledboolean

diagnosticsEnabledboolean

autoAnswerEnabledboolean

maxConcurrentCallsinteger

maxGroupCallsinteger

maxGroupCallParticipantsinteger

maxWaitingParticipantsinteger

maxParticipantReringAttemptsinteger

participantReringCooldownSecondsinteger

ringTimeoutSecondsinteger

connectTimeoutSecondsinteger

maxCallDurationSecondsinteger

activeCallsobject

foundintegerobrigatório

terminatedintegerobrigatório

failedintegerobrigatório

Exemplo 200gerado do schema

{
  "instance": {
    "id": 1,
    "name": "CodeChat"
  },
  "settings": {
    "callsEnabled": false,
    "incomingCallsEnabled": false,
    "outgoingCallsEnabled": false,
    "audio": {
      "enabled": true,
      "receiveEnabled": true,
      "sendEnabled": true,
      "playbackEnabled": true,
      "streamingEnabled": true
    },
    "video": {
      "enabled": false,
      "receiveEnabled": false,
      "sendEnabled": false,
      "upgradeEnabled": false,
      "playbackEnabled": false
    },
    "reactionsEnabled": true,
    "group": {
      "enabled": false,
      "audioEnabled": false,
      "videoEnabled": false,
      "adHocEnabled": false
    },
    "callLinks": {
      "enabled": false,
      "previewEnabled": false,
      "approvalEnabled": false
    },
    "participants": {
      "inviteEnabled": false,
      "reringEnabled": false,
      "lateJoinEnabled": false
    },
    "raisedHandEnabled": false,
    "extendedReactionsEnabled": false,
    "scheduledCallsEnabled": false,
    "screenShare": {
      "enabled": false,
      "sendEnabled": false,
      "receiveEnabled": false,
      "recordingEnabled": false
    },
    "recording": {
      "enabled": false,
      "audioEnabled": false,
      "videoEnabled": false,
      "retentionDays": 1
    },
    "diagnosticsEnabled": false,
    "autoAnswer": {
      "enabled": false,
      "delayMs": 0,
      "audioMediaId": "string",
      "videoMediaId": "string"
    },
    "limits": {
      "maxConcurrentCalls": 1,
      "maxGroupCalls": 1,
      "maxGroupCallParticipants": 2,
      "maxWaitingParticipants": 1,
      "maxParticipantReringAttempts": 1,
      "participantReringCooldownSeconds": 5,
      "ringTimeoutSeconds": 5,
      "connectTimeoutSeconds": 5,
      "maxCallDurationSeconds": 30
    }
  },
  "effective": {
    "callsEnabled": true,
    "incomingCallsEnabled": true,
    "outgoingCallsEnabled": true,
    "audioEnabled": true,
    "audioReceiveEnabled": true,
    "audioSendEnabled": true,
    "audioPlaybackEnabled": true,
    "audioStreamingEnabled": true,
    "videoEnabled": true,
    "videoReceiveEnabled": true,
    "videoSendEnabled": true,
    "videoUpgradeEnabled": true,
    "videoPlaybackEnabled": true,
    "reactionsEnabled": true,
    "groupCallsEnabled": true,
    "groupAudioEnabled": true,
    "groupVideoEnabled": true,
    "adHocGroupCallsEnabled": true,
    "callLinksEnabled": true,
    "callLinkPreviewEnabled": true,
    "callLinkApprovalEnabled": true,
    "scheduledCallsEnabled": true,
    "participantInviteEnabled": true,
    "participantReringEnabled": true,
    "lateJoinEnabled": true,
    "raisedHandEnabled": true,
    "screenShareEnabled": true,
    "screenShareSendEnabled": true,
    "screenShareReceiveEnabled": true,
    "screenShareRecordingEnabled": true,
    "extendedReactionsEnabled": true,
    "recordingEnabled": true,
    "audioRecordingEnabled": true,
    "videoRecordingEnabled": true,
    "diagnosticsEnabled": true,
    "autoAnswerEnabled": true,
    "maxConcurrentCalls": 1,
    "maxGroupCalls": 1,
    "maxGroupCallParticipants": 1,
    "maxWaitingParticipants": 1,
    "maxParticipantReringAttempts": 1,
    "participantReringCooldownSeconds": 1,
    "ringTimeoutSeconds": 1,
    "connectTimeoutSeconds": 1,
    "maxCallDurationSeconds": 1
  },
  "activeCalls": {
    "found": 1,
    "terminated": 1,
    "failed": 1
  }
}