ÇAĞRI MERKEZİ API SİSTEMİ | KOBİKOM TELEKOMÜNİKASYON A.Ş

Giriş

Çağrı Merkezi API Sisteminde önceden sizlere verilen API KEY ile bağlantı kurmanız gerekecektir.
API 'yi JSON veya XML formatında görüntüleyebilirsiniz. Default olarak XML çıktı üretir.

            http://[ipadresiniz]/api/?apikey=xxxx-xxxx-xxxx-xxxx-xxxx&type=xml
type parametresinin aldığı değerler 1-) xml 2-) json

Kampanya Eklemek

POST URL:

              http://[ipadresiniz]/api/?apikey=xxxx-xxxx-xxxx-xxxx-xxxx&module=createCampaign
            

REQUEST

              name 		| string | kampanya adı
              start_date 	| date 	 | kampanya başlangıç tarihi
              end_date 	| date 	 | kampanya bitiş tarihi
              start_time 	| time 	 | kampanya başlangıç saati
              end_time 	| time 	 | kampanya bitiş saati
              retries 	| int 	 | kaç defa aranak
              queue 		| int 	 | kuyruk (NOT: kuyruğu eğer bilmiyorsanız 191 olarak gönderiniz.)
            

RESPONSE XML

              <CallCenter>
              <result>true</result>
              <id_campaign>Oluşan Kampanyanın ID</id_campaign>
              <name>Oluşan Kampnayanın Adı</name>
              </CallCenter>
            

RESPONSE JSON

              {
                "result": "true",
                "id_campaign": Oluşan Kampanya ID,
                "name": "Oluşan Kampnaya Adı"
              }
            

Kampanya Silmek

POST URL:

              http://[ipadresiniz]/api/?apikey=xxxx-xxxx-xxxx-xxxx-xxxx&module=deleteCampaign
            

REQUEST

              id_campaign | int | Kampanya ID bilgisi gönderilir.
            

RESPONSE XML

              <CallCenter>
              <result>true</result>
              <message>Kampanya Silindi</message>
              </CallCenter>
            

RESPONSE JSON

              {
                "result": "true",
                "message": "Kampanya Silindi"
              }
            

Kuyrukları Listele

GET URL:

              http://[ipadresiniz]/api/?apikey=xxxx-xxxx-xxxx-xxxx-xxxx&module=listQueue&type=json
            

REQUEST

              module   | int    | listQueue
              type    | string | Şu an için sadece JSON olarak cevap vermektedir
            

RESPONSE JSON

              {
                  "result": "true",
                  "message": [
                      {
                          "extension": "10000",
                          "descr": "OPERATORQ"
                      },
                      {
                          "extension": "10001",
                          "descr": "TEKNIKQ"
                      },
                      {
                          "extension": "10002",
                          "descr": "TESTQ"
                      }
                  ]
              }
            

Kuyruk Eklemek

POST URL:

              http://[ipadresiniz]/api/?apikey=xxxx-xxxx-xxxx-xxxx-xxxx&module=createQueue
            

REQUEST

              account 	| int    | Kuyruk Numarası
              name 		| string | Kuyruk Adı
              password 	| string | Kuyruk Şifresi
              dynmembers 	| array  | Dinamik Agentlar
            

RESPONSE XML

              <CallCenter>
              <result>true</result>
              <message>Kuyruk Eklendi</message>
              </CallCenter>
            

RESPONSE JSON

              {
                "result": "true",
                "message": "Kuyruk Eklendi"
              }
            

Kuyruk Silmek

POST URL:

              http://[ipadresiniz]/api/?apikey=xxxx-xxxx-xxxx-xxxx-xxxx&module=deleteQueue
            

REQUEST

              account 	| int    | Kuyruk Numarası
            

RESPONSE XML

              <CallCenter>
              <result>true</result>
              <message>Kuyruk Silindi</message>
              </CallCenter>
            

RESPONSE JSON

              {
                "result": "true",
                "message": "Kuyruk Silindi"
              }
            

Kuyruktaki Agent Listesi

POST URL:

              http://[ipadresiniz]/api/?apikey=xxxx-xxxx-xxxx-xxxx-xxxx&module=queueAgents
            

REQUEST

              account   | int    | Kuyruk Numarası
            

RESPONSE XML

              <CallCenter>
              <result>true</result>
              <agents>
              <agent>100<agent>
              <agent>101<agent>
              <agent>102<agent>
              <agent>...<agent>
              </agents>
              </CallCenter>
            

RESPONSE JSON

              {
                "result": "true",
                "agents": [
                "0": "100",
                "1": "101",
                "2": "102",
                ...
                ]
              }
            

Agent Girişi

POST URL:

              http://[ipadresiniz]/api/?apikey=xxxx-xxxx-xxxx-xxxx-xxxx&module=loginAgent
            

REQUEST

              agent   | int    | Agent Numarası
            

RESPONSE XML

              <CallCenter>
                  <result>true</result>
                  <message>Giriş yapıldı.</message>
              </CallCenter>
            

RESPONSE JSON

              {
                  "result": "true",
                  "message": "Giriş yapıldı."
              }
            

Agent Çıkışı

POST URL:

              http://[ipadresiniz]/api/?apikey=xxxx-xxxx-xxxx-xxxx-xxxx&module=logoutAgent
            

REQUEST

              agent 	| int    | Agent Numarası
            

RESPONSE XML

              <CallCenter>
                  <result>true</result>
                  <message>Çıkış yapıldı.</message>
              </CallCenter>
            

RESPONSE JSON

               {
                  "result": "true",
                  "message": "Çıkış yapıldı."
              }
            

Kuyruğa Agent Eklemek Silmek

POST URL:

              http://[ipadresiniz]/api/?apikey=xxxx-xxxx-xxxx-xxxx-xxxx&module=agentsQueue
            

REQUEST

              account 	| int    | Kuyruk Numarası
              dynmembers 	| array  | Agent Listesi
              make	 	| boolen | true gönderildiğinde agentler eklenir / false gönderildiğinde agentler silinir.
            

RESPONSE XML

              <CallCenter>
              <result>true</result>
              <message>İşleminiz Gerçekleşti</message>
              </CallCenter>
            

RESPONSE JSON

              {
                "result": "true",
                "message": "İşleminiz Gerçekleşti"
              }
            

Aktif Call Center Çağrıları

POST URL:

              http://[ipadresiniz]/api/?apikey=xxxx-xxxx-xxxx-xxxx-xxxx&module=activeCallsCallCenter
            

REQUEST

            

RESPONSE XML

              <CallCenter>
              <result>true</result>
              <activecalls>
              <activecall>
              <agentnumber> Agent Numarası </agentnumber>
              <fechainicio> Çağrı Durumu </fechainicio>
              <phone> Telefon Numarası </phone>
              </activecall>
              ...
              </activecalls>
              </CallCenter>
            

RESPONSE JSON

              {
                "result": "true",
                "activecalls": [
                "0" : {
                  "agentnumber" : "Agent Numarası",
                  "fechainicio" : "Çağrı Durumu",
                  "phone" : " Telefon Numarası "
                }
                ...
                ]
              }
            

Canlı Yönetimlar

POST URL:

              http://[ipadresiniz]/api/?apikey=xxxx-xxxx-xxxx-xxxx-xxxx&module=activeCalls
            

REQUEST

            

RESPONSE XML

              <CallCenter>
              <result>true</result>
              <calls>
              <call>
              <kanal> Kanal Adı </kanal>
              <kaynak> Kaynak </kaynak>
              <dahili> Dahili </dahili>
              <oncelik> Öncelik </oncelik>
              <yon> Yön </yon>
              <islem> İşlem  </islem>
              <data> Veriler </data>
              <arayan_numara> Telefon Numarası </arayan_numara>
              <sure> Süre </sure>
              </call>
              ...
              </calls>
              </CallCenter>
            

RESPONSE JSON

              {
                "result": "true",
                "activecalls": [
                "0" : {
                  "kanal" : "Kanal Adı",
                  "kaynak" : "Kaynak",
                  "dahili" : " Dahili ",
                  "oncelik" : " Öncelik ",
                  "yon" : " Yön ",
                  "islem" : " İşlem ",
                  "data" : " Veriler ",
                  "arayan_numara" : " Telefon Numarası ",
                  "sure" : " Süre "
                }
                ...
                ]
              }
            

Arama Kayıtları

POST URL:

              http://[ipadresiniz]/api/?apikey=xxxx-xxxx-xxxx-xxxx-xxxx&module=callRecords
            

REQUEST

              orderby  	| string | 'arayan_numara'
              sira  		| string | desc veya asc
              limit  		| int	 | arayan_numara
              baslangic_tarihi  	|	date	| Başlangıç Tarihi
              bitis_tarihi  		|	date	| Bitiş Tarihi
              arayan_adi  		|	string	| Arayan Adı
              arayan_numara  		|	string	| Arayan Numara
              aranan_numara  		|	string	| Aranan Numara
            

RESPONSE XML

              <CallCenter>
              <result>true</result>
              <call_records>
              <call_record>
              <arama_tarihi> Arama Tarihi </arama_tarihi>
              <arayan_adi> Arayan Adı </arayan_adi>
              <arayan_numara> Arayan Numara </arayan_numara>
              <aranan_numara> Aranan Numara </aranan_numara>
              <kaynak> Kaynak </kaynak>
              <kanal> Kanal  </kanal>
              <ic_kanal> İç Kanal </ic_kanal>
              <sonislem> Son İşlem </sonislem>
              <sondata> Son Veriler </sondata>
              <sure> Süre </sure>
              <durum> Durum </durum>
              </call_record>
              ...
              </call_records>
              </CallCenter>
            

RESPONSE JSON

              {
                "result": "true",
                "activecalls": [
                "0" : {
                  "arama_tarihi" : "Arama Adı",
                  "arayan_adi" : "Arayan Adı",
                  "arayan_numara" : "Arayan Numara",
                  "aranan_numara" : "Aranan Numara",
                  "kaynak" : "Kaynak",
                  "kanal" : "Kanal",
                  "ic_kanal" : "İç Kanal",
                  "sonislem" : "Son İşlem",
                  "sondata" : "Son Veri",
                  "sure" : "Süre"
                  "durum" : " Durum "
                }
                ...
                ]
              }
            

SES Kayıtları

POST URL:

              http://[ipadresiniz]/api/?apikey=xxxx-xxxx-xxxx-xxxx-xxxx&module=callRecords
            

REQUEST

              orderby  	| string | 'arayan_numara'
              sira  		| string | desc veya asc
              limit  		| int	 | arayan_numara
              baslangic_tarihi  	|	date	| Başlangıç Tarihi
              bitis_tarihi  		|	date	| Bitiş Tarihi
              arayan_adi  		|	string	| Arayan Adı
              arayan_numara  		|	string	| Arayan Numara
              aranan_numara  		|	string	| Aranan Numara
            

RESPONSE XML

              <CallCenter>
              <result>true</result>
              <call_records>
              <call_record>
              <arama_tarihi> Arama Tarihi </arama_tarihi>
              <arayan_adi> Arayan Adı </arayan_adi>
              <arayan_numara> Arayan Numara </arayan_numara>
              <aranan_numara> Aranan Numara </aranan_numara>
              <kaynak> Kaynak </kaynak>
              <kanal> Kanal  </kanal>
              <ic_kanal> İç Kanal </ic_kanal>
              <sonislem> Son İşlem </sonislem>
              <sondata> Son Veriler </sondata>
              <sure> Süre </sure>
              <durum> Durum </durum>
              <dosya> Dosya </dosya>
              </call_record>
              ...
              </call_records>
              </CallCenter>
            

RESPONSE JSON

              {
                "result": "true",
                "activecalls": [
                "0" : {
                  "arama_tarihi" : "Arama Adı",
                  "arayan_adi" : "Arayan Adı",
                  "arayan_numara" : "Arayan Numara",
                  "aranan_numara" : "Aranan Numara",
                  "kaynak" : "Kaynak",
                  "kanal" : "Kanal",
                  "ic_kanal" : "İç Kanal",
                  "sonislem" : "Son İşlem",
                  "sondata" : "Son Veri",
                  "sure" : "Süre",
                  "durum" : "Durum",
                  "dosya" : "Dosya"
                }
                ...
                ]
              }
            

Çağrı Detayları

POST URL:

              http://[ipadresiniz]/api/?apikey=xxxx-xxxx-xxxx-xxxx-xxxx&module=getCallDetail
            

REQUEST

- boş olarak gönderilebilir.
- "phone" parametresi tek başına gönderilebilir.
- "id_campaign" parametresi tek başına gönderilebilir.
              phone	 	| int    | Telefon Numarası
              id_campaign	| int    | Kampanya ID 'si gönderilir.
            

RESPONSE XML

              <CallCenter>
              <result>true</result>
              <Datas>
              <Data>
              <name> Kampanya Adı </name>
              <phone> Telefon Numarası </phone>
              <status> Durum </status>
              <start_time> Başlama Zamanı </start_time>
              <end_time> Bitiş Zamanı </end_time>
              <duration> Süre </duration>
              <failure_cause> Başarısız ID </failure_cause>
              <failure_cause_txt> Başarısız olma sebebi metni </failure_cause_txt>
              <agent_number> Agent Numarası </agent_number>
              <agent_name> Agent Adı </agent_name>
              </Data>
              ...
              </Datas>
              </CallCenter>
            

RESPONSE JSON

              {
                "result": "true",
                "data": [
                0 : {
                  "name" : "Kampanya Adı",
                  "phone" : "Telefon Numarası",
                  "status" : "Durum",
                  "start_time" : "Başlama Zamanı",
                  "end_time" : "Bitiş Zamanı",
                  "duration" : "Süre",
                  "failure_cause" : "Başarısız ID",
                  "failure_cause_txt" : "Başarısız olma sebebi metni",
                  "agent_number" : "Agent Numarası",
                  "agent_name" : "Agent Adı",
                },
                ....
                ]
              }
            

Kampanyaya Telefon Eklemek

POST URL:

              http://[ipadresiniz]/api/?apikey=xxxx-xxxx-xxxx-xxxx-xxxx&module=campaignAddPhone
            

REQUEST

              name	 	| string | Kişi Adı
              surname	 	| string | Kişi Soyadı
              phone	 	| int    | Telefon Numarası
              id_campaign	| int    | Kampanya ID 'si gönderilir.
            

RESPONSE XML

              <CallCenter>
              <result>true</result>
              <message>Kampanyaya Yeni Telefon Eklendi</message>
              </CallCenter>
            

RESPONSE JSON

              {
                "result": "true",
                "message": "Kampanyaya Yeni Telefon Eklendi"
              }
            

Kampanyadan Telefon Silmek

POST URL:

              http://[ipadresiniz]/api/?apikey=xxxx-xxxx-xxxx-xxxx-xxxx&module=campaignDeletePhone
            

REQUEST

              id_campaign	| int    | Kampanya ID 'si gönderilir.
              phone	 	| int    | Telefon Numarası
            

RESPONSE XML

              <CallCenter>
              <result>true</result>
              <message>Kampanyadan Telefon Silindi</message>
              </CallCenter>
            

RESPONSE JSON

              {
                "result": "true",
                "message": "Kampanyadan Telefon Silindi"
              }
            

Mola Başlatmak

GET URL:

              http://[ipadresiniz]/api/?apikey=xxxx-xxxx-xxxx-xxxx-xxxx&module=breakList
            

REQUEST

              tip | string    | xml veya json
            

RESPONSE XML

              <CallCenter>
                  <result>true</result>
                  <break>
                      <id>2</id>
                      <name>YEMEK MOLASI</name>
                  </break>
                  <break>
                      <id>3</id>
                      <name>CAY SIGARA MOLASI</name>
                  </break>
                  <break>
                      <id>4</id>
                      <name>DIS ARAMA</name>
                  </break>
              </CallCenter>
            

RESPONSE JSON

              [
                  {
                      "id": "2",
                      "name": "YEMEK MOLASI"
                  },
                  {
                      "id": "3",
                      "name": "CAY SIGARA MOLASI"
                  },
                  {
                      "id": "4",
                      "name": "DIS ARAMA"
                  }
              ]
            

Mola Başlatmak

POST URL:

              http://[ipadresiniz]/api/?apikey=xxxx-xxxx-xxxx-xxxx-xxxx&module=breakStart
            

REQUEST

              agent   | int    | agent numarası gönderilir
              breakId	| int    | mola numarası gönderilir
            

RESPONSE XML

              <CallCenter>
              <result>true</result>
              <message>Mola Başladı</message>
              </CallCenter>
            

RESPONSE JSON

              {
                "result": "true",
                "message": "Mola Başladı"
              }
            

Mola Bitirmek

POST URL:

              http://[ipadresiniz]/api/?apikey=xxxx-xxxx-xxxx-xxxx-xxxx&module=breakEnd
            

REQUEST

              agent	| int    | agent numarası gönderilir
            

RESPONSE XML

              <CallCenter>
              <result>true</result>
              <break>
              <agent> 1000 </agent>
              <starttime> 2017-06-01 10:00:00 </starttime>
              <endtime> 2017-06-01 10:00:08 </endtime>
              <duration> 8 </duration>
              </break>
              </CallCenter>
            

RESPONSE JSON

              {
                "result": "true",
                "message": "Mola Başladı"
              }
            

Çağrı Başlatmak

POST URL:

              http://[ipadresiniz]/api/?apikey=xxxx-xxxx-xxxx-xxxx-xxxx&module=dial
            

REQUEST

              extension	| int    | dahili gönderilir
              number		| int    | aranacak numara gönderilir.
            

RESPONSE XML

              <CallCenter>
              <result>true</result>
              <message>Arama Başladı</message>
              </CallCenter>
            

RESPONSE JSON

              {
                "result": "true",
                "message": "Arama Başladı"
              }
            

Çağrı Transferi

POST URL:

              http://[ipadresiniz]/api/?apikey=xxxx-xxxx-xxxx-xxxx-xxxx&module=redirect
            

REQUEST

              from      | int    | hangi dahiliden
              extension | int    | hangi dahiliye
            

RESPONSE XML

              <CallCenter>
              <result>true</result>
              <message>Çağrı Yönlendirildi</message>
              <extension>DAHİLİ_NO</extension>
              </CallCenter>
            

RESPONSE JSON

              {
                "result": "true",
                "message": "Çağrı Yönlendirildi",
                "extension": DAHİLİ_NO
              }
            

Çağrı Sonlandırmak

POST URL:

              http://[ipadresiniz]/api/?apikey=xxxx-xxxx-xxxx-xxxx-xxxx&module=hangup
            

REQUEST

              extension	| int    | dahili gönderilir
            

RESPONSE XML

              <CallCenter>
              <result>true</result>
              <message>Çağrı Sonlandırıldı</message>
              </CallCenter>
            

RESPONSE JSON

              {
                "result": "true",
                "message": "Çağrı Sonlandırıldı"
              }
            

Canlı Yönetim (WebSocket)

WEBSOCKET URL:


              ws://93.186.116.95:8088
              wss://93.186.116.95:8098
            

LOGIN


              {
                "command":"login",
                "username":"KULLANICIADINIZ",
                "password":"APIKEYiniz",
                "crm_id":"11111"
              }
            

RESPONSE JSON


              {
                "success": "1",
                "succesDesc": "Login başarılı."
              }
            

ÇAĞRI GELDİĞİ ZAMAN


              {
                "type":"ringing","caller":"128","called":"121","uniqueid":"1541419143.9568"
              }

              {
                "type":"incoming","caller":"128","called":"121","uniqueid":"1541419143.9568","recording":"1541419143.9567"
              }

              {
                "type":"outgoing","caller":"129","called":"02245320444","uniqueid":"1541418914.9537","recording":"1541418915.9538"
              }

              {
                "type":"hangup","uniqueid":"1541419143.9568"
              }
            

ÇAĞRI BAŞLATMA


              {
                 "command"         : "originate",
                 "customer_num"    : "902245320444",
                 "pbx_num"         : "902245320444",
                 "internal_num"    : "1001",
                 "ring_timeout"    : "30000",
                 "crm_id"          : "203577",
                 "wait_response"   : "15000",
                 "originate_order" : "of",
                "manual_answer"   : "0",
                "trunk"           : "kobikom"
              }
            

ÇAĞRI YÖNLENDİRME


              {
                "command":"redirect",
                "exten":"1001",
                "unique_id":"1520317155.59",
                "crm_id":"203577"
              }
            

ÇAĞRI KAPATMA


              {
                "command":"hangup",
                "unique_id":"1520317155.59",
                "crm_id":"203577"
              }
            

DAHİLİ DURUMLARI


              {
                "type":"ExtensionStatus",
                "extension":"1001",
                "status":"0"
              }

              Status:
                -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ĞRI MERKEZİ API SİSTEMİ