Geliştiriciler için belgeler

Veri ve entegrasyon talimatlarına mı ihtiyacınız var?
Talimatlarımızı kullanın.

API anahtarı alımı
Aramaya görev (numara) ekleme
Aramadan görev (numara) silme
Arama kaydı
Arama verileri ekleme
Arama verilerini alma
Konuşma kaydı alma
Kuyruklar ve kullanıcılar için özet raporlar
Ajantın durumunu değiştirme
CRM’den iletişim bilgileri çıkarma
Listede bir değerin varlığını kontrol etme
Sipariş detayları hakkında tam bilgi (SHOP modülü)
Otomatik arama listesi için API

API v.1

 

API anahtarı alımı

API anahtarı kullanıcı ayarlarınız içinde oluşturulur.

width="600"

 

Aramaya görev (numara) eklemek

URL https://noname.oki-toki.net/api/v1/dialers/create_task

Method: POST veya GET

*API anahtarı kullanıcınızın ayarları içinde oluşturulur, bu, belgenin ilk adımında gösterildiği gibidir.

Değişkenlerin verilmesi:

Standart yöntemle POST veya GET talebinde
Standart olmayan yöntem. POST veya GET json_request değişkeni görevi eklemek için veriler içeren json dizgisini içermelidir

Kullanıcının api token’ı ile yetkilendirme. Talepte kullanıcı token’ı içeren api_token değişkeni mutlaka bulunmalıdır.

Zorunlu veriler:

dialer_id – eklemek için görevin numarası olan otomatik aramada
phones – telefon numaraları, maksimum 5. Virgülle ya da json alt dizgisi ile (eğer json_request içinde veriliyorsa)

İsteğe bağlı veriler:

contact_id – Oki-Toki CRM’den iletişim numarası,
bp_id – Oki-Toki CRM’den işlem numarası,
date – aramaların atandığı zaman, 21.02.2017 12:00:00 formatında,
import_id – ithalat numarası,
priority öncelik 0 ile 2 arasında,
region saat dilimi formatında bölge. örneğin Europe/Kiev (eğer bölge belirtilirse ama boş olursa, saat dilimi otokoreksiyonu(aktifse) çalışmaz, müşteri takvimi çalışmaz ve arama otomatik arama çalışma programına göre yapılır),
ttl görevin yaşam süresi, saniye cinsinden,
user_id görevin atanacağı kullanıcının numarası,
details – ek bilgi içeren json alt dizgisi, örneğin {“name”:”John”, “order”:”12″}
force_create – 1 veya 0. Eğer force_create=1, otomatik aramada ayarlarda benzersizlik aktifse ve görev benzersizlik sebebiyle eklenmiyorsa, ekleme sırasında var olan tüm çakışan görevler otomatik olarak iptal edilecek,
task_id – otomatik aramadaki görev numarası. eğer belirtilmişse telefon numaraları belirtilen numaraya eklenir, eğer çalışmada ise,

reset_task_id – otomatik aramadaki görev numarası. eğer belirtilmişse – sistem bu görevi bulmaya ve yeni bir şey yaratmak yerine onu çalışmaya koymaya çalışacak. Eğer telefon numaraları (phones) belirtilmişse, sistem sadece belirtilenleri çalışmaya koyacak. eğer görevde belirtilen herhangi bir numara yoksa – o, göreve eklenecek. eğer numaralar belirtilmemişse – görevdeki tüm telefonlar sıraya girecek.
Cevap, görevin başarıyla eklendiği ile ilgili mesaj ile dönecek, numarası ile birlikte, ya da hata mesajı ile.

 

Aramadan görev (numara) silme

URL https://noname.oki-toki.net/api/v1/dialers/cancel_task

Method: POST veya GET

*Kullanıcınızın ayarları içinde API anahtarı oluşturulur, bu belgenin ilk adımında gösterildiği gibidir.

Değişkenlerin verilmesi:

Standart yöntemle POST veya GET talebinde.
Standart olmayan yöntem. POST veya GET json_request değişkeni görevi eklemek için veriler içeren json dizgisini içermelidir.
Kullanıcının api token’ı ile yetkilendirme. Talepte kullanıcı token’ı içeren api_token değişkeni mutlaka bulunmalıdır.

Zorunlu veriler:
dialer_id – görevin silineceği otomatik aramadan numara (eğer numara = 0 ise, tüm otomatik aramalardan silinir).
İsteğe bağlı veriler:
task_id – görev numarası,
phone – görevde olan telefon numarası,
contact_id – Oki-Toki CRM’den iletişim numarası,
bp_id – Oki-Toki CRM’den işlem numarası,
details – ek bilgi içeren json alt dizgisi, örneğin {“name”:”John”, “order”:”12″}. Belirtilen ek bilgiye sahip görevler iptal edilir,
cancel_phone – 1 (bayrak, eğer ayarlanmışsa, sadece belirtilen telefon numarasını iptal eder),
cancel_reason – iptal sebebi (şu sebeplerden biri olabilir: wrong_number).
İsteğe bağlı parametreler birbiriyle kombin edilebilir, bu durumda farklı görevler silinir. Örneğin: belirli bir telefon numarasıyla tüm görevleri silmek veya detayları ile mümkün.

Herhangi bir isteğe bağlı parametre belirtilmemişse, hata döner.

Cevap başarıyla iptal edilen görev(ler) ile ilgili mesaj ile dönecek, onun(ların) numarası(numaraları) ile birlikte, ya da hata mesajı ile.

 

Arama kaydı

URL https://noname.oki-toki.net/api/v1/reports/acd/calls-log

Method: GET

*Kullanıcınızın ayarları içinde API anahtarı olu…

Submit your request and receive a detailed consultation from a specialist.

    Data Processing Agreement