Ana içeriğe geç

Kara listeyi öğrenme

GET 

/blacklist

İstek: GET https://ext-api.netgsm.com.tr/sms/v3/blacklist
Canlı ortam: https://ext-api.netgsm.com.tr/sms/v3

Hesabın kara listesindeki numaraları döndürür. İki kullanımı vardır:

  • Liste: number verilmezse kara listenin tamamı sayfa sayfa döner. Her sayfada pageTotal kadar numara bulunur (varsayılan 200, en fazla 1000), en son eklenen önce gelir. İlk sayfa 0'dır.
  • Numara sorgusu: number verilirse yalnızca verilen numaralara bakılır; virgülle ayırarak bir istekte en fazla 100 numara sorulabilir. Yanıtta yalnızca verilen numaralardan kara listede olanlar yer alır, başka hiçbir numara dönmez; hiçbiri kara listede değilse count 0 ve numbers boştur.

Numaralar istekte de yanıtta da E.164 biçimindedir ve kara liste yalnızca yurt içi numara tutar: bir numara +90 ve on rakam olarak yazılır (+905XXXXXXXXX), yanıttaki numaralar da bu biçimde döner. Artısız yazımlar (905XXXXXXXXX, 5XXXXXXXXX) ve başka ülke kodlu numaralar 400 alır.

Kara listede numara olmaması ya da listenin sonunu geçen bir sayfanın istenmesi hata değildir; yanıt count 0 ve boş numbers ile başarılı döner.

Request​

Query Parameters

    page integer

    Possible values: >= 0

    İstenen sayfa, 0'dan başlar. Tek numara sorgusunda yanıtı etkilemez.

    Default value: 0
    pageTotal integer

    Possible values: >= 1 and <= 1000

    Bir sayfadaki numara sayısı. En fazla 1000; daha büyük ya da 1'den küçük bir değer 400 alır ve message en fazla 1000 olabileceğini belirtir (pageTotal must be between 1 and 1000).

    Default value: 200
    number string

    Possible values: Value must match regular expression ^\s*(\+90\d{10})?(\s*,\s*(\+90\d{10})?)*\s*$

    Sorgulanacak numara ya da virgülle ayrılmış numaralar (en fazla 100; fazlası 400 alır). Her numara E.164 biçiminde ve yurt içi olmalıdır, +90 ve on rakam (+905XXXXXXXXX); sorgu parametresinde + işareti %2B olarak kodlanır. Artısız yazımlar ve başka ülke kodlu numaralar dahil başka her şey 400 alır, message number must be in +90XXXXXXXXXX format. Yanıttaki number yazıldığı biçimde döner. Baştaki ve sondaki boşluklar kırpılır; boş bir değer number hiç gönderilmemiş gibi değerlendirilir.

    Example: +905XXXXXXXXX

Responses​

Bir sayfa ya da tek bir numara hakkındaki yanıt.

Schema
    countintegerrequired

    numbers içindeki numara sayısı. Tek numara sorgusunda 0, numaranın kara listede olmadığını gösterir.

    pageintegernullablerequired

    Döndürülen, sıfırdan başlayan sayfa. Tek numara sorgusunda null.

    numberstringnullablerequired

    Sorgulanan numara ya da numaralar, yazıldığı gibi geri döndürülür. Sayfa isteğinde null.

    numbersstring[]required

    Engellenen numaralar E.164 biçiminde (+90 ve on rakam), en yenisi önce. Bir sayfada en fazla pageTotal kadar, yani en çok 1000 numara.

    Possible values: <= 1000

Örnek istek​

curl -X GET 'https://ext-api.netgsm.com.tr/sms/v3/blacklist?number=%2B905XXXXXXXXX' \
-H 'Authorization: Bearer <token>'