Skip to main content

GET /v1/switches

Restituisce l’elenco di tutti gli switch manuali configurati sul tuo centralino, con il relativo stato (attivo/disattivo).
Uno switch manuale è un interruttore on/off che modifica il comportamento del centralino. Quando è attivo (status: 1), il centralino esegue l’azione configurata (es. terminare la chiamata, attivare un IVR, deviare a una coda).

Richiesta

curl -X GET https://api.mycentralino.com/v1/switches \
  -H "X-API-KEY: sk_mycentralino_your_api_key"

Risposta

{
  "success": true,
  "data": [
    {
      "id": 348,
      "description": "Chiusura Temporanea",
      "activation": "*11",
      "action": {
        "type": "hangup",
        "target": null,
        "label": "Termina la chiamata"
      },
      "status": 0,
      "active": false
    },
    {
      "id": 620,
      "description": "Deviazione Notturna",
      "activation": "*12",
      "action": {
        "type": "ivr",
        "target": "Benvenuto",
        "label": "Attiva IVR"
      },
      "status": 1,
      "active": true
    }
  ],
  "count": 2,
  "summary": {
    "total": 2,
    "active": 1,
    "inactive": 1
  }
}

Campi Risposta

CampoTipoDescrizione
idintID univoco dello switch
descriptionstringNome/descrizione dello switch
activationstring | nullCodice stella per attivarlo da interno (*10*19), null se non assegnato
actionobjectAzione eseguita quando lo switch è attivo
statusint1 attivo, 0 disattivo
activebooltrue se lo switch è attivo

Oggetto action

CampoTipoDescrizione
typestringTipo di azione (vedi tabella sotto)
targetstring | nullDestinazione dell’azione (es. nome IVR o coda)
labelstringEtichetta leggibile dell’azione

Valori action.type

ValoreEtichetta
hangupTermina la chiamata
ivrAttiva IVR
queueCoda di ricezione
internalserviceServizio interno
squillaChiama interno
voicemailCasella vocale
callforwardingInoltro a numero
confbridgeConferenza audio
disaChiamata diretta (DISA)

Note

  • Usa summary per un conteggio rapido di switch attivi/disattivi.
  • Per attivare o disattivare uno switch vedi Attiva/Disattiva Switch.