API Dokümanı

Bulutsantralim API ile aşağıdaki işlemleri yapabilirsiniz.

  • Uygulamalarınız üzerinden çağrı başlatabilirsiniz.
  • Santralinizdeki telefonsal olayları uygulamalarınıza bildirebilirsiniz.
  • Uygulamalarınız üzerinden çağrıların ses kayıtları dinleyebilir veya indirebilirsiniz.

 

ÇAĞRI BAŞLATMA

Uygulamalarınız üzerinden santraldeki bir dahiliye çağrı başlatmak için kullanılır. Bunun için HTTP GET metodu ile api.bulutsantralim.com adresi aşağıdaki parametrelerle çağrılır. İstek başarılı olduğunda HTTP 200 Status kodu ile mesajın Body’sinde call_uuid döner. İstek başarısız olduğunda ise ilgili HTTP Status kodu ile mesajın Body’sinde hata mesajı döner.

HAZIRLIK
Online İşlem Merkezi => Bulut Santralim => Santral Ayarlarım menüsü altından API Anahtarınızı (key) öğrenmelisiniz.

ÇAĞRI BAŞLATMA ÖRNEĞİ

http://api.bulutsantralim.com/originate?key=K12345678-1234-5678-4321-123456789012&extension=1001&destination=908505320000

BAŞARILI CEVAP

HTTP/1.1 200 OK
358c20bc-fd86-11e5-87a2-157d41a07454

BAŞARISIZ CEVAP

HTTP/1.1 400 Bad Request
extension 1005 not found

PARAMETRELER
Kullanılacak parametreler aşağıdakilerdir. Zorunlu olanlar koyu olarak belirtilmiştir.

  • key = Size özel oluşturulmuş API anahtarınızdır.
  • extension = Aramanın bağlanacağı dahili numaradır.
  • destination = Aranacak olan numara. (908505320000 formatında olmalı.)
  • caller_id = Aramada kullanılacak olan dış numara. (908505320000 formatında olmalı. Kullanılacak dış numaranın mutlaka en az bir dahilide seçili olması gerekir. Bu parametre verilmezse dahilide seçili olan dış no kullanılacaktır.)
  • manual_answer = Değeri true olarak gönderilirse dahilinin telefonu açmasını bekler. (Normalde otomatik olarak dahili açılır ve karşı numara aranır.)

 

OLAY BİLDİRME (POPUP – CDR – CEVAPSIZ)

Santralinizde gerçekleşen olayları (telefon çalıyor, telefon açıldı, telefon kapandı) uygulamalarınıza bildirmek için kullanılır. Telefon kapandı (hangup) bildirimi aynı zamanda CDR bildirimidir. Telefon kapandı bildirimi içesindeki çağrının cevaplanıp cevaplanamadığı (answered) bilgisi Kaçan çağrı tespiti için kullanılır. HTTP POST metodu ile santral ayarlarından girdiğiniz olay bildirim adresine aşağıdaki parametreler gönderilir. Veriler HTML Form Field olarak gönderilir.

HAZIRLIK
Online İşlem Merkezi => Bulut Santralim => Santral Ayarlarım menüsü altından hangi olayların bildirileceğini ve bildirim yapılacak URL’i belirtmelisiniz.

UYGULAMANIZA GÖNDERİLECEK BİLDİRİM ÖRNEĞİ

POST http://musteri.adresi.com.tr/event/
Host: musteri.adresi.com.tr
Accept: */*

event_type=ringing&domain_id=101&direction=inbound&caller_id_number=02123205062&outbound_caller_id_number=&destination_number=1001&dialed_user=1001&call_uuid=1234&start_stamp=2016-01-01 00:00:00

PARAMETRELER

  • event_type (ringing, answer, hangup)
  • domain_id
  • direction (internal, inbound, outbound)
  • caller_id_number
  • outbound_caller_id_number
  • destination_number
  • dialed_user
  • connected_user
  • call_uuid
  • start_stamp
  • answer_stamp
  • end_stamp
  • duration
  • recording_present (t, f)
  • answered (t, f)
  • queue
  • queue_wait_duration
  • sip_hangup_disposition
  • hangup_cause
  • failure_status
  • failure_phrase

 

SES KAYDI ERİŞİMİ

Santralinizdeki ses kayıtlarını uygulamalarınız üzerinden dinlemek veya indirmek için kullanılır. Bu işlem iki aşamadan oluşur. Birinci aşamada URL elde edilir. İkinci aşamada ise o URL’den ses dosyası indirilir/dinlenir.

Birinci aşama için; HTTP POST metodu ile api.bulutsantralim.com adresine aşağıdaki parametreler gönderilir. İstek başarılı olduğunda HTTP 200 Status kodu ile mesajın Body’sinde ses kaydına ait olan bir URL döner. İstek başarısız olduğunda ise ilgili HTTP Status kodu ile mesajın Body’sinde hata mesajı döner.

İkinci aşamada ise elde ettiğiniz URL bir player’a verilip dinleme yaptırılır veya direkt indirebilir. URL yaşam süresi 1 saattir.

HAZIRLIK
Online İşlem Merkezi => Bulut Santralim => Santral Ayarlarım menüsü altından API Anahtarınızı (key) öğrenmelisiniz.

URL İSTEME ÖRNEĞİ

http://api.bulutsantralim.com/recording_url?key=K12345678-1234-5678-4321-123456789012&call_uuid=12345678-1234-5678-4321-123456789012

BAŞARILI CEVAP

HTTP/1.1 200 OK
http://api.bulutsantralim.com/recording/Rbb9d6f36-d1a7-46f5-961e-4be2e2ba1b8e

 BAŞARISIZ CEVAP

HTTP/1.1 400 Bad Request
cannot find call with call_uuid 12345678-1234-5678-4321-123456789012

PARAMETRELER
Kullanılacak parametreler aşağıdakilerdir. Zorunlu olanlar koyu olarak belirtilmiştir.

  • key = Size özel oluşturulmuş API anahtarınızdır.
  • call_uuid = URL’ini istediğiniz ses kaydına ait uuid.

Cevap Yaz


2 × 4 =