Web Socket API Dökümanı

Bağlantı Kurma

SSL ile kullanım için wss://api.kobikom.com.tr:8098
TLS ile kullanım için ws://api.kobikom.com.tr:8088
Adreslerine websocket bağlantısı açılır.

Açılan bağlantı üzerinden login olmak için JSON formatında olan aşağıdaki istek gönderilir.

password” alanındaki API anahtarınızı https://panel.kobikom.com.tr adresindeki panelinize giriş yaparak sol altta yer alan Api Entegrasyonları > Web Socket adımlarını izleyerek bulabilirsiniz.

1
2
3
4
{
   "command":"login",
   "password":"D75BC-21B9C-66075-2504F-FBE28"
}

Gelen Verilerin Anlamları

Gelecek olaylar ve hangi durumlarda gelecekleri:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
// Bir dahili çalarken
{
    "type":"ringing",
    "caller":"128",
    "called":"121",
    "uniqueid":"1541419143.9568"
}

// Dahili çağrıyı cevapladığında
{
    "type":"incoming",
    "caller":"128",
    "called":"121",
    "uniqueid":"1541419143.9568",
    "recording":"1541419143.9567"
}

// Dahili bir arama başlattığında
{
    "type":"outgoing",
    "caller":"129",
    "called":"02245320444",
    "uniqueid":"1541418914.9537",
    "recording":"1541418915.9538"
}

// Çağrı kapandığında
{
    "type":"hangup",
    "uniqueid":"1541419143.9568"
}

// Bir dahilinin durumu değiştiğinde
{
    "type":"ExtensionStatus",
    "extension":"151",
    "status":"1"
}

// Kuyrukta bulunan dahililer (İlk bağlantı açıldığında gelir)
{
    "type":"QueueStatus",
    "event":"QueueMember",
    "queue":"20006",
    "extension":"1001",
    "location":"Local/1001@from-queue/n",
    "membership":"static",
    "callstaken":"0",
    "lastcall":"0",
    "status":"5",
    "paused":"0"
}

Olaylarda yer alan değişkenlerin anlamları:

ExtensionStatus Olayı:
Status değişkeninin alabileceği değerler:
-1 = Dahili Bulunamadı
0 = Boşta Hazır
1 = Kullanımda
2 = Meşgul
4 = Bağlı Değil
8 = Çalıyor
16 = Beklemede

Çağrı Başlatma

1
2
3
4
5
6
7
8
9
10
{
  "command"         : "originate",
  "customer_num"    : "02245320444",
  "pbx_num"         : "02245320444",
  "internal_num"    : "1001",
  "ring_timeout"    : "30000",
  "crm_id"          : "203577",
  "wait_response"   : "15000",
  "trunk"           : "kobikom"
}

Çağrı Yönlendirme

1
2
3
4
5
6
{
  "command":"redirect",
  "exten":"1001",
  "unique_id":"1520317155.59",
  "crm_id":"203577"
}

Çağrı Sonlandırma

1
2
3
4
5
{
  "command":"hangup",
  "unique_id":"1520317155.59",
  "crm_id":"203577"
}