API docs by Redocly

API V1 (v1)

Download OpenAPI specification:

Verimor Bulutsantralim API'si, işletmelerin mevcut yazılımlarını (CRM, ERP vb.) Bulut Santral hizmetleriyle entegre etmelerini sağlayan güçlü bir arayüzdür. Bu API sayesinde, santral yönetimi ve çağrı operasyonları otomatize edilebilir ve iş süreçleri daha verimli hale getirilebilir.

Kimlik Doğrulama (Authentication)

API'ye yapılan tüm istekler, size özel olarak oluşturulmuş bir API anahtarı ile doğrulanır. Bu anahtarı, her bir API isteğinde query parametresi olarak key adıyla göndermeniz gerekmektedir.

API anahtarınızı (key) Verimor Online İşlem Merkezi (OİM) > Bulut Santralim > Santral Ayarlarım menüsü altından öğrenebilirsiniz.

Temel Yetenekler

Çağrı Yönetimi

  • Çağrı Başlatma (Click-to-Call): Yazılımınız üzerinden tek bir tıklama ile dış aramalar başlatın.
  • Gelen Çağrı Bilgisi (Pop-up): Gelen aramalarda, arayan kişiye ait bilgileri anında kendi yazılımınızın ekranında görüntüleyin.
  • Çağrı Kontrolü: Aktif çağrıları sonlandırma, sessize alma, bekletme ve başka bir dahiliye veya harici numaraya aktarma (katılımlı/katılımsız) işlemlerini gerçekleştirin.

Veri ve Kayıt Yönetimi

  • Arama Kayıtları (CDR): Tüm arama geçmişine ve detaylarına (arayan, aranan, süre, durum vb.) anlık olarak erişin.
  • Ses Kayıtları: Yapılan görüşmelerin ses kayıtlarını listeleyin, dinleyin veya indirin. Google Drive entegrasyonu ile ses kayıtlarınızı kendi bulut depolama alanınızda arşivleyin.

Otomasyon ve IVR

  • Otomatik Arama & IVR Kampanyaları: Anket, borç hatırlatma, duyuru veya onay alma gibi amaçlarla toplu ve otomatik dış aramalar (IVR) oluşturun ve yönetin.
  • Sesli Mesaj Gönderimi: Hedef kitlelerinize toplu olarak sesli mesajlar iletin.

Gelişmiş Özellikler

  • Numara Maskeleme: İki tarafın birbirinin telefon numarasını görmeden güvenli bir şekilde görüşmesini sağlayın. Bu özellik, özellikle hizmet ve pazaryeri platformları için idealdir.
  • Santral Programlama: Dahili ve kuyruk ayarları gibi temel santral konfigürasyonlarını API üzerinden yönetin.
  • Text-to-Speech (TTS) ve Speech-to-Text (STT): Yazı metinlerini sese dönüştürerek dinamik anonslar oluşturun veya müşterilerden gelen sesli komutları metne çevirerek yazılımınıza aktarın.

Bu API, HTTP GET/POST istekleri ile kolayca kullanılabilir. Detaylı bilgi ve endpoint dokümantasyonu için ilgili bölümleri inceleyebilirsiniz.

Webhooks

Olay Bildirme Webhook

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ım sayfasından CRM Entegrasyonu bölümünden girdiğiniz Bildirilecek URL adresine aşağıdaki parametreler HTML Form Field olarak gönderilir.

Request Body schema: application/x-www-form-urlencoded

Uygulamanıza gönderilecek bildirim örneği

event_type
string

Olay tipi. ringing, answer, hangup veya user_hangup döner.

domain_id
string

Bulutsantral ID'si.

direction
string

Çağrının yönü. internal, inbound yada outbound döner.

caller_id_number
string

Arayan numara.

outbound_caller_id_number
string

Arayanın dış numarası.

destination_number
string

Aranan numara.

dialed_user
string

Aranan kişinin dahili numarası.

connected_user
string

Bağlanan (telefonu açan) dahili.

call_uuid
string

Çağrının uuid'si.

start_stamp
string <date_time>

Çağrının başladığı zaman.

answer_stamp
string <date_time>

Çağrının cevaplandığı zaman.

end_stamp
string <date_time>

Çağrının sonlandığı zaman.

duration
integer

Konuşma süresi.

recording_present
boolean

Çağrının ses kaydının olup olmadığı. true yada false döner.

answered
boolean

Kaçan çağrı tespiti için kullanılır. Aranan taraf çağrıyı kabul ettiyse true döner.

queue
string

Kuyruğun veya Çağrı grubunun numarası.

queue_wait_duration
integer

Kuyrukta bekleme süresi.

sip_hangup_disposition
string

Çağrının kimin tarafından kapatıldığı. caller ya da callee olarak döner.

hangup_cause
string

Çağrının kapanma sebebi.

failure_status
string

Çağrı başarısız ise hata kodu.

failure_phrase
string

Çağrı başarısız ise hata mesajı.

Responses

Otomatik Arama Kampanyası Raporu Alımı Webhook

Kampanyadaki numaralar arandığında, aramanın durumu ve varsa tuşlama bilgisi, kampanya oluşturulurken (OİM arayüzünden ya da API ile) verilen webhook_url adresine bir HTTP POST request’i ile gönderilir.

BİLDİRİM SAHALARI:

  • notification_id: Bu bildirime ait unique id.
  • notification_date: Bildirimi yapılan olayın gerçekleştiği tarih saat.
  • domain_id: Bulutsantral ID’si
  • ivr_campaign_id: Otomatik IVR arama kampanyasının ID’si
  • ivr_campaign_name: Otomatik IVR arama kampanyasının adı
  • ivr_lead_id: Kampanyadaki numaranın ID’si
  • phone: Aranan telefon numarası
  • digit: Aranan kişinin yaptığı tuşlama. Şu değerleri alabilir: Boş string (): Çağrı başlamadı (numara meşgul, ulaşılamıyor, hatalı numara vs.). Bu durumda status sahasında ilgili hata yazar. 0-9 arası bir rakam: Geçerli bir tuşlama yapıldı. tire (-) işareti: tuşlama yapılmadı ve timeout oluştu. ünlem (!) işareti ve rakam (örn: !4): Geçerli olmayan (tuşlama ayarlarında karşılığı olmayan) bir tuşa basıldı.
  • call_uuid: Tuşlama için yapılan çağrının UUID’si. Yukarıdaki olay bildirme API’sini de kullanıyorsanız, orada gelen UUID ile eşleştirebilirsiniz.
  • status: Çağrı durumu. “Cevaplandı”, “Cevapsız”, “Reddedildi”, “Hata” gibi açıklamaları içerir. “Cevaplandı” hariç her durum hata olarak yorumlanabilir.
Request Body schema: application/x-www-form-urlencoded

API’nize gönderilecek parametreler aşağıdakilerdir.

notification_id
integer

Bu bildirime ait unique id.

notification_date
string <date_time>

Bildirimi yapılan olayın gerçekleştiği tarih saat.

domain_id
string

Bulutsantral ID’si.

ivr_campaign_id
integer

Otomatik IVR arama kampanyasının ID’si.

ivr_campaign_name
string

Otomatik IVR arama kampanyasının adı.

ivr_lead_id
integer

Kampanyadaki numaranın ID’si.

phone
string

Aranan telefon numarası.

digit
string

Aranan kişinin yaptığı tuşlama. Boş string (""): Çağrı başlamadı. 0-9: Geçerli tuşlama. -: timeout. !4: Geçersiz tuşlama.

call_uuid
string

Tuşlama için yapılan çağrının UUID’si.

status
string

Çağrı durumu. 'Cevaplandı', 'Cevapsız', 'Reddedildi', 'Hata' gibi açıklamaları içerir. 'Cevaplandı' hariç her durum hata olarak yorumlanabilir.

Responses

Kullanıcı Yönetimi

MT durumlarını ve üyeliklerini listeleme

Müşteri Temsilcilerinizin durumunu ve hangi kuyruklara üye olduklarını listelemek için kullanılır. HTTP GET metodu ile api.bulutsantralim.com/agent_statuses adresi parametrelerle çağrılır. İstek başarılı olduğunda HTTP 200 Status kodu ile mesajın Body'sinde mesajlar döner. İstek başarısız olduğunda ise ilgili HTTP Status kodu ile mesajın Body'sinde hata mesajı döner. API ile dakikada iki istek (request) gönderebilirsiniz.

Authorizations:
api_key
query Parameters
agent
string
Example: agent=1010

Belirli bir MT'nin durumunu öğrenmek için kullanılır

queue
string
Example: queue=204

Belirli kuyruktaki MT'lerin durumlarını listelemek için kullanılır

status
string

Belirli durumdaki MT'leri listelemek için kullanılır:

  • AVAILABLE
  • TALKING
  • LOGGED_OUT
  • ON_BREAK

Responses

Response samples

Content type
application/json
Example
[
  • {
    },
  • {
    },
  • {
    }
]

Kullanıcı için Rahatsız Etme (DND) modunu ayarla

Kullanıcının dahili numarası için Rahatsız Etme (DND) modunu açar veya kapatır. DND açıkken kullanıcıya gelen çağrılar engellenir.

Authorizations:
api_key
path Parameters
id
required
string
Example: 1001

Dahili numara (örn: 1001)

query Parameters
state
required
string

DND durumu: "on" açmak için, "off" kapatmak için:

  • on
  • off

Responses

Response samples

Content type
text/plain
Example
Changed DND of 1008 to on.

Dahili durumlarını listeleme

Dahililerinizin durumlarını listelemek için kullanılır. HTTP GET metodu ile api.bulutsantralim.com/user_statuses adresi parametrelerle çağrılır. İstek başarılı olduğunda HTTP 200 Status kodu ile mesajın Body'sinde mesajlar döner. İstek başarısız olduğunda ise ilgili HTTP Status kodu ile mesajın Body'sinde hata mesajı döner. API ile dakikada iki istek (request) gönderebilirsiniz.

Authorizations:
api_key
query Parameters
user
string
Example: user=1000

Belirli bir Dahilinin durumunu öğrenmek için kullanılır

status
string

Belirli durumdaki Dahilileri listelemek için kullanılır:

  • AVAILABLE
  • TALKING
  • UNREGISTERED
  • SS_DND

Responses

Response samples

Content type
application/json
Example
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Dahili için token (anahtar) alma

Web telefonunu kendi uygulamanızda kullanmak için token oluşturur. Her açılışta ilgili dahili için token alınmalıdır. Token 1 gün geçerlidir.

Authorizations:
api_key
query Parameters
extension
required
string

Web telefonunu kullanacak dahili numarası

Responses

Response samples

Content type
text/plain
W03311746-d56d-489b-801f-da610aba71cf

Anons Yönetimi

Ses dosyaları listesine erişim

Santralinizdeki ses dosyalarının listesine erişmek için kullanılır. İstek başarılı olduğunda HTTP 200 Status kodu ile mesajın Body'sinde ses dosyalarının listesi döner. İstek başarısız olduğunda ise ilgili HTTP Status kodu ile mesajın Body'sinde hata mesajı döner.

Authorizations:
api_key

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Yeni ses dosyası yükleme

Yeni ses dosyası yüklemek için kullanılır. Yeni ses dosyasının ismini ve içeriğinin base64 ile kodlanmış halini POST etmeniz yeterlidir. Başarılı durumda oluşturulan ses dosyasının ID'si döner.

Authorizations:
api_key
Request Body schema: application/x-www-form-urlencoded
name
required
string

Ses dosyasının adı

sounddata
required
string

Ses dosyasının içeriği, base64 ile kodlanmış olarak

Responses

Response samples

Content type
text/plain
859

Ses dosyası güncelleme

Mevcut ses dosyasının adını ve içeriğini güncellemek için kullanılır. Ses dosyasının ismini ve içeriğinin base64 ile kodlanmış halini PATCH etmeniz yeterlidir. Başarılı durumda OK döner.

Authorizations:
api_key
path Parameters
id
required
string
Example: 21870

Güncellenecek ses dosyasının ID'si

Request Body schema: application/x-www-form-urlencoded
name
required
string

Ses dosyasının yeni adı

sounddata
required
string

Ses dosyasının yeni içeriği, base64 ile kodlanmış olarak

Responses

Response samples

Content type
text/plain
OK

Ses dosyası silme

Ses dosyasını silmek için kullanılır. Ses dosyasının id ile DELETE etmeniz yeterlidir. Başarılı durumda OK döner.

Authorizations:
api_key
path Parameters
id
required
string

Silinecek ses dosyasının ID değeri

Responses

Response samples

Content type
text/plain
OK

Karaliste Yönetimi

Karalisteye erişim

Santralinizdeki kara listedeki numaraların listesine erişmek için kullanılır. HTTP GET metodu ile api.bulutsantralim.com/blocked_numbers adresi parametrelerle çağrılır. İstek başarılı olduğunda HTTP 200 Status kodu ile mesajın Body'sinde kara liste döner. İstek başarısız olduğunda ise ilgili HTTP Status kodu ile mesajın Body'sinde hata mesajı döner.

Authorizations:
api_key
query Parameters
page
integer

Sayfa numarası (varsayılan 1)

limit
integer

Listeyi sınırlayabilirsiniz. Varsayılan değer 10, minimum değer 10, maksimum değer 100

Responses

Response samples

Content type
application/json
{
  • "blocked_numbers": [
    ],
  • "pagination": {
    }
}

Karalisteye ekleme

Telefon numarasını kara listeye ekler. Numara kayıt edilmeden önce normalize edilir. POST metodu ile api.bulutsantralim.com/blocked_numbers adresine istek gönderilir. İstek başarılı olduğunda HTTP 200 Status kodu ile mesajın Body'sinde oluşturulan kaydın ID'si döner. İstek başarısız olduğunda ise ilgili HTTP Status kodu ile mesajın Body'sinde hata mesajı döner.

Authorizations:
api_key
query Parameters
number
required
string
Example: number=05111111111

Engellenecek telefon numarası (normalize edilecek)

Responses

Response samples

Content type
text/plain
20212

Karalisteden silme

Telefon numarasını kara listeden çıkarır. Numara kaldırılmadan önce normalize edilir. DELETE metodu ile api.bulutsantralim.com/blocked_numbers/delete adresi parametrelerle çağrılır. İstek başarılı olduğunda HTTP 200 Status kodu ile mesajın Body'sinde başarı mesajı döner. İstek başarısız olduğunda ise ilgili HTTP Status kodu ile mesajın Body'sinde hata mesajı döner.

Authorizations:
api_key
query Parameters
number
required
string
Example: number=05111111111

Kara listeden çıkarılacak telefon numarası (normalize edilecek)

Responses

Response samples

Content type
text/plain
OK

Çağrı Yönetimi

Çağrı Bağlama

Uygulamalarınız üzerinden iki dış numarayı (örn. cep telefonu) arayıp birbiriyle görüştürmek için kullanılır. Kullanım alanları: Müşteriniz ve saha personelinizi görüştürmek istiyorsunuz fakat bilgi güvenliği (örn. KVKK) nedeniyle cep telefonu numaralarının görünmesini istemiyorsunuz (numara maskeleme/gizleme). Müşteriniz ve saha personelinizin yaptığı görüşmeleri raporlamak ve ses kayıtlarını tutmak istiyorsunuz.

Authorizations:
api_key
query Parameters
source
required
string
Example: source=905111111111

İlk olarak bu numara aranır, telefon açılınca destination aranır (yurtiçi çağrılar için 908505320000, yurtdışı çağrılar için 00493027590915 formatında)

destination
required
string
Example: destination=905111111112

İkinci aranacak numara (yurtiçi çağrılar için 908505320000, yurtdışı çağrılar için 00493027590915 formatında)

caller_id
string
Example: caller_id=908505320000

İki tarafı da ararken kullanılacak dış numara (908505320000 formatında. Bu parametre verilmezse 1000 dahilisinde seçili olan dış no kullanılacaktır)

timeout
integer
Example: timeout=30

Telefon çaldırma süresi. 10 ile 60 sn. arasında bir değer olmalı. Varsayılan 30

announcement_to_caller
integer

Cevaplanma anında arayan tarafa dinletilecek anons. Ses dosyası ID'lerinizi API ile veya Online İşlem Merkezi üzerinden görebilirsiniz

announcement_to_callee
integer

Cevaplanma anında aranan tarafa dinletilecek anons. Ses dosyası ID'lerinizi API ile veya Online İşlem Merkezi üzerinden görebilirsiniz

recording_enabled
boolean

Görüşmenin kaydedilmesini istemiyorsanız false verin. Varsayılan olarak true kabul edilir

Responses

Response samples

Content type
text/plain
358c20bc-fd86-11e5-87a2-157d41a07454

Çağrıyı Aktar (POST)

Santralde devam eden bir çağrıyı başka bir dahiliye aktarmak için kullanılır. POST metodu ile çağrı UUID'si ve hedef dahili kullanılarak aktarım işlemi gerçekleştirilir.

Authorizations:
api_key
query Parameters
id
required
string
Example: id=f3797dfc-a818-11e7-bf70-cb295b6663ce

Aktarmak istediğiniz çağrının UUID'si

user_number
required
string
Example: user_number=1000

Aktarmak istediğiniz, bağlı kullanıcılarınızdan birinin dahili numarası

Responses

Response samples

Content type
text/plain
+OK

Çağrıyı Aktar

Santralde devam eden bir çağrıyı aktarmak için kullanılır. HTTP GET metodu ile çağrı UUID'si ve hedef dahili kullanılarak aktarım işlemi gerçekleştirilir. Yeni çağrı başlattığınızda API'den dönen UUID'yi kullanabilirsiniz veya Olay Bildirme ile gelen UUID'leri kullanabilirsiniz.

Authorizations:
api_key
path Parameters
id
required
string
Example: f3797dfc-a818-11e7-bf70-cb295b6663ce

Aktarmak istediğiniz çağrının UUID'si

query Parameters
user_number
required
string
Example: user_number=1000

Aktarmak istediğiniz, bağlı kullanıcılarınızdan birinin dahili numarası

Responses

Response samples

Content type
text/plain
+OK

Çağrı Başlatma

Geçersiz istek. Gerekli bir parametre eksik veya geçersiz olabilir (örneğin, eksik dahili numara, geçersiz hedef).

Authorizations:
api_key
query Parameters
extension
required
string
Example: extension=1001

Aramanın bağlanacağı dahili numaradır.

destination
required
string
Example: destination=908505320000

Aranacak olan numara (yurtiçi çağrılar için 908505320000, yurtdışı çağrılar için 00493027590915 formatında olmalı).

caller_id
string
Example: caller_id=908505320000

Aramada kullanılacak olan dış numara (908505320000 formatında olmalı. Bu parametre verilmezse dahilide seçili olan dış no kullanılacaktır).

manual_answer
boolean
Example: manual_answer=true

Değeri true olarak gönderilirse dahilinin telefonu açmasını bekler (Normalde otomatik olarak dahili açılır ve karşı numara aranır).

timeout
integer
Example: timeout=30

Telefon çaldırma süresidir. 10 ile 60 sn. arasında bir değer olmalı. Varsayılan 30'dur.

announcement_to_callee
integer

Cevaplanma anında aranan tarafa dinletilecek anons. Ses dosyası ID'lerinizi API ile veya Online İşlem Merkezi üzerinden görebilirsiniz.

announcement_to_caller
integer

Cevaplanma anında arayan tarafa dinletilecek anons. Ses dosyası ID'lerinizi API ile veya Online İşlem Merkezi üzerinden görebilirsiniz.

Responses

Response samples

Content type
text/plain
358c20bc-fd86-11e5-87a2-157d41a07454

Bir Çağrı Başlat (POST)

Invalid request. A required parameter might be missing or invalid.

Authorizations:
api_key
Request Body schema:
required
extension
required
string

Aramanın bağlanacağı dahili numaradır.

destination
required
string

Aranacak olan numara (yurtiçi çağrılar için 908505320000, yurtdışı çağrılar için 00493027590915 formatında olmalı).

caller_id
string

Aramada kullanılacak olan dış numara (908505320000 formatında olmalı. Bu parametre verilmezse dahilide seçili olan dış no kullanılacaktır).

manual_answer
boolean

Değeri true olarak gönderilirse dahilinin telefonu açmasını bekler (Normalde otomatik olarak dahili açılır ve karşı numara aranır).

timeout
integer

Telefon çaldırma süresidir. 10 ile 60 sn. arasında bir değer olmalı. Varsayılan 30'dur.

announcement_to_caller
integer

Cevaplanma anında arayan tarafa dinletilecek anons. Ses dosyası ID'lerinizi API ile veya Online İşlem Merkezi üzerinden görebilirsiniz.

announcement_to_callee
integer

Cevaplanma anında aranan tarafa dinletilecek anons. Ses dosyası ID'lerinizi API ile veya Online İşlem Merkezi üzerinden görebilirsiniz.

Responses

Request samples

Content type
{
  • "extension": "1001",
  • "destination": "908505320000",
  • "caller_id": "908505320000",
  • "manual_answer": false,
  • "timeout": 30,
  • "announcement_to_caller": 0,
  • "announcement_to_callee": 0
}

Response samples

Content type
text/plain
a1b2c3d4-e5f6-7890-1234-567890abcdef

Çağrıyı Sonlandır

Uygulamalarınız üzerinden santralde devam eden bir çağrıyı sonlandırmak için kullanılır. HTTP GET metodu ile api.bulutsantralim.com adresi parametrelerle çağrılır. İstek başarılı olduğunda HTTP 200 Status kodu ile mesajın Body'sinde +OK döner.

Authorizations:
api_key
path Parameters
id
required
string
Example: f3797dfc-a818-11e7-bf70-cb295b6663ce

Sonlandırmak istediğiniz çağrının UUID'si

Responses

Response samples

Content type
text/plain
+OK

Çağrıyı Sessize Al / Sesli Yap

Santralde devam eden bir çağrıyı sessize almak veya sesli yapmak için kullanılır. HTTP GET metodu ile çağrı UUID'si ve state parametresi kullanılarak mute işlemi gerçekleştirilir.

Authorizations:
api_key
path Parameters
id
required
string
Example: f3797dfc-a818-11e7-bf70-cb295b6663ce

Sessize almak istediğiniz çağrının UUID'si

query Parameters
state
required
string
Example: state=on

Mute modunu açmak için "on", kapatmak için "off" olarak gönderilir:

  • on
  • off

Responses

Response samples

Content type
text/plain
+OK

Dış Numaralar Yönetimi

Dış Numaralar Listesine Erişim

Santralinizdeki Arayan Numara olarak kullanabileceğiniz numaraların listesine erişmek için kullanılır.

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

Authorizations:
api_key

Responses

Response samples

Content type
application/json
[
  • "908501234567",
  • "902121234567",
  • "902161234567",
  • "902127654321"
]

Dahilinin Dış Numarasını (Arayan No) Değiştirme

Santralinizdeki dahililerin dış numarasını değiştirmek için kullanılır.

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

ÖNEMLİ NOT: Kullanabileceğiniz numara listesini caller_ids API'sinden öğrenebilirsiniz.

Authorizations:
api_key
query Parameters
extension
required
string
Example: extension=1000

Dış numarası değiştirilecek olan dahili

caller_id
required
string
Example: caller_id=90850532xxxx

Dahilinin kullanacağı dış numara. Kullanabileceğiniz numara listesini caller_ids API'sinden öğrenebilirsiniz

Responses

Response samples

Content type
text/plain
OK

Raporlama ve Kayıtlar

Çağrı Detay Kayıtları (CDR) listesini getirir

Farklı filtrelerle ve sayfalama ile çağrı detay kayıtlarını (CDR) listeler.

Authorizations:
api_key
query Parameters
start_stamp_from
string

Başlangıç tarihi/zamanı (ISO formatı)

start_stamp_to
string

Bitiş tarihi/zamanı (ISO formatı)

recording_present
string

Kayıt durumu filtresi:

  • true
  • false
  • deleted
direction
string

Çağrı yönü filtresi

caller_id_number
string

Arayan numara filtresi

destination_number
string

Hedef numara filtresi

missed
string

Cevapsız çağrı filtresi

queue
string

Kuyruk adı filtresi

page
integer

Sayfa numarası (varsayılan: 1)

limit
integer

Sayfa başına kayıt sayısı

Responses

Response samples

Content type
application/json
{
  • "cdrs": [
    ],
  • "pagination": {
    }
}

Belirli bir çağrıya ait detaylı CDR kaydını getirir

Belirli bir çağrıya ait tüm detayları ve çağrı akışını getirir.

Authorizations:
api_key
path Parameters
id
required
string
Example: call-uuid-12345-67890

Çağrı UUID

Responses

Response samples

Content type
application/json
{
  • "cdr": {
    },
  • "call_flow": [
    ]
}

Ses kaydı için geçici URL oluştur

Santralinizdeki veya Google Drive'a aktarılmış ses kayıtlarınıza erişmek için geçici bir URL oluşturur. URL 1 saat geçerlidir ve dakikada en fazla 5 istek yapılabilir.

Authorizations:
api_key
query Parameters
call_uuid
required
string

URL'ini istediğiniz ses kaydına ait çağrı UUID'si

Responses

Response samples

Content type
text/plain
https://api.bulutsantralim.net/recording/Re9a6e998-821c-4f00-b420-7a521b1ad480

Telesekreter arama kayıtlarına erişim

Santralinizdeki telesekreter arama kayıtlarına ve ses kayıtlarına erişmek için kullanılır. HTTP GET metodu ile api.bulutsantralim.com adresi parametrelerle çağrılır. İstek başarılı olduğunda HTTP 200 Status kodu ile mesajın Body'sinde mesajlar döner. İstek başarısız olduğunda ise ilgili HTTP Status kodu ile mesajın Body'sinde hata mesajı döner.

Authorizations:
api_key
query Parameters
start_stamp_from
string
Example: start_stamp_from=2017-08-03 12:30:32 UTC

Mesaj bırakma tarihi yazdığınız tarihden sonra olan çağrıları listeler

start_stamp_to
string
Example: start_stamp_to=2017-08-03 12:30:32 UTC

Mesaj bırakma tarihi yazdığınız tarihe kadar olan çağrıları listeler. Tarih aralığı 31 günden uzun olamaz

read
string

Değeri "true" olarak gönderilirse okunmuş mesajları, değeri "false" olarak gönderilirse henüz okunmamış mesajları listeler:

  • true
  • false
user_number
string
Example: user_number=1002

Mesajın bırakıldığı dahilinin numarası

uuid
string
Example: uuid=651f8a68-782e-11g7-a6b6-5bedc26e2ab3

Mesajın (veya ilgili CDR kaydının) kayıt numarası

page
integer
Example: page=1

Liste limite göre sayfalanıyor. "total_pages" değerinden maksimum kaç sayfa olduğunu belirleyerek görmek istediğiniz sayfanın numarasını girebilirsiniz

limit
integer
Example: limit=10

Listeyi sınırlayabilirsiniz. Varsayılan değer 10, minimum değer 10, maksimum değer 100

Responses

Response samples

Content type
application/json
{
  • "messages": [
    ],
  • "pagination": {
    }
}

Telesekreterin ses kaydına erişim

CDR'ın ses kaydına erişimde olduğu gibi, bu ses kayıtlarına erişim de iki aşamalıdır. Birinci aşamada URL elde edilir. İkinci aşamada ise o URL'den ses dosyası indirilir/dinlenir. HTTP POST metodu ile api.bulutsantralim.com adresine 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. URL yaşam süresi 1 saattir.

Authorizations:
api_key
query Parameters
uuid
required
string
Example: uuid=12345678-1234-5678-4321-123456789012

URL'ini istediğiniz telesekreter mesajına ait uuid

Responses

Response samples

Content type
text/plain
https://api.bulutsantralim.com/recording/Rbb9d6f36-d1a7-46f5-961e-4be2e2ba1b8e

Rehber Yönetimi

Grup listesine erişim

Santralinizdeki kişi gruplarının listesine erişmek için kullanılır. HTTP GET metodu ile api.bulutsantralim.com/contact_groups adresi çağrılır. İstek başarılı olduğunda HTTP 200 Status kodu ile mesajın Body'sinde gruplar listesi döner. İstek başarısız olduğunda ise ilgili HTTP Status kodu ile mesajın Body'sinde hata mesajı döner.

Authorizations:
api_key

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Grup oluşturma

Yeni bir kişi grubu oluşturur. Google Kişiler entegrasyonunun kapalı olması gerekir. POST metodu ile api.bulutsantralim.com/contact_groups adresine istek gönderilir. İstek başarılı olduğunda HTTP 200 Status kodu ile mesajın Body'sinde oluşturulan grubun ID'si döner. İstek başarısız olduğunda ise ilgili HTTP Status kodu ile mesajın Body'sinde hata mesajı döner.

Authorizations:
api_key
query Parameters
name
required
string
Example: name=Müşteriler

Oluşturulacak grubun adı

Responses

Response samples

Content type
text/plain
20212

Grup güncelleme

Mevcut bir kişi grubunu günceller. Google Kişiler entegrasyonunun kapalı olması gerekir. PATCH metodu ile api.bulutsantralim.com/contact_groups/{id} adresine istek gönderilir. İstek başarılı olduğunda HTTP 200 Status kodu ile mesajın Body'sinde OK döner. İstek başarısız olduğunda ise ilgili HTTP Status kodu ile mesajın Body'sinde hata mesajı döner.

Authorizations:
api_key
path Parameters
id
required
integer
Example: 20212

Güncellenecek grubun ID'si

query Parameters
name
required
string
Example: name=Arkadaşlarım

Grubun yeni adı

Responses

Response samples

Content type
text/plain
OK

Grup silme

Mevcut bir kişi grubunu siler. Google Kişiler entegrasyonunun kapalı olması gerekir. DELETE metodu ile api.bulutsantralim.com/contact_groups/{id} adresine istek gönderilir. İstek başarılı olduğunda HTTP 200 Status kodu ile mesajın Body'sinde OK döner. İstek başarısız olduğunda ise ilgili HTTP Status kodu ile mesajın Body'sinde hata mesajı döner.

Authorizations:
api_key
path Parameters
id
required
integer
Example: 20212

Silinecek grubun ID'si

Responses

Response samples

Content type
text/plain
OK

Kişiler listesine erişim

Santralinizdeki kişiler listesine erişmek için kullanılır. HTTP GET metodu ile api.bulutsantralim.com/contacts adresi parametrelerle çağrılır. İstek başarılı olduğunda HTTP 200 Status kodu ile mesajın Body'sinde kişiler listesi döner. İstek başarısız olduğunda ise ilgili HTTP Status kodu ile mesajın Body'sinde hata mesajı döner.

Authorizations:
api_key
query Parameters
page
integer
Example: page=1

Listenin hangi sayfasında olduğunuz

limit
integer
Example: limit=10

Listeyi sınırlayabilirsiniz. Varsayılan değer 10, minimum değer 10, maksimum değer 100

Responses

Response samples

Content type
application/json
{
  • "contacts": [
    ],
  • "pagination": {
    }
}

Kişi ekleme

Yeni bir kişi oluşturur. Google Kişiler entegrasyonunun kapalı olması gerekir. POST metodu ile api.bulutsantralim.com/contacts adresine istek gönderilir. İstek başarılı olduğunda HTTP 200 Status kodu ile mesajın Body'sinde oluşturulan kişinin ID'si döner. İstek başarısız olduğunda ise ilgili HTTP Status kodu ile mesajın Body'sinde hata mesajı döner.

Authorizations:
api_key
query Parameters
salutation
string

Hitap şekli (Bay, Bayan vb.)

name
required
string
Example: name=Verimor

Ad

surname
required
string
Example: surname=Telekomünikasyon

Soyad

tckn
string
Example: tckn=12345678910

TC kimlik numarası

description
string
Example: description=A.Ş.

Açıklama

phone
required
string
Example: phone=05111111111

GSM numarası 1

phone1
string
Example: phone1=05111111112

GSM numarası 2

email
string
Example: email=info@verimor.com.tr

E-posta adresi

title
string
Example: title=Sabit Telefon Operatörü

Unvan

phone2
string
Example: phone2=02123205062

Ek telefon numarası

fax
string
Example: fax=02123205072

Fax numarası

gender
string
Example: gender=m

Cinsiyet (Erkek: 'm', Kadın: 'f' olarak gönderilmeli)

birthday
string
Example: birthday=01.01.1990

Doğum günü (dd.mm.yyyy formatında olmalı, birthday_sms parametresi 'true' olarak gönderildiği zaman zorunludur)

birthday_sms
boolean
Example: birthday_sms=true

Doğum gününde otomatik mesaj gönderimi. Devreye girmesi için değeri 'true' olarak gönderilmeli

weddingday
string
Example: weddingday=01.01.2018

Evlilik günü (dd.mm.yyyy formatında olmalı, weddingday_sms parametresi 'true' olarak gönderildiği zaman zorunludur)

weddingday_sms
boolean
Example: weddingday_sms=true

Evlilik gününde otomatik mesaj gönderimi. Devreye girmesi için değeri 'true' olarak gönderilmeli

address
string

Adres

note1
string

Kişiyle ilgili notlar

note2
string

Kişiyle ilgili notlar 2

note3
string

Kişiyle ilgili notlar 3

note4
string

Kişiyle ilgili notlar 4

company_name
string
Example: company_name=Verimor Telekomünikasyon

Firma adı

monthly_sms_day
integer
Example: monthly_sms_day=9

Kişiye aylık otomatik SMS gönderilmesini istiyorsanız gönderilecek günü giriniz (1-31 arası)

monthly_sms_message
string
Example: monthly_sms_message=Bu gün ayın dokuzu

Aylık SMS mesajı (monthly_sms_day parametresi girildiği zaman zorunludur)

group_ids
Array of arrays
Example: group_ids=20212&group_ids=20213

Kişinin eklenmesini istediğiniz grubun id değeri

Responses

Response samples

Content type
text/plain
10203

Kişi güncelleme

Mevcut bir kişiyi günceller. Google Kişiler entegrasyonunun kapalı olması gerekir. Kişi eklerken kullanabileceğiniz tüm parametreler güncelleme için de geçerlidir. PATCH metodu ile api.bulutsantralim.com/contacts/{id} adresine istek gönderilir. İstek başarılı olduğunda HTTP 200 Status kodu ile mesajın Body'sinde OK döner. İstek başarısız olduğunda ise ilgili HTTP Status kodu ile mesajın Body'sinde hata mesajı döner.

Authorizations:
api_key
path Parameters
id
required
integer
Example: 10203

Güncellenecek kişinin ID'si

query Parameters
salutation
string

Hitap şekli (Bay, Bayan vb.)

name
string
Example: name=Bulutsantralim

İsim

surname
string

Soyisim

tckn
string

T.C. Kimlik Numarası

description
string

Açıklama

phone
string

Ana telefon numarası

phone1
string

İkinci telefon numarası

email
string

E-posta adresi

title
string

Ünvan

phone2
string

Üçüncü telefon numarası

fax
string

Faks numarası

gender
string

Cinsiyet

birthday
string

Doğum tarihi

birthday_sms
boolean

Doğum günü SMS hatırlatması

weddingday
string

Evlilik yıldönümü tarihi

weddingday_sms
boolean

Evlilik yıldönümü SMS hatırlatması

address
string

Adres

note1
string

Not 1

note2
string

Not 2

note3
string

Not 3

note4
string

Not 4

company_name
string

Şirket adı

monthly_sms_day
integer

Aylık SMS günü (1-31)

monthly_sms_message
string

Aylık SMS mesajı

group_ids
Array of arrays

Kişi grubu ID'leri dizisi

Responses

Response samples

Content type
text/plain
OK

Kişi silme

Mevcut bir kişiyi siler. Google Kişiler entegrasyonunun kapalı olması gerekir. DELETE metodu ile api.bulutsantralim.com/contacts/{id} adresine istek gönderilir. İstek başarılı olduğunda HTTP 200 Status kodu ile mesajın Body'sinde OK döner. İstek başarısız olduğunda ise ilgili HTTP Status kodu ile mesajın Body'sinde hata mesajı döner.

Authorizations:
api_key
path Parameters
id
required
integer
Example: 10203

Silinecek kişinin ID'si

Responses

Response samples

Content type
text/plain
OK

CRM Entegrasyonu

CRM Entegrasyon Ayarlarını Getir

Çağrı olayları (çalma, cevaplanma, kapanma) için mevcut CRM webhook entegrasyon ayarlarını getirir. Bu endpoint ile hangi olaylar için webhook bildirimleri aktif olduğunu ve webhook URL'ini öğrenebilirsiniz.

Authorizations:
api_key

Responses

Response samples

Content type
application/json
Example
{}

CRM Entegrasyon Ayarlarını Güncelle

Çağrı olayları için CRM webhook entegrasyon ayarlarını günceller. Çalma, cevaplanma ve kapanma olayları için bildirimleri etkinleştirir veya devre dışı bırakır. Webhook URL'i de güncellenebilir.

Authorizations:
api_key
query Parameters
ringing
string

Çağrı çalma olayı bildirimlerini etkinleştir/devre dışı bırak:

  • on
  • off
answered
string

Çağrı cevaplanma olayı bildirimlerini etkinleştir/devre dışı bırak

hangup
string

Çağrı kapanma olayı bildirimlerini etkinleştir/devre dışı bırak

notification_url
string

CRM bildirimlerinin gönderileceği webhook URL adresi

Responses

Response samples

Content type
text/plain
Example
OK

Faks Yönetimi

URL isteme

Başarıyla iletilen faks belgesi için geçici indirme URL'si oluşturur. HTTP POST metodu ile api.bulutsantralim.com/fax_document_url/ adresine istek gönderilir. İstek başarılı olduğunda HTTP 200 Status kodu ile mesajın Body'sinde belgeye ait URL döner. URL yaşam süresi 1 saattir ve PDF versiyonuna erişim sağlar. İstek başarısız olduğunda ise ilgili HTTP Status kodu ile mesajın Body'sinde hata mesajı döner.

Authorizations:
api_key
query Parameters
call_uuid
required
string
Example: call_uuid=e28e5d48-05d8-11e8-663a-fde60c59425c

URL'ini istediğiniz faks belgesine ait uuid

Responses

Response samples

Content type
text/plain
https://api.bulutsantralim.com/fax_document/Fbb9d6f36-d1a7-46f5-961e-4be2e2ba1b8e

Faks belgesi indirme/görüntüleme

Bu servis, daha önce 'Faks Belgesi URL'si İsteme Servisi' ile elde edilen geçici URL üzerinden faks belgesini indirmenizi veya görüntülemenizi sağlar.

URL, 1 saat geçerlidir. Herhangi bir kimlik doğrulama gerekmez; güvenlik, URL'nin kendisinde bulunan tek kullanımlık ticket kodu ile sağlanır.

Başarılı isteklerde HTTP 200 ile belge dosyası (PDF/TIFF) döner. Hatalı veya süresi dolmuş ticket ile yapılan isteklerde uygun hata mesajı ve HTTP 400 döner.

Authorizations:
api_key
path Parameters
id
required
string

Faks belgesi indirme/görüntüleme için gerekli ticket kodu (genellikle "F" ile başlar)

Responses

Response samples

Content type
{
  "description": "Binary PDF dosya içeriği",
  "value": "(Binary PDF data)"
}

Tamamlanmamış faks gönderimlerinin listesi

Santraldaki tamamlanmamış faks gönderimlerinin listesine erişmek için kullanılır. HTTP GET metodu ile api.bulutsantralim.com/fax_orders adresi parametrelerle çağrılır. İstek başarılı olduğunda HTTP 200 Status kodu ile mesajın Body'sinde faks gönderim kayıtları döner. İstek başarısız olduğunda ise ilgili HTTP Status kodu ile mesajın Body'sinde hata mesajı döner.

Authorizations:
api_key
query Parameters
page
integer
Example: page=1

Liste limite göre sayfalanıyor. "total_pages" değerinden maksimum kaç sayfa olduğunu belirleyerek görmek istediyiniz sayfanın numarasını girebilirsiniz

limit
integer
Example: limit=10

Listeyi sınırlayabilirsiniz. Varsayılan değer 10, minimum değer 10, maksimum değer 100

Responses

Response samples

Content type
application/json
{
  • "fax_orders": [
    ],
  • "pagination": {
    }
}

Faks gönderimi

Faks göndermek için dosyasının içeriğinin base64 ile kodlanmış halini ve diğer bilgileri POST etmeniz yeterlidir. Uygulamalarınız üzerinden faks göndermek için api.bulutsantralim.com/fax_orders adresi parametrelerle çağrılır. İstek başarılı olduğunda HTTP 200 status kodu ile mesajın Body'sinde faks ID döner. İstek başarısız olduğunda ise ilgili HTTP Status kodu ile mesajın Body'sinde hata mesajı döner.

Authorizations:
api_key
query Parameters
local_station_id
string
Example: local_station_id=908505321234

Gönderici numara (zorunlu değil)

local_station_header
string
Example: local_station_header=Bulutsantralim

Gönderici başlığı

remote_station_id
required
string
Example: remote_station_id=901234567891

Alıcı numara

filedata
required
string

Gönderilecek dosyanın içeriğinin base64 ile kodlanmış hali (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAA... formatında)

Responses

Response samples

Content type
text/plain
20212

Faks listesine erişim

Santralinizdeki faks detay kayıtlarının listesine erişmek için kullanılır. HTTP GET metodu ile api.bulutsantralim.com/fdrs adresi parametrelerle çağrılır. İstek başarılı olduğunda HTTP 200 Status kodu ile mesajın Body'sinde faks kayıtları döner. İstek başarısız olduğunda ise ilgili HTTP Status kodu ile mesajın Body'sinde hata mesajı döner. Tarih aralığı 31 günden uzun olamaz.

Authorizations:
api_key
query Parameters
start_stamp_from
string
Example: start_stamp_from=2018-03-22 12:00:00 UTC

Başlama tarihi yazdığınız tarihten sonra olan çağrıları listeler. "2017-08-03 12:30:32 UTC" formatında olmalı

start_stamp_to
string
Example: start_stamp_to=2018-03-22 23:59:59 UTC

Başlama tarihi yazdığınız tarihe kadar olan çağrıları listeler. "2017-08-03 12:30:32 UTC" formatında olmalı. Tarih aralığı 31 günden uzun olamaz

direction
string

Değeri "inbound" olarak gönderilirse gelen, değeri "outbound" olarak gönderilirse giden, değeri "internal" olarak gönderilirse santral içi faksları listeler:

  • outbound
  • inbound
  • internal
caller_id_number
string
Example: caller_id_number=902129630131

Faks gönderen numara

original_destination
string
Example: original_destination=902123205072

Faks alan numara

success
string

Değeri "true" olarak gönderilirse başarılı, değeri "false" olarak gönderilirse başarısız faksları listeler

page
integer
Example: page=1

Liste limite göre sayfalanıyor. "total_pages" değerinden maksimum kaç sayfa olduğunu belirleyerek görmek istediyiniz sayfanın numarasını girebilirsiniz

limit
integer
Example: limit=10

Listeyi sınırlayabilirsiniz. Varsayılan değer 10, minimum değer 10, maksimum değer 100

Responses

Response samples

Content type
application/json
{
  • "fdrs": [
    ],
  • "pagination": {
    }
}

Otomatik Arama Kampanyaları

Otomatik arama kampanyası oluştur

Yeni otomatik arama kampanyası oluşturmak için kullanılır. JSON formatında parametreler ile POST isteği gönderilir.

Authorizations:
api_key
Request Body schema: application/json
required
call_type
required
string

Otomatik aramanın tipi. "queue" ya da "ivr" olabilir.

queue_number
string

Kuyruk tipi otomatik aramalarda, çağrıların hangi kuyruğa aktarılacağını belirtir.

thread_multiplier
integer

Kuyruk tipi otomatik aramalarda, eşzamanlı olarak, müsait temsilci sayısının kaç katı arama yapılacağını belirtir.

max_thread_count
integer

Kampanya için, eşzamanlı maksimum çağrı sayısını belirtir. Bu parametre belirtilmezse, santralin değerleri referans alınır. (Santral ayarlarında, "Otomatik Arama Kanal Sayısı" değeri referans alınır. Bu ayar için "Otomatik Arama / Sesli Mesaj (Çoklu) modülü gereklidir.)

name
required
string

Kampanyanın adı.

date_range_begin
string

Opsiyonel. Kampanyanın aramaya başlayacağı tarih, YYYY-AA-GG formatında olmalıdır. Gönderilmezse o anki tarih kullanılır.

date_range_end
string

Opsiyonel. Kampanyanın arama bitiş tarihi. YYYY-AA-GG formatında olmalıdır. Gönderilmezse date_range_begin değeri kullanılır.

time_range_begin
string

Opsiyonel. Kampanyanın çalışma saatlerinin başlangıcı. SS:DD (veya S:DD) formatında olmalı. Gönderilmezse "00:00" değeri kullanılır.

time_range_end
string

Opsiyonel. Kampanyanın çalışma saatlerinin bitişi. SS:DD (veya S:DD) formatında olmalı. Gönderilmezse "23:59" değeri kullanılır.

active_days
Array of integers

Kampanyanın çalışma günleri. 1=Pazartesi, 7=Pazar olacak şekilde integer array olarak verilir ve kampanyanın haftanın sadece belirli günleri çalışmasını sağlar.

ring_timeout
integer

Aranan numara çalarken beklenecek süre (saniye), 25 – 60 sn. arasında olabilir.

cli
string

Arayan numara. Karşı taraf bu numarayı görür.

welcome_announcement_id
integer

Aranan numaralara dinletilecek ses dosyasının ID’si. Bu ses dinletilip peşinden tuşlama beklenir. Ses dosyası ID’lerinizi API ile veya Online İşlem Merkezi üzerinden görebilirsiniz.

call_retries
integer

Tekrar arama sayısı. Meşgul, ulaşılamıyor, cevap yok gibi durumlarda numaranın kaç defa daha aranacağını belirtir.

webhook_url
string

Tuşlamaların bildirileceği URL. Doluysa tüm tuşlamalar bu URL’e gönderilir. Kampanya oluşturulurken bu URL’e boş bir POST request’i gönderilip 200 dönmesi beklenir, bu şekilde URL’i doğruluyoruz. Aranan kişi tuşlama yaptıktan sonra bir yere yönlenmeyecekse, sadece tuşlamayı kaydetmek istiyorsanız, tuşa hedef olarak anons verebilirsiniz.

digit_target_0
string

Aranan kişi 0 tuşuna bastığında yönlendirilecek hedef (gerçekleşecek eylem). Verebileceğiniz hedeflerin listesi: 0-9, star, square, timeout, invalid. En az birisi için hedef verilmesi zorunludur.

digit_target_1
string

Aranan kişi 1 tuşuna bastığında yönlendirilecek hedef (gerçekleşecek eylem). Verebileceğiniz hedeflerin listesi: 0-9, star, square, timeout, invalid. En az birisi için hedef verilmesi zorunludur.

digit_target_2
string

Aranan kişi 2 tuşuna bastığında yönlendirilecek hedef (gerçekleşecek eylem). Verebileceğiniz hedeflerin listesi: 0-9, star, square, timeout, invalid. En az birisi için hedef verilmesi zorunludur.

digit_target_3
string

Aranan kişi 3 tuşuna bastığında yönlendirilecek hedef (gerçekleşecek eylem). Verebileceğiniz hedeflerin listesi: 0-9, star, square, timeout, invalid. En az birisi için hedef verilmesi zorunludur.

digit_target_4
string

Aranan kişi 4 tuşuna bastığında yönlendirilecek hedef (gerçekleşecek eylem). Verebileceğiniz hedeflerin listesi: 0-9, star, square, timeout, invalid. En az birisi için hedef verilmesi zorunludur.

digit_target_5
string

Aranan kişi 5 tuşuna bastığında yönlendirilecek hedef (gerçekleşecek eylem). Verebileceğiniz hedeflerin listesi: 0-9, star, square, timeout, invalid. En az birisi için hedef verilmesi zorunludur.

digit_target_6
string

Aranan kişi 6 tuşuna bastığında yönlendirilecek hedef (gerçekleşecek eylem). Verebileceğiniz hedeflerin listesi: 0-9, star, square, timeout, invalid. En az birisi için hedef verilmesi zorunludur.

digit_target_7
string

Aranan kişi 7 tuşuna bastığında yönlendirilecek hedef (gerçekleşecek eylem). Verebileceğiniz hedeflerin listesi: 0-9, star, square, timeout, invalid. En az birisi için hedef verilmesi zorunludur.

digit_target_8
string

Aranan kişi 8 tuşuna bastığında yönlendirilecek hedef (gerçekleşecek eylem). Verebileceğiniz hedeflerin listesi: 0-9, star, square, timeout, invalid. En az birisi için hedef verilmesi zorunludur.

digit_target_9
string

Aranan kişi 9 tuşuna bastığında yönlendirilecek hedef (gerçekleşecek eylem). Verebileceğiniz hedeflerin listesi: 0-9, star, square, timeout, invalid. En az birisi için hedef verilmesi zorunludur.

digit_target_star
string

Aranan kişi yıldız (*) tuşuna bastığında yönlendirilecek hedef (gerçekleşecek eylem). Verebileceğiniz hedeflerin listesi: 0-9, star, square, timeout, invalid. En az birisi için hedef verilmesi zorunludur.

digit_target_square
string

Aranan kişi kare (#) tuşuna bastığında yönlendirilecek hedef (gerçekleşecek eylem). Verebileceğiniz hedeflerin listesi: 0-9, star, square, timeout, invalid. En az birisi için hedef verilmesi zorunludur.

timeout_target
string

Aranan kişi ses kaydını dinledikten sonra digit_timeout süresi içinde bir tuşa basmadığında ve retry_count adedi kadar tekrar denemenin sonunda yönlendirilecek hedef (gerçekleşecek eylem). Verebileceğiniz hedeflerin listesi: 0-9, star, square, timeout, invalid. En az birisi için hedef verilmesi zorunludur.

invalid_target
string

Aranan kişi ses kaydını dinledikten sonra hatalı bir tuşa bastığında ve retry_count adedi kadar tekrar denemenin sonunda yönlendirilecek hedef (gerçekleşecek eylem). Verebileceğiniz hedeflerin listesi: 0-9, star, square, timeout, invalid. En az birisi için hedef verilmesi zorunludur.

digit_retries
integer

Tuşlama tekrar sayısı. Geçersiz tuşlama yapıldığında veya hiç tuşlama yapılmayıp digit_timeout süresi dolduğunda, ilgili uyarı okunup Menü baştan okunur.

digit_timeout
integer

Opsiyonel. Min:1, Maks:10, Varsayılan 4'tür. Ses kaydı dinletildikten sonra burada belirtilen süre kadar bekletilip senaryoya göre ya zaman aşımı hedefine aktarılır ya da menü baştan okutulur.

required
Array of objects

Aranacak numara listesi (zorunlu). "phone" aranacak numaradır, "905111111111" veya "05111111111" veya "5111111111" veya uluslararası için "00491234567" şeklinde olmalıdır, "phone" sahası zorunludur. "phrase" sahası bu numaraya okunacak özel mesajı belirtir, formatı için aşağıda Cümle (phrase) Formatı başlığına bakınız. "phrase" sahası zorunlu değildir. "lang" sahası, mesajın hangi dilde okunacağını belirtir. Zorunlu değildir. Geçerli diller: "tr-TR", "en-US" ve "ar-XA".

is_commercial
boolean

Opsiyonel. true | false değeri alır. Varsayılan false. Ticari gönderimlerde true olarak belirlemelisiniz.

iys_recipient_type
string

"BIREYSEL" ya da "TACIR" olmalıdır. Ticari gönderimlerde bu alanı zorunlu olarak göndermelisiniz.

iys_brand_code
string

Sistemde kayıtlı ve onaylı başlıklarınızdan birinin "İYS Marka Kodu" değeri olmalıdır. Ticari gönderimlerde bu alanı zorunlu olarak göndermelisiniz.

recording_enabled
boolean

Arama başlar başlamaz kayıt yapılmasını istiyorsanız bu parametreye "true" (String) ya da "t" vermelisiniz.

Responses

Request samples

Content type
application/json
{
  • "call_type": "ivr",
  • "queue_number": "100",
  • "thread_multiplier": 2,
  • "max_thread_count": 10,
  • "name": "Memnuniyet anketi",
  • "date_range_begin": "2025-07-25",
  • "date_range_end": "2025-07-26",
  • "time_range_begin": "09:00",
  • "time_range_end": "18:00",
  • "active_days": [
    ],
  • "ring_timeout": 30,
  • "cli": "908505320000",
  • "welcome_announcement_id": 123,
  • "call_retries": 2,
  • "webhook_url": "https://webhook.site/xxxx",
  • "digit_target_0": "queue/100",
  • "digit_target_1": "queue/101",
  • "digit_target_2": "queue/102",
  • "digit_target_3": "queue/103",
  • "digit_target_4": "queue/104",
  • "digit_target_5": "queue/105",
  • "digit_target_6": "queue/106",
  • "digit_target_7": "queue/107",
  • "digit_target_8": "queue/108",
  • "digit_target_9": "queue/109",
  • "digit_target_star": "queue/star",
  • "digit_target_square": "queue/square",
  • "timeout_target": "queue/timeout",
  • "invalid_target": "queue/invalid",
  • "digit_retries": 2,
  • "digit_timeout": 4,
  • "phone_list": [
    ],
  • "is_commercial": false,
  • "iys_recipient_type": "BIREYSEL",
  • "iys_brand_code": "BRAND123",
  • "recording_enabled": true
}

Response samples

Content type
text/plain
20212

Otomatik arama kampanyasını başlat/durdur

Otomatik arama kampanyasını durdurmak veya tekrar başlatmak için kullanılır. PATCH ile status=off gönderilirse kampanya durur, status=on gönderilirse tekrar başlar.

Authorizations:
api_key
path Parameters
id
required
string

IVR Campaign ID

query Parameters
status
required
string

Kampanya durumu: "on" başlatmak için, "off" durdurmak için:

  • on
  • off

Responses

Response samples

Content type
text/plain
Ok

Otomatik arama kampanyasını sil

Otomatik arama kampanyasını iptal etmek/silmek için kullanılır. Kampanya ID'si ve API anahtarı ile DELETE isteği gönderilir.

Authorizations:
api_key
path Parameters
id
required
string

IVR Campaign ID

Responses

Response samples

Content type
text/plain
OK

Kuyruk Yönetimi

Kuyruklar listesine erişim

Santralinizdeki kuyrukların listesine erişmek 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 kuyrukların listesi döner. İstek başarısız olduğunda ise ilgili HTTP Status kodu ile mesajın Body'sinde hata mesajı döner.

Authorizations:
api_key

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Kuyrukta bekleyenler listesine erişim

Santralinizdeki kuyrukta bekleyenlerin listesine erişmek 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 kuyrukta bekleyenlerin listesi döner. İstek başarısız olduğunda ise ilgili HTTP Status kodu ile mesajın Body'sinde hata mesajı döner.

Authorizations:
api_key

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Kuyruğa dahili ekleme, çıkarma veya yer değiştirme

Santralinizdeki kuyruklara dahili ekleme, çıkarma veya yer değiştirme 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 OK döner. İstek başarısız olduğunda ise ilgili HTTP Status kodu ile mesajın Body'sinde hata mesajı döner.

Authorizations:
api_key
query Parameters
queue_number
required
string
Example: queue_number=200

Dahili ayarını değiştirmek istediğiniz kuyruğun numarası

user_list
required
string
Example: user_list=1000,1001,1002

Kuyruğa dahili eklemek, çıkarmak veya yerini değiştirmek için göndermeniz gereken değer (virgülle ayrılmış)

Responses

Response samples

Content type
text/plain
OK

Kuyruktaki dahili listesine erişim

Santralinizdeki kuyruğun dahili sırasını listeler. 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 dahili listesi döner. İstek başarısız olduğunda ise ilgili HTTP Status kodu ile mesajın Body'sinde hata mesajı döner.

Authorizations:
api_key
query Parameters
queue_number
required
string
Example: queue_number=200

Kuyruk numarası

Responses

Response samples

Content type
application/json
Example
[
  • {
    },
  • {
    },
  • {
    }
]