Ana içeriğe geç

Sesli mesaj başlatma

  • Sesli Mesaj API ile, sesli mesajlarınızı senaryonuza göre basit ya da dinamik şekilde başlatabilirsiniz. Sistemimize yüklü ses dosyanız ya da göndereceğiniz textin tarafımızda ses dosyasına dönüşümü ile Sesli Mesaj başlatabilirsiniz,

  • Ses dosyası yükleyebilir,

  • Gelen Sesli Mesajları listeleyebilir,

  • Başlattığınız Sesli Mesajların durumlarını sorgulayarak Raporlama yapabilirsiniz.

  • Sesli mesaj senaryoları bir adet tuşlama yapacak şekilde gerçekleştirebilir.

  • Sesli mesaj gönderimlerinizde JSON POST ve XML POST yöntemlerini kullanabilirsiniz.

Basit Sesli Mesaj​

  • Sesli Mesajlarınızı API ile gönderebilirsiniz.

  • startdate, starttime, stopdate ve stoptime parametrelerini belirtmezseniz sesli mesaj anlık olarak başlatılır.

POST https://api.netgsm.com.tr/voicesms/send

Örnek Tuşlamasız Metin Okutma İstek (Sample Request Text-to-Speech Without Keying)​

<?xml version='1.0'?>
<mainbody>
    <header>
        <usercode>850xxxxxxx</usercode>
        <password>xxxxxxxx</password>
    </header>
    <body>
        <text>okunacak metin</text>
        <no>510xxxxxxx</no>
    </body>
</mainbody>

Örnek Tuşlamalı Metin Okutma İstek (Sample Request Text-to-Speech With Keying)​

<?xml version='1.0'?>
<mainbody>
    <header>
        <usercode>850xxxxxxx</usercode>
        <password>xxxxxxxx</password>
        <key>1</key>          
    </header>
    <body>
        <text>Ses kayıtlarını dinleyebilmek için 1 veya 2'yi tuşlayın</text>
        <no>510xxxxxxx</no>
        <keys>
            <keydetail>
                <keyinfo>1</keyinfo>
                <text>1'i tuslayanlara okutulacak metin</text>
            </keydetail>
            <keydetail>
                <keyinfo>2</keyinfo>
                <text>2'yi tuslayanlara okutulacak metin</text>
            </keydetail>
        </keys>
    </body>
</mainbody>

Örnek Tuşlamasız Ses Dinletme İstek (Sample Request Audio Without Keying)​

<?xml version='1.0'?>
<mainbody>
    <header>
        <usercode>850xxxxxxx</usercode>
        <password>xxxxxxxx</password>        
    </header>
    <body>
        <audioid>153533506</audioid>
        <no>510xxxxxxx</no>
    </body>
</mainbody>

Örnek Tuşlamalı Ses Dinletme İstek (Sample Request Audio With Keying)​

<?xml version='1.0'?>
<mainbody>
    <header>
        <usercode>850xxxxxxx</usercode>
        <password>xxxxxxxx</password>
        <key>1</key>          
    </header>
    <body>
        <audioid>153533506</audioid>
        <no>510xxxxxxx</no>
        <keys>
            <keydetail>
                <keyinfo>1</keyinfo>
                <text>1'i tuslayanlara okutulacak metin</text>
            </keydetail>
            <keydetail>
                <keyinfo>2</keyinfo>
                <text>2'yi tuslayanlara okutulacak metin</text>
            </keydetail>
        </keys>
    </body>
</mainbody>

Örnek Başarılı Cevap (Success Response)​

00 123456

Açıklamalar:
00 -> Yanıt Kodu
123456 -> GörevID

Örnek Hata Cevabı (Error Response)​

HataKodu

** Tanımlar **

DeğişkenZorunluAnlamı
usercodeEvetNetgsm'den hizmet alınan abone numarası (Format: 850xxxxxxx, 312XXXXXXX vs.).
passwordEvetAlt kullanıcı şifresi. (Alt kullanıcı türü "API Kullanıcısı" olan alt kullanıcıya ait şifre.)
startdateOpsiyonelGönderime başlayacağınız tarih. (Format: ddMMyyyy) *header kısmında gönderilir.
starttimeOpsiyonelMesajın gönderilmeye başlanacağı saat. (Format: ssdd) *header kısmında gönderilir.
stopdateOpsiyonelİki tarih arası gönderimlerinizde bitiş tarihi.(Format: ddMMyyyy) *Başlangıç ve bitiş tarihleri arasında en az 1 saat en fazla 21 saat olmalıdır. header kısmında gönderilir.
stoptimeOpsiyonelMesaj gönderimi bitiş saati. (Format: ssdd) *header kısmında gönderilir.
keyOpsiyonel1: ses kaydının sonunda tuşa basılmasını istiyorum, 2: ses kaydının sonunda tuşa basılmasını istemiyorum. *header kısmında gönderilir.
relationidOpsiyonelTarafınızda belirleyeceğiniz bir random sayı ile sesli mesaj başlattığınızda, Raporlama servisini sorguladığınızda relationID bilgisi de dönecektir. *header kısmında gönderilir.
urlOpsiyonelSesli mesajın durumunun (raporunun) post edilmesini istediğiniz URL bilgisi. *header kısmında gönderilir.
audioidEvet/OpsiyonelGönderilmek istenen sesid, sisteme daha önce yüklemiş olmanız gerekir. *text veya audioid gönderilmesi zorunludur.
textEvet/OpsiyonelGönderilmek istenen metin. *text veya audioid gönderilmesi zorunludur.
noEvetMesajın gönderildiği telefon numarası.
keysEvet/OpsiyonelSesli mesaj başlattıktan sonra, karşı taraftan istenen tuşlama bilgisi ile arama başlattığınız numaraya, tekrar bir metin ya da ses dosyası dinletmek için kullanılır.
keydetailEvet/OpsiyonelTuşlama bilgisi ile işlem yapılacaksa gönderilir. Gönderilecek tuş bilgisi kadar bu parametreyi de göndermek gereklidir.
keyinfoEvet/OpsiyonelTuş bilgisi bu parametre ile gönderilir. Bu parametre sonrasında audioID ya da text bilgisi içeren parametre göndermeniz zorunludur.
filterOpsiyonelTicari içerikli sesli mesaj gönderimlerinde bu parametreyi kullanabilirsiniz. Ticari içerikli bireysele gönderilecek numaralar için İYS kontrollü gönderimlerde ise "11" değerini, tacire gönderilecek İYS kontrollü gönderimlerde ise "12" değerini almalıdır. Bilgilendirme amaçlı gönderilen içeriklerde (İYS kontrolü sağlanmadan gönderilen) "0" değerini almalıdır. *Varsayılan olarak 0 değerini alır.
ringtimeOpsiyonelSesli mesaj için yapılan aramada telefonun çalma süresi. (min 10 - max 30 sn)

** Örnek Yanıt **

KoduAnlamı
00Görevinizin tarih formatında bir hata olmadığını gösterir.
01Mesaj gönderim başlangıç tarihinde hata var. Sistem tarihi ile değiştirilip işleme alındı.
02Mesaj gönderim sonlandırılma tarihinde hata var. Sistem tarihi ile değiştirilip işleme alındı. Bitiş tarihi başlangıç tarihinden küçük girilmiş ise, sistem bitiş tarihine içinde bulunduğu tarihe 24 saat ekler.
123456Gönderdiğiniz sesli mesajın başarıyla sistemimize ulaştığını gösterir. Bu GörevID'niz ile mesajınızın durumunu sorguyabilirsiniz.

** Hata Durumları **

Hata KoduAnlamı
30Geçersiz kullanıcı adı, şifre veya kullanıcınızın API erişim izninin olmadığını gösterir. Ayrıca eğer API erişiminizde IP sınırlaması yaptıysanız ve sınırladığınız ip dışında gönderim sağlıyorsanız 30 hata kodunu alırsınız. API erişim izninizi veya IP sınırlamanızı, web arayüzümüzden; sağ üst köşede bulunan Abonelik İşlemleri / API işlemleri menüsunden kontrol edebilirsiniz.
40Ses dosyasının olmadığını ifade eder.
45Gönderilecek telefon numarasının bulunmadığını ifade eder.
70Hatalı sorgulama. Gönderdiğiniz parametrelerden birisi hatalı veya zorunlu alanlardan birinin eksik olduğunu ifade eder.

Dinamik Sesli Mesaj​

  • Senaryonuza göre sırası belirlenmiş şekilde gönderdiğiniz yüklü ses dosyaları ya da textlerinizle sesli mesajınız başlatılır. 1:n mantığı ile bir sesli mesajı birden fazla numaraya başlatabilirsiniz.

  • startdate, starttime, stopdate ve stoptime parametrelerini belirtmezseniz sesli mesaj anlık olarak başlatılır.

POST https://api.netgsm.com.tr/voicesms/send

Örnek JSON İstek (Sample Request)​

{
  "header":{
      "username":"850xxxxxxx",
      "password":"xxxxxxxx",
      "key":"1"
  },
  "body":{
      "scenario":{
        "series":[
            {
              "seri":"1",
              "text":"test mesajı"
            },
            {
              "seri":"2",
              "audioid":"153533506"
            }
        ],
        "numbers":[
            {
              "no":"5XXXXXXXXX",
              "no":"5XXXXXXXXX"
            }
        ],
        "keys":[
            {
              "keyinfo":"1",
              "text":"test bir "
            },
            {
              "keyinfo":"2",
              "text":"test iki"
            }
        ]
      }
  }
}

Örnek XML İstek (Sample Request)​

<?xml version="1.0" encoding="UTF-8"?>
<mainbody>
    <header>
    	<usercode>850xxxxxxx</usercode>
    	<password>xxxxxxxx</password>
    	<key>1</key>
    </header>
    <body>
    	<voicemail>
    		<scenario>
    			<series s="1">
    				<text>sese çevrilmesi istenen metin 1</text>
    			</series>
    			<series s="2">
    				<audioid>12768046</audioid>
    			</series>
    			<series s="3">
    				<text>sese çevrilmesi istenen metin 2</text>
    			</series>
    			<number>
    				<no>0xxxxxxxx</no>
    			</number>
    			<keys>
    				<keydetail>
    					<keyinfo>1</keyinfo>
    					<text>1i tuslayanlara okutulacak metin</text>
    				</keydetail>
    				<keydetail>
    					<keyinfo>2</keyinfo>
    					<audioid>12768046</audioid>
    				</keydetail>
    			</keys>
    		</scenario>
    	</voicemail>
    </body>
</mainbody>

Örnek Başarılı Cevap (Success Response)​

00 123456

Açıklamalar:
00 -> Yanıt Kodu
123456 -> GörevID

Örnek Hata Cevabı (Error Response)​

HataKodu

** Tanımlar **

DeğişkenZorunluAnlamı
usercodeEvetNetgsm'den hizmet alınan abone numarası (Format: 850xxxxxxx, 312XXXXXXX vs.).
passwordEvetAlt kullanıcı şifresi. (Alt kullanıcı türü "API Kullanıcısı" olan alt kullanıcıya ait şifre.)
startdateOpsiyonelGönderime başlayacağınız tarih. (Format: ddMMyyyy) *header kısmında gönderilir.
starttimeOpsiyonelMesajın gönderilmeye başlanacağı saat. (Format: ssdd) *header kısmında gönderilir.
stopdateOpsiyonelİki tarih arası gönderimlerinizde bitiş tarihi.(Format: ddMMyyyy) *Başlangıç ve bitiş tarihleri arasında en az 1 saat en fazla 21 saat olmalıdır. header kısmında gönderilir.
stoptimeOpsiyonelMesaj gönderimi bitiş saati. (Format: ssdd) *header kısmında gönderilir.
keyOpsiyonel1: ses kaydının sonunda tuşa basılmasını istiyorum, 2: ses kaydının sonunda tuşa basılmasını istemiyorum. *header kısmında gönderilir.
relationidOpsiyonelTarafınızda belirleyeceğiniz bir random sayı ile sesli mesaj başlattığınızda, Raporlama servisini sorguladığınızda relationID bilgisi de dönecektir. *header kısmında gönderilir.
urlOpsiyonelSesli mesajın durumunun (raporunun) post edilmesini istediğiniz URL bilgisi. *header kısmında gönderilir.
audioidEvet/OpsiyonelGönderilmek istenen sesid, sisteme daha önce yüklemiş olmanız gerekir. *text veya audioid gönderilmesi zorunludur.
textEvetGönderilmek istenen metin. *text veya audioid gönderilmesi zorunludur.
noEvetMesajın gönderildiği telefon numarası.
keysEvet/OpsiyonelSesli mesaj başlattıktan sonra, karşı taraftan istenen tuşlama bilgisi ile arama başlattığınız numaraya, tekrar bir metin ya da ses dosyası dinletmek için kullanılır.
keydetailEvet/OpsiyonelTuşlama bilgisi ile işlem yapılacaksa gönderilir. Gönderilecek tuş bilgisi kadar bu parametreyi de göndermek gereklidir.
keyinfoEvet/OpsiyonelTuş bilgisi bu parametre ile gönderilir. Bu parametre sonrasında audioID ya da text bilgisi içeren parametre göndermeniz zorunludur.
filterOpsiyonelTicari içerikli sesli mesaj gönderimlerinde bu parametreyi kullanabilirsiniz. Ticari içerikli bireysele gönderilecek numaralar için İYS kontrollü gönderimlerde ise "11" değerini, tacire gönderilecek İYS kontrollü gönderimlerde ise "12" değerini almalıdır. Bilgilendirme amaçlı gönderilen içeriklerde (İYS kontrolü sağlanmadan gönderilen) "0" değerini almalıdır. *Varsayılan olarak 0 değerini alır.
ringtimeOpsiyonelSesli mesaj için yapılan aramada telefonun çalma süresi. (min 10 - max 30 sn)

** Örnek Yanıt **

KoduAnlamı
00Görevinizin tarih formatında bir hata olmadığını gösterir.
01Mesaj gönderim başlangıç tarihinde hata var. Sistem tarihi ile değiştirilip işleme alındı.
02Mesaj gönderim sonlandırılma tarihinde hata var. Sistem tarihi ile değiştirilip işleme alındı. Bitiş tarihi başlangıç tarihinden küçük girilmiş ise, sistem bitiş tarihine içinde bulunduğu tarihe 24 saat ekler.
123456Gönderdiğiniz sesli mesajın başarıyla sistemimize ulaştığını gösterir. Bu GörevID'niz ile mesajınızın durumunu sorguyabilirsiniz.

** Hata Durumları **

Hata KoduAnlamı
30Geçersiz kullanıcı adı, şifre veya kullanıcınızın API erişim izninin olmadığını gösterir. Ayrıca eğer API erişiminizde IP sınırlaması yaptıysanız ve sınırladığınız ip dışında gönderim sağlıyorsanız 30 hata kodunu alırsınız. API erişim izninizi veya IP sınırlamanızı, web arayüzümüzden; sağ üst köşede bulunan Abonelik İşlemleri / API işlemleri menüsunden kontrol edebilirsiniz.
40Ses dosyasının olmadığını ifade eder.
45Gönderilecek telefon numarasının bulunmadığını ifade eder.
70Hatalı sorgulama. Gönderdiğiniz parametrelerden birisi hatalı veya zorunlu alanlardan birinin eksik olduğunu ifade eder.