Ana içeriğe geç

OTP SMS gönderme

POST 

/send/otp

İstek: POST https://ext-api.netgsm.com.tr/sms/v3/send/otp
Canlı ortam: https://ext-api.netgsm.com.tr/sms/v3

Tek bir alıcıya OTP (tek kullanımlık şifre) SMS'i gönderir. OTP, toplu SMS'ten ayrı bir kanaldan anında gönderilir; her istek tek bir mesaj ve tek bir alıcıdır. 202 döndüğünde mesaj operatöre iletilmiştir, teslim sonradan olur.

Değerlerin işlenmesi. Numara, gönderici ve metin gönderimden önce şu şekilde işlenir:

Alanİşlem
recipientYalnızca E.164 biçiminde, +90 ve on rakam: +905XXXXXXXXX. Başka yazımlar ve yurt dışı numaraları 400 alır.
senderBüyük/küçük harf fark etmez. Abone numarası 5XXXXXXXXX, 05XXXXXXXXX ya da 905XXXXXXXXX yazılabilir.
textBaştaki ve sondaki boşluklar kırpılır; karakterler aşağıdaki tabloya göre çevrilir. Uzunluk çevrilmiş metin üzerinden sayılır.

İstek sınırı. Hesap başına dakikada 30.000 istek. Süre penceresi ilk istekle başlar ve sabittir. Sonucu ne olursa olsun her istek sayılır. Aşıldığında 429 Retry-After başlığıyla döner.

Yeniden deneme. 503 hiçbir şeyin gönderilmediğini gösterir; yeniden denemek güvenlidir.

Raporlar. OTP iletim raporları toplu gönderim raporlarından ayrı tutulur; jobId GET /report ile sorgulanamaz.

Request​

Header Parameters

    x-client string

    Kurumsal OTP hizmeti tanımlı hesaplar enterprise göndermelidir (küçük harfle, yazıldığı gibi). Diğer hesaplar bu başlığı göndermez.

Bodyrequired

    senderstringrequired

    Gönderici başlığı: hesaba kayıtlı bir alfanümerik başlık (örneğin NETGSM) ya da hesabın abone numarası. Büyük/küçük harf fark etmez. Abone numarası 5XXXXXXXXX, 05XXXXXXXXX ya da 905XXXXXXXXX yazılabilir. Kayıtlı başlıkları GET /senders ile görebilirsiniz.

    Possible values: non-empty

    Example: NETGSM
    textstringrequired

    OTP metni. Baştaki ve sondaki boşluklar kırpılır, karakterler gönderimden önce çevrilir:

    MetindeGönderilen
    ç ğ ı ö ş ü Ç Ğ İ Ö Ş Üc g i o s u C G I O S U
    { [ / } ]( / )
    “ ” `"
    ‘ ’'
    ~?
    €;EO;
    sekme, |boşluk
    ^silinir
    satır sonu\n (iki karakter)
    diğer desteklenmeyen karakterler?

    OTP her zaman tek SMS'tir. Çevrilmiş metin alfanümerik başlıkta en fazla 155, abone numarasında en fazla 160 karakter olabilir; alfanümerik başlıkta sınır daha kısadır, çünkü operatör kodu metnin sonuna eklenir.

    Possible values: non-empty

    Example: Dogrulama kodunuz: 123456
    recipientstringrequired

    Alıcı, bir Türkiye cep numarası. Yalnızca E.164 biçiminde, +90 ve on rakam olarak yazılır: +905XXXXXXXXX. Başka yazımlar, boşluk ya da yurt dışı numarası kabul edilmez.

    Possible values: non-empty

    Example: +905XXXXXXXXX
    appNamestring

    Gönderimi yapan uygulamanın adı. Yalnızca kayıt amaçlıdır.

Responses​

OTP operatöre iletildi.

Schema
    jobIdstringrequired

    OTP gönderiminin kimliği. Bir sorun bildirirken paylaşmalısınız.

    Example: 175518151237512050610525430

Örnek istek​

curl -X POST 'https://ext-api.netgsm.com.tr/sms/v3/send/otp' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{
"sender": "NETGSM",
"text": "Dogrulama kodunuz: 123456",
"recipient": "+905XXXXXXXXX",
"appName": "shop"
}'