🛠️ Questa documentazione è ancora in fase di elaborazione, vi preghiamo di segnalare eventuali problemi. 🔗
Zammad Hub

Italiano

English
Deutsch
српски

Italiano

English
Deutsch
српски

Appearance

CTI generico ​

Introduzione ​

Questa pagina descrive gli ambiti e le funzionalità generiche dell'API CTI.

WARNING

  • L'autenticazione su questo endpoint funziona in modo fondamentalmente diverso rispetto al resto.

Funzionalità ​

Ecco un piccolo elenco condensato delle possibilità che questa API CTI fornisce.

In entrata ​

  • Funzioni del registro chiamante per i tuoi agenti.
  • Blocco degli ID chiamante durante la segnalazione.

In uscita ​

  • Funzioni del registro chiamante per i tuoi agenti.
  • Imposta gli ID chiamante in uscita a seconda dell'ID chiamante di destinazione.

Endpoint ​

L'endpoint si trova nell'integrazione CTI generica e contiene un token univoco che.

INFO

La configurazione CTI generica e l'endpoint corretto si trovano nel tuo Zammad nell'amministrazione.

TIP

Ci sono due opzioni su come inviare con POST i dati rilevanti a Zammad:

  • JSON (consigliato)
  • F

Eventi ​

Ci sono diversi eventi in termini di una chiamata in corso. Queste azioni provengono sempre dal tuo.

  • Evento "newCall" (inizio di una chiamata)
  • Evento "hangup" (fine chiamata)
  • Evento "answer" (ovvero rispondere al telefono)

In alcune situazioni Zammad potrebbe fornire una risposta sulle tue chiamate PBX (ad esempio un rifiuto) se blocchi.

Esempi usati ​

Esempio: Le chiamate seguenti sono state inviate con la seguente configurazione. Questo è importante.

In uscita:

  • ID chiamante destinazione 4989* imposta ID chiamante in uscita 498999998145 con nota "Tutto da mu
  • ID chiamante destinazione 4930* imposta ID chiamante in uscita 493023125877 "Tutto da Berlino"

Altre impostazioni:

  • ID chiamante predefinito per chiamate in uscita 496990009111

Evento nuova chiamata ​

Generale ​

attributes disponibili e dati di esempio:

event newCall
Dice a Zammad che c'è una nuova chiamata.
from 4930555716000
Numero che ha avviato la chiamata. Può essere.
to 4930555716000
Numero che viene chiamato.
direction in
La direzione della chiamata. Se il tuo agente avvia.
callId 53ba82e2bd6d12d9fb2d3838f0cfb070
Un ID univoco.
user John Doe
Il nome reale dell'utente coinvolto. Potresti avere.
queue support
Un nome di coda opzionale, questa opzione è rilevante.

In uscita ​

Details

POST-Request sent: https://{FQDN-Zammad}/api/v1/cti/{instance specific token}

Payload:

json
{
  "event": "newCall",
  "from": "493023125741",
  "to": "492214710334",
  "direction": "out",
  "callId": "f4ebd2be-7b9a-4d58-94c2-eb06a3c2ce76",
  "user": "Lauren Brooks"
}

Response:

json
{
  "action": "dial",
  "caller_id": "496990009111",
  "number": "492214710334"
}

Sample curl command:

sh
curl --request POST 'https://{FQDN-Zammad}/api/v1/cti/{instance specific token}' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "event": "newCall",
    "from": "493023125741",
    "to": "492214710334",
    "direction": "out",
    "callId": "f4ebd2be-7b9a-4d58-94c2-eb06a3c2ce76",
    "user": "Lauren Brooks"
  }'

In entrata ​

Details

Payload:

json
{
  "event": "newCall",
  "from": "493023125741",
  "to": "492214710334",
  "direction": "in",
  "callId": "307fa962-de8d-4ffc-817b-7f6993204159",
  "user": [
    "Lauren Brooks",
    "Ethan Kwan"
  ]
}

Response:

json
{}

Sample curl command:

sh
curl --request POST 'https://{FQDN-Zammad}/api/v1/cti/{instance specific token}' \
  --header 'Content-Type: application/json' \
  --data-raw '{
     "event": "newCall",
     "from": "493023125741",
     "to": "492214710334",
     "direction": "in",
     "callId": "307fa962-de8d-4ffc-817b-7f6993204159",
     "user": ["Lauren Brooks", "Ethan Kwan"]
  }'

Risposte specifiche per situazione ​

A seconda della direzione di chiamata scelta, Zammad restituirà un (opzionalmente) configurato.

INFO

Questo deve essere supportato dal tuo PBX per funzionare.

Rifiuta ID chiamante bloccati ​

Se una nuova chiamata in entrata corrisponde a un numero da bloccare, Zammad restituirà quanto segue.

json
{
  "action": "reject",
  "reason": "busy"
}

Se nessun numero da bloccare corrisponde, Zammad restituirà quanto segue.

json
{}

WARNING

Il tuo PBX deve comunque terminare la chiamata (evento hangup). Altrimenti la chiamata non apparirà semplicemente.

Imposta ID chiamante in uscita specifico ​

Nel caso la tua istanza abbia un ID chiamante di sovrascrittura corrispondente configurato, Zammad restituirà.

json
{
  "action": "dial",
  "callerId": "493055571642",
  "number": "491711234567890"
}

Se non viene trovata nessuna corrispondenza di sovrascrittura o non hai configurato nulla, Zammad restituirà.

json
{}

Evento risposta chiamata ​

Generale ​

attributes disponibili e dati di esempio:

event answer:
Dice a Zammad che qualcuno ha risposto alla chiamata.
from 493055571600:
Numero che ha avviato la chiamata.
to 493055571600:
Numero che viene chiamato.
direction in:
La direzione della chiamata - se il tuo agente avvia.
callId 53ba82e2bd6d12d9fb2d3838f0cfb070:
Un ID univoco.
answeringNumber 493055571600:
Zammad cercherà un.
user John Doe:
Il nome reale dell'utente coinvolto. Potresti avere.

Ci sono due opzioni su come inviare con POST i dati rilevanti a Zammad.

In uscita ​

Details

POST-Request sent: https://{FQDN-Zammad}/api/v1/cti/{instance specific token}

Payload:

json
{
  "event": "answer",
  "from": "493023125741",
  "to": "492214710334",
  "direction": "out",
  "callId": "9f1840cb-8be9-4d3a-8200-3da2937085f0",
  "caller": "Lauren Brooks"
}

Response:

json
{}

Sample curl command:

sh
curl --request POST 'https://{FQDN-Zammad}/api/v1/cti/{instance specific token}' \
  --header 'Content-Type: application/json' \
  --data-raw '{
     "event": "answer",
     "from": "493023125741",
     "to": "492214710334",
     "direction": "out",
     "callId": "9f1840cb-8be9-4d3a-8200-3da2937085f0",
     "caller": "Lauren Brooks"
  }'

In entrata ​

Details

Payload:

json
{
  "event": "answer",
  "from": "493023125741",
  "to": "492214710334",
  "direction": "in",
  "callId": "307fa962-de8d-4ffc-817b-7f6993204159",
  "answeringNumber": "emily@fastlane.inc",
  "caller": [
    "Lauren Brooks",
    "Emily Tran"
  ]
}

Response:

json
{}

Sample curl command:

sh
curl --request POST 'https://{FQDN-Zammad}/api/v1/cti/{instance specific token}' \
  --header 'Content-Type: application/json' \
  --data-raw '{
     "event": "answer",
     "from": "493023125741",
     "to": "492214710334",
     "direction": "in",
     "callId": "307fa962-de8d-4ffc-817b-7f6993204159",
     "answeringNumber": "emily@fastlane.inc",
     "caller": ["Lauren Brooks", "Emily Tran"]
  }'

Fine chiamata ​

Generale ​

event hangup:
Dice a Zammad che qualcuno ha risposto alla chiamata.
from 493055571600:
Numero che ha avviato la chiamata.
to 493055571600:
Numero che viene chiamato.
direction in:
La direzione della chiamata - se il tuo agente avvia.
callId 53ba82e2bd6d12d9fb2d3838f0cfb070:
Un ID univoco.
cause
Definisce il motivo della fine chiamata. Zammad valuta la causa e indica.
answeringNumber 493055571600:
Zammad cercherà un.

In uscita ​

Details

POST-Request send: https://{FQDN-Zammad}/api/v1/cti/{instance specific token}

Payload:

json
{
  "event": "hangup",
  "from": "493023125741",
  "to": "492214710334",
  "direction": "out",
  "callId": "f4ebd2be-7b9a-4d58-94c2-eb06a3c2ce76",
  "cause": "cancel"
}

Response:

json
{}

Sample curl command:

sh
curl --request POST 'https://{FQDN-Zammad}/api/v1/cti/{instance specific token}' \
  --header 'Content-Type: application/json' \
  --data-raw '{
     "event": "hangup",
     "from": "493023125741",
     "to": "492214710334",
     "direction": "out",
     "callId": "f4ebd2be-7b9a-4d58-94c2-eb06a3c2ce76",
     "cause": "cancel"
  }'

In entrata ​

Details

Payload:

json
{
  "event": "hangup",
  "from": "493023125741",
  "to": "492214710334",
  "direction": "in",
  "callId": "2d77882f-68df-40f0-8c62-b642589c00bc",
  "answeringNumber": "emily@fastlane.inc",
  "cause": "normalClearing"
}

Response:

json
{}

Sample curl command:

sh
curl --request POST 'https://{FQDN-Zammad}/api/v1/cti/{instance specific token}' \
  --header 'Content-Type: application/json' \
  --data-raw '{
     "event": "hangup",
     "from": "493023125741",
     "to": "492214710334",
     "direction": "in",
     "callId": "307fa962-de8d-4ffc-817b-7f6993204159",
     "answeringNumber": "emily@fastlane.inc",
     "cause": "normalClearing"
  }'