Yerleşik santral API'si

O an santralden geçen canlı çağrıları listeler. Web panelinizde arayan numaraya göre müşteri bilgisi getirmek için kullanışlıdır.

https://{site-adiniz}/?username={kullanıcı}&password={api_şifresi}&action=activecalls

[
  {
    "success": true,
    "count": 1,
    "data": [
      {
        "channel": "SIP/trunk-sip-Trunk110-36a9b",
        "duration": "00:01:14",
        "calltype": "Kuyruk(630)",
        "callinfo": "Konuşuyor",
        "src": "9053xxxxxxxxx",
        "dst": "110"
      }
    ]
  }
]

channel

Çağrının ayırt edici kimliği; ses kaydı indirmede kullanılır.

duration

Çağrı süresi.

calltype

Çağrı tipi (ör. kuyruk numarası).

callinfo

Çağrı durumu (ör. "Konuşuyor").

src

Arayan numara.

dst

Aranan numara / dahili.

JSONObject := TJsonObject.Create;
try
  JSONObject.Parse(TEncoding.UTF8.GetBytes(
    NetHTTP.Get('https://{site-adiniz}/?username=Kullanıcı&password=Şifre&action=activecalls').ContentAsString), 1);
  if StrToInt(JSONObject.GetValue('count').Value) <> 0 then
  begin
    VeriArray := JSONObject.GetValue('data') as TJSONArray;
    for don := 0 to VeriArray.Count - 1 do
    begin
      Veriler := TJsonObject.Create;
      try
        Veriler.Parse(TEncoding.UTF8.GetBytes(VeriArray.Items[don].ToString), 0);
        Memo.Lines.Add(Veriler.GetValue('channel').Value);
        Memo.Lines.Add(Veriler.GetValue('src').Value);
        Memo.Lines.Add(Veriler.GetValue('dst').Value);
      finally Veriler.Free; end;
    end;
  end;
finally JSONObject.Free; end;

const yanit = await fetch('https://{site-adiniz}/?username=Kullanıcı&password=Şifre&action=activecalls')
const rjson = await yanit.json()
if (rjson.success) {
  for (const c of rjson.data) {
    console.log('channel:', c.channel)
    console.log('src:', c.src, '→ dst:', c.dst, '(' + c.callinfo + ')')
  }
}

using Newtonsoft.Json.Linq;

var json = new HttpClient().GetStringAsync(
    "https://{site-adiniz}/?username=Kullanıcı&password=Şifre&action=activecalls").Result;
var obj = JObject.Parse(json);
if (obj.SelectToken("success").Value<bool>())
    foreach (var c in obj["data"])
        Console.WriteLine($"{c["src"]} → {c["dst"]} ({c["callinfo"]})");

İki tarih arasındaki çağrı kayıtlarını (CDR) döndürür. Numaraya göre süzebilir, IVR/görüştürme uçlarından taşınan veriyi uf=yes ile isteyebilirsiniz.

https://{site-adiniz}/?username={kullanıcı}&password={api_şifresi}&action=cdr&date1={ddMMyyyyHHmm}&date2={ddMMyyyyHHmm}&number=&uf=yes

{
  "success": true,
  "count": 2,
  "data": [
    {
      "id": "28699",
      "calldate": "03.09.2019 12:30:38",
      "calltype": "incoming",
      "src": "90507XXXXXXX",
      "dst": "101",
      "duration": "85,69",
      "disposition": "ANSWERED",
      "queue": "",
      "record": true,
      "userfield": "Gelen bilgi"
    }
  ]
}

id

Kaydın kimliği; ses dosyası indirmede kullanılır.

calldate

Tarih ve saat.

calltype

incoming / outcoming.

src · dst

Arayan ve aranan.

duration

Çağrı süresi (sn).

disposition

Sonuç: ANSWERED, BUSY, NO ANSWER…

queue

Varsa kuyruk numarası.

record

Ses kaydı var mı (true/false).

userfield

Taşınan serbest bilgi.

Dahilileri ve register (bağlı) olma durumlarını listeler.

https://{site-adiniz}/?username={kullanıcı}&password={api_şifresi}&action=users

{
  "success": true,
  "count": 2,
  "data": [
    { "username": "100", "name": "Mehmet", "regstatus": "OK (93 ms)" },
    { "username": "101", "name": "Satış",  "regstatus": "OK (109 ms)" }
  ]
}

username

Dahili numarası.

name

Dahili kullanıcı adı.

regstatus

Register durumu ve yanıt süresi.

Çağrı kuyruklarını ve her kuyruğa bağlı dahilileri listeler.

https://{site-adiniz}/?username={kullanıcı}&password={api_şifresi}&action=queues

{
  "success": true,
  "count": 2,
  "data": [
    { "queuenumber": "630", "name": "Muhasebe", "internal": "100,101,102" },
    { "queuenumber": "632", "name": "Satış",    "internal": "105,106" }
  ]
}

queuenumber

Kuyruk numarası.

name

Kuyruk adı.

internal

Kuyruğa bağlı dahililer (virgülle).

Santralde kayıtlı rehberin tamamını XML olarak döndürür (IP telefon rehberi biçimi).

https://{site-adiniz}/?username={kullanıcı}&password={api_şifresi}&action=phonedirectory

<?xml version="1.0" encoding="UTF-8" ?>
<iexIPPhoneDirectory>
  <DirectoryEntry>
    <Name>Fiber Santral</Name>
    <Telephone>908502590259</Telephone>
  </DirectoryEntry>
</iexIPPhoneDirectory>

Çağrı detaylarındaki id (ya da chanid) ile çağrının ses dosyasını .gsm biçiminde indirir.

https://{site-adiniz}/?username={kullanıcı}&password={api_şifresi}&action=record&id={cdr_id}

id yerine chanid parametresi de kullanılabilir.

Önce verilen dahiliyi çaldırır, dahili açınca hedef numarayı arar (trunk araması).

https://{site-adiniz}/?username={kullanıcı}&password={api_şifresi}&action=callnumber&number={telefon}&internal={dahili}

Bir numarayı arayıp seçtiğiniz robot/anons planını çalar. file içinde süslü parantezli metin sese çevrilir; | sonrası santraldeki hazır ses dosyasının adıdır.

https://{site-adiniz}/?username={kullanıcı}&password={api_şifresi}&action=callivr&number={telefon}&dp={arama_planı}&dest={robot_no}&uf={taşınacak_veri}&file={merhaba,Mehmet%20bey}|SES1|SES2

procedure baslat;
begin
  Read(tuslama, '${XPLAY}', 3, 5);
  API(sonuc, 'https://uygulamaniz.com/api/sms.php?tuslama=${tuslama}&id=${MSTUF}');
  PlayBack('tesekkurler');
  Hangup;
end;

${XPLAY}

İstekteki file sesini okur.

${MSTUF}

İstekteki uf verisini çeker.

Tüm script komutları (Read, PlayBack, Dial, API…) ve örnekleri: IVR script dokümanı.

İki numarayı, birbirinin numarasını görmeden santral üzerinden konuşturur.

https://{site-adiniz}/?username={kullanıcı}&password={api_şifresi}&action=callback&number1={telefon1}&number2={telefon2}&dp={arama_planı}&uf={taşınacak_veri}

Devam eden bir çağrıyı kanal kimliğiyle kapatır. Kanalı aktif aramalar ya da çağrı detayları ucundan alırsınız.

https://{site-adiniz}/?username={kullanıcı}&password={api_şifresi}&action=hangupcall&channel={kanal}

Santralden geçen çağrıların bilgisini kendi uygulamanıza POST eder. Panelde tanımlanan URL'e çağrı başında ve sonunda istek gider; URL içindeki değişkenler santral tarafından doldurulur.

https://uygulamaniz.com/cagri?arayan={src}&aranan={dst}&kanal={chanid}

https://uygulamaniz.com/kapanis?durum={status}&sure={duration}&kanal={chanid}

{src} · {dst}

Arayan ve aranan numara.

{chanid}

Çağrının benzersiz kimliği; ses kaydı vb. çekmek için kullanılır.

{status}

Sonuç: ANSWER, BUSY, NOANSWER, CANCEL, CONGESTION.

{duration}

Çağrı süresi (sn).

Hedef URL'de DID numarası boş bırakılırsa santralde kayıtlı tüm numaralarda POST çalışır.

Santral IVR betiğinde metni anlık seslendirir.

procedure TTS;
begin
  TTS('Merhaba Mehmet Bey, bu bir test mesajıdır.');
end;

GET ya da POST ile SMS gönderir. IVR betiğinden ya da kendi sunucunuzdan çağrılabilir; örneğin cevapsız çağrıda arayan numaraya otomatik dönüş SMS'i.

https://websms.{site-adiniz}/get_api.php?username={kullanıcı}&password={api_şifresi}&receivers=538400XXXX&text=Mesaj%20metni&originator=Başlık

{
  "status": true,
  "data": {
    "sms_id": 13264888,
    "sms_count": 1,
    "amount": "0.0060",
    "credit": "5202.2040",
    "valid_receiver": 1,
    "invalid_receiver": 0
  }
}

{
  "status": false,
  "error": { "code": 2, "message": "Invalid username or password" }
}