Çağrı Merkezi Api Dökümanı

Ç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.

1
2
3
4
5
 http://[ipadresiniz]/api/?apikey=xxxx-xxxx-xxxx-xxxx-xxxx&type=xml

type parametresinin aldığı değerler
 1-) xml
 2-) json


Kampanya Eklemek

POST URL:

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

REQUEST

1
2
3
4
5
6
7
8
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

1
2
3
4
5
<CallCenter>
<result>true</result>
<id_campaign>Oluşan Kampanyanın ID</id_campaign>
<name>Oluşan Kampnayanın Adı</name>
</CallCenter>

RESPONSE JSON

1
2
3
4
5
{
    "result": "true",
    "id_campaign": Oluşan Kampanya ID,
    "name": "Oluşan Kampnaya Adı"
}


Kampanya Silmek

POST URL:

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

REQUEST

1
id_campaign | int | Kampanya ID bilgisi gönderilir.

RESPONSE XML

1
2
3
4
<CallCenter>
<result>true</result>
<message>Kampanya Silindi</message>
</CallCenter>

RESPONSE JSON

1
2
3
4
{
"result": "true",
"message": "Kampanya Silindi"
}


Kuyrukları Listele

GET URL:

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

REQUEST

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

RESPONSE JSON

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
   "result": "true",
        "message": [
          {
             "extension": "10000",
             "descr": "OPERATORQ"
          },
          {
              "extension": "10001",
              "descr": "TEKNIKQ"
          },
          {
              "extension": "10002",
              "descr": "TESTQ"
           }
         ]
}


Kuyruk Eklemek

POST URL:

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

REQUEST

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

RESPONSE XML

1
2
3
4
<CallCenter>
  <result>true</result>
  <message>Kuyruk Eklendi</message>
</CallCenter>

RESPONSE JSON

1
2
3
4
{
   "result": "true",
   "message": "Kuyruk Eklendi"
}


Kuyruk Silmek

POST URL:

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

REQUEST

1
account     | int    | Kuyruk Numarası

RESPONSE XML

1
2
3
4
<CallCenter>
  <result>true</result>
  <message>Kuyruk Silindi</message>
</CallCenter>

RESPONSE JSON

1
2
3
4
{
  "result": "true",
  "message": "Kuyruk Silindi"
}


Kuyruktaki Agent Listesi

POST URL:

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

REQUEST

1
account   | int    | Kuyruk Numarası

RESPONSE XML

1
2
3
4
5
6
7
8
9
<CallCenter>
  <result>true</result>
  <agents>
    <agent>100<agent>
    <agent>101<agent>
    <agent>102<agent>
    <agent>...<agent>
  </agents>
</CallCenter>

RESPONSE JSON

1
2
3
4
5
6
7
8
9
{
   "result": "true",
   "agents": [
   "0": "100",
   "1": "101",
   "2": "102",
    ...
    ]
}


Agent Girişi

POST URL:

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

REQUEST

1
agent   | int    | Agent Numarası

RESPONSE XML

1
2
3
4
<CallCenter>
  <result>true</result>
  <message>Giriş yapıldı.</message>
</CallCenter>

RESPONSE JSON

1
2
3
4
{
   "result": "true",
   "message": "Giriş yapıldı."
}


Agent Çıkışı

POST URL:

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

REQUEST

1
agent   | int    | Agent Numarası

RESPONSE XML

1
2
3
4
<CallCenter>
   <result>true</result>
   <message>Çıkış yapıldı.</message>
</CallCenter>

RESPONSE JSON

1
2
3
4
{
  "result": "true",
  "message": "Çıkış yapıldı."
}


Kuyruğa Agent Eklemek Silmek

POST URL:

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

REQUEST

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

RESPONSE XML

1
2
3
4
<CallCenter>
  <result>true</result>
  <message>İşleminiz Gerçekleşti</message>
</CallCenter>

RESPONSE JSON

1
2
3
4
{
  "result": "true",
  "message": "İşleminiz Gerçekleşti"
}


Aktif Call Center Çağrıları

POST URL:

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

RESPONSE XML

1
2
3
4
5
6
7
8
9
<CallCenter>
  <result>true</result>
  <activecalls>
  <activecall>
  <agentnumber> Agent Numarası </agentnumber>
  <fechainicio> Çağrı Durumu </fechainicio>
  <phone> Telefon Numarası </phone>
  <activecall>...</activecalls>
</CallCenter>

RESPONSE JSON

1
2
3
4
5
6
7
8
9
10
11
{
  "result": "true",
  "activecalls": [
  "0" : {
     "agentnumber" : "Agent Numarası",
     "fechainicio" : "Çağrı Durumu",
     "phone" : " Telefon Numarası "
         }
        ...
   ]
}


Canlı Yönetimler

POST URL:

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

RESPONSE XML

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
<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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
  "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:

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

REQUEST

1
2
3
4
5
6
7
8
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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
<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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
  "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:

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

REQUEST

1
2
3
4
5
6
7
8
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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
<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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
  "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:

1
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.

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

RESPONSE XML

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
<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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
 {
    "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:

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

REQUEST

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

RESPONSE XML

1
2
3
4
<CallCenter>
  <result>true</result>
  <message>Kampanyaya Yeni Telefon Eklendi</message>
</CallCenter>

RESPONSE JSON

1
2
3
4
{
   "result": "true",
   "message": "Kampanyaya Yeni Telefon Eklendi"
}


Kampanyadan Telefon Silmek

POST URL:

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

REQUEST

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

RESPONSE XML

1
2
3
4
<CallCenter>
  <result>true</result>
  <message>Kampanyadan Telefon Silindi</message>
</CallCenter>

RESPONSE JSON

1
2
3
4
{
  "result": "true",
  "message": "Kampanyadan Telefon Silindi"
}


Mola Listelemek

GET URL:

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

REQUEST

1
tip | string    | xml veya json

RESPONSE XML

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
[
   {
      "id": "2",
      "name": "YEMEK MOLASI"
   },
   {
      "id": "3",
      "name": "CAY SIGARA MOLASI"
   },
   {
      "id": "4",
      "name": "DIS ARAMA"
   }
]


Mola Başlatmak

POST URL:

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

REQUEST

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

RESPONSE XML

1
2
3
4
<CallCenter>
  <result>true</result>
  <message>Mola Başladı</message>
</CallCenter>

RESPONSE JSON

1
2
3
4
{
  "result": "true",
  "message": "Mola Başladı"
}


Mola Bitirmek

POST URL:

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

REQUEST

1
agent   | int    | agent numarası gönderilir

RESPONSE XML

1
2
3
4
5
6
7
8
9
<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

1
2
3
4
{
  "result": "true",
  "message": "Mola Başladı"
}


Çağrı Başlatmak

POST URL:

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

REQUEST

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

RESPONSE XML

1
2
3
4
<CallCenter>
  <result>true</result>
  <message>Arama Başladı</message>
</CallCenter>

RESPONSE JSON

1
2
3
4
{
  "result": "true",
  "message": "Arama Başladı"
}


Çağrı Transferi

POST URL:

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

REQUEST

1
2
from      | int    | hangi dahiliden
extension | int    | hangi dahiliye

RESPONSE XML

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

RESPONSE JSON

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


Çağrı Sonlandırmak

POST URL:

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

REQUEST

1
extension   | int    | dahili gönderilir

RESPONSE XML

1
2
3
4
<CallCenter>
  <result>true</result>
  <message>Çağrı Sonlandırıldı</message>
</CallCenter>

RESPONSE JSON

1
2
3
4
{
   "result": "true",
   "message": "Çağrı Sonlandırıldı"
}