AloTech API Documentation v1.7

AloTech API Documentation
v1.7
AloTech API Documentation v1.3 1 ❏ Giriş
Alotech bulutu web teknolojileri kullanılarak diğer uygulamalarla kolayca entegre edilebilmektedir. Sistemdeki her bilgi gerçek zamanlı okunabileceği gibi hold, unhold ve hangup gibi çağrı kontrol fonksiyonları da diğer sistemlerden yönetilebilir. API’deki metodlar standart HTTP GET ve POST tipinde taleplerle çağrılır, sonuçlar JSON formatında döndürülür. Alotech bulutunda multitenant mimari subdomain’ler ile sağlanmaktadır: Örnek: http://alotech.musterihizmetleri.com, http://demo.alo­tech.com. API URL: http://{tenant}.{domain}.com/api/ Örnek: http://alotech.musterihizmetleri.com/api/, http://demo.alo­tech.com/api/ ❏ Kullanıcı Doğrulama
API’de kullanıcı doğrulama için iki yöntem bulunmaktadır: 1.
App token yöntemi: Alotech ilgili tenant için sabit bir app token oluşturur, iptal edilene kadar sınırsız kullanılabilir. Sistemler arası entegrasyonlarda (CDR verisinin diğer uygulamaya aktarımı, dialer’a contact ekleme gibi …) kullanılması önerilir. API’ye erişimi test için örnek url: http://alotech.musterihizmetleri.com/api/?function=ping&app_token={app_token} 2.
Session key yöntemi: Alotech tarafından tanımlanan app token kullanılarak sistemde tanımlı bir kullanıcıya ait session key üretilir ve talepler bu session key ile gönderilir. Session key’in 24 saat yaşam süresi vardır, 24 saat sonra otomatik devre dışı kalır ve bu key’le gönderilen taleplere “Yanlış API anahtarı” hata mesajı gönderilir. Kullanıcı arayüzünde yapılacak uygulamalarda (Click­2­call, call control gibi …) kullanılması önerilir. Session key almak için örnek url: http://alotech.musterihizmetleri.com/api/?function=login&email={email}&app_token={app_toke
n} Başarılı sonuç: {"session_token": "ag1zfnRyeXRvcHl0aG9ucg8LEgdTZXNzaW9uGJauAwyiARd0cnl0b3B5dGhvbi5hcHBzcG90
LmNvbQ", AloTech API Documentation v1.3 2 "success": True,} Başarısız sonuç: {"success": False,"message": “Kullanıcı bulunamadı”} ❏ Click-2-call
AloTech platformunda çalışan müşteri temsilcisinin softphone’undan çağrı başlatmak için kullanılır. Bu metodu çağırmadan önce müşteri temsilcisinin hali hazırda AloTech platformu “Müşteri Temsilcisi” modülünü açmış olması gerekir. Asenkron bir metod’tur. Geçerli session parametresinin gönderildiği her durumda “success” sonucu döndürür. Örnek: http://alotech.musterihizmetleri.com/api/?function=click2call&phonenumber={phonenumber}&
queue={kuyruk}&transactionid={transaction_id}&session={session_key} phonenumber: Çağrının başlatılacağı kuyruk için tanımlanan arama planına uygun aranacak numara bilgisi, zorunlu. Örnek: 08502000256 queue: Çağrının başlatılacağı kuyruğun id’si, opsiyonel. Sistem Yöneticisi > Kuyruklar bölümündeki kuyruk tanımlama ekranından öğrenilebilir. transactionid: CDR verisinde tetiklenen çağrıyı eşleştirmek için kullanılan alan, opsiyonel session: login metoduyla alınan session key, zorunlu. ❏ Click-2-hold
Müşteri temsilcisinin aktif çağrısını bekletmeye başlatmak için kullanılır. Asenkron bir metod’tur. Geçerli session parametresinin gönderildiği her durumda “success” sonucu döndürür. Örnek: http://alotech.musterihizmetleri.com/api/?function=click2hold&session={session_key} session: login metoduyla alınan session key, zorunlu. ❏ Click-2-unhold
AloTech API Documentation v1.3 3 Müşteri temsilcisinin softphone’undaki 1. kanaldaki çağrıyı bekletmeden çıkarmak için kullanılır. Asenkron bir metod’tur. Geçerli session parametresinin gönderildiği her durumda “success” sonucu döndürür. Örnek: http://alotech.musterihizmetleri.com/api/?function=click2unhold&session={session_key} session: login metoduyla alınan session key, zorunlu. ❏ Click-2-hang
Müşteri temsilcisinin aktif çağrısını kapatmak için kullanılır. Asenkron bir metod’tur. Geçerli session parametresinin gönderildiği her durumda “success” sonucu döndürür. Örnek: http://alotech.musterihizmetleri.com/api/?function=click2hang&session={session_key} session: login metoduyla alınan session key, zorunlu. ❏ Report Call Logs
CDR (Call detay records ­ Çağrı detay kayıtları) verisinin diğer sistemlere aktarımı için kullanılır. Tek seferde maksimum 500 kayıt döner, tarih aralığının bu bilgi gözönünde bulundurularak belirlenmesi gerekir. 500 kayıttan daha fazla kaydın olduğu bir aralık talep edildiğinde “timeout” hataları alınabilir. Senkron bir metodtur. Örnek: http://alotech.musterihizmetleri.com/api/?function=reportCallLogs&startdate={startdate}&finish
date={finishdate}&agent={agent}&queue={queue}&app_token={app_token} app_token: AloTech tarafından tanımlanan sabit API anahtarı startdate: %Y­%m­%d %H:%M:%S formatında başlangıç tarihi, örnek: 2014­12­05 12:15:00, zorunlu finishdate: %Y­%m­%d %H:%M:%S formatında başlangıç tarihi, örnek: 2014­12­05 12:20:00, zorunlu AloTech API Documentation v1.3 4 agent: Kayıtları istenen müşteri temsilcisinin kullanıcı adı, opsiyonel queue: Kayıtları istenen kuyruğun id’si CDR kayıt deseni: 'key': Çağrıyı temsil eden tekil id 'callid': Çağrının başlatıldığı sunucudaki tekil id 'queued': Kuyruğa girdiğini belirten boolean değer 'answered': Yanıtlama durumunu belirten boolean değer 'assigned': Müşteri temsilcisine atandığını belirten boolean değer 'abandon': Kayıp çağrı olduğunu belirten boolean değer 'queuedate': Kuyruğa girdiği anı belirten datetime değer 'calldate': Çağrının sistemde ilk göründüğü anı belirten datetime değer 'talkdate': Çağrının konuşmaya başladığı anı belirten datetime değer 'hangupdate': Çağrının kapandığı anı belirten datetime değer 'waitduration': Çağrının kuyrukta beklediği süreyi belirten integer değer 'duration': Çağrının konuşma süresini belirten integer değer 'sl': Çağrının sl içinde yanıtlanma durumunu belirten boolean değer 'shortcall': Çağrının kısa çağrı durumunu belirten boolean değer 'callerid': Arayan kişinin numarası 'called_num': Aranan numara 'queue': Kuyruk ismi 'inbound': Çağrının gelen / giden çağrı olduğunu belirten booelan değer 'agent' : Çağrının ait olduğu müşteri temsilcisi 'agentid': Çağrının ait olduğu müşteri temsilcisinin id’si 'hold': Bekletme adedini belirten integer değer 'holdduration': Bekletme süresini belirten integer değer 'queuekey': Kuyruk id 'agentkey': Müşteri temsilcisinin id’si 'Voicemail': Sesli mesaj durumunu belirten boolean değer 'uniqueid': Click­2­call ile birlikte veya dialer’a raporlamada eşleştirme amacıyla gönderilen alan 'recordingurl': Ses kaydına erişim için gerekli url ❏ Add-contact-to-campaign
Dialer kampanyasına kişi eklemek için kullanılır. Senkron bir metodtur. Örnek: http://alotech.musterihizmetleri.com/api/?function=addcontacttocampaign&app_token={app_t
oken}&uniqueid={uniqueid}&name={name}&surname={surname}&email={email}&campaign={
AloTech API Documentation v1.3 5 campaign}&homephone={homephone}&businessphone={businessphone}&mobilephone={mo
bilephone}&customphone={customphone}&customfields={customfileds} app_token: AloTech tarafından verilen sabit API anahtarı uniqueid: CDR verisinde eşleştirme yapabilmek için verilen id name: Kişinin adı surname: Kişinin soyadı email: Kişinin email’i campaign: Kişinin ekleneceği kampanya id’si homephone: Ev telefonu businessphone: İş telefonu mobilephone: Mobil telefon customphone: Özel telefon customfields: JSON formatında özel alanlar ❏ Softphone Transfer To IVR
Çağrıyı IVR menüsüne transfer etmek için kullanılır. Senkron bir metodtur. Örnek (Gelen Çağrı): http://alotech.musterihizmetleri.com/api/?function=softphoneTransfer2Ivr&attendantkey={atten
dantkey}&callid={callid}&app_token={app_token} app_token: AloTech tarafından verilen sabit API anahtarı callid: Çağrının uniqueid’si attendantkey: Transfer edilecek IVR menüsünün id’si Örnek (Giden Çağrı): http://alotech.musterihizmetleri.com/api/?function=softphoneTransfer2Ivr&attendantkey={atten
dantkey}&transactionid={transactionid}&app_token={app_token} app_token: AloTech tarafından verilen sabit API anahtarı transactionid: Click2call metodu çağrılırken gönderilen id attendantkey: Transfer edilecek IVR menüsünün id’si ❏ Set Campaign Call
Dialer tarafından başlatılan çağrıya sonuç kodu bildirmek için kullanılır. AloTech API Documentation v1.3 6 Senkron bir metodtur. Örnek: http://alotech.musterihizmetleri.com/api/?function=setcampaigncall2&app_token={app_token}
&reasoncode={reasoncode}&finishcode={finishcode}&callbackdate={callbackdate}&callbackti
me={callbacktime}&uniqueid=${uniqueid}&username=${username}&campaign=${campaign}&
campaignkey=${campaignkey} app_token: AloTech tarafından verilen sabit API anahtarı reasoncode: Ulasildi / Randevu / Ulasilamadi / Hatali Numara seçeneklerinden biri. Ulasildi ve Ulasilamad durumunda finishcode belirtilmeli. finishcode: Çağrı sonuç kodu, max. 255 karakter uzunluğunda alpha numeric callbackdate: Randevu tanımlanacaksa eğer kişinin tekrar aranacağı tarih (YYYY­MM­DD formatında) callbacktime: Randevu tanımlanacaksa eğer kişinin tekrar aranacağı saat (HH:MM:SS formatında) uniqueid: addcontacttocampaign metoduna gönderilen uniqueid bilgisi, mükerrerlik kontrolü yapılmamaktadır. 3rd­party uygulamanın mükerrerliği yönetmesi beklenmektedir. username: Sonuç kodu seçimini yapan kullanıcının email adresi (AloTech platformunda tanımlı olan kullanıcı adı) campaign: AloTech platformunda tanımlı olan kampanya adı (Not: campaignkey önceliklidir. campaignkey verildiğinde bu parametreye gerek yoktur.) campaignkey: AloTech platformunda tanımlı olan kampanya key değeri. Not: callbackdate ve callbacktime birlikte kullanılmalı, biri eksik olunca hata verecektir. ❏ Get Recording URL
Çağrının ses kayıt link’ini verir. Senkron bir metodtur. Örnek: http://alotech.musterihizmetleri.com/api/?function=getrecordingurl&app_token={app_token}&c
allkey={callkey} app_token: AloTech tarafından verilen sabit API anahtarı callkey: Popup esnasında gönderilen çağrıya ait unique key bilgisi AloTech API Documentation v1.3 7