Rehbere SMS gönderme

POST 
/directory/send

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

Rehberdeki kişi gruplarına, istekte verilen kişilere ya da her ikisine tek bir metinle gönderimi kuyruğa alır. Gruplar ve kişiselleştirme, yanıt döndükten sonra işlenir.

• En az bir grup (groupIds) ya da kişi (contacts) belirtmelisiniz. Yalnızca numaralara göndermek için POST /send'i kullanın.
• UNICODE kodlaması bu uç noktada desteklenmez.
• Onay için bekletilen bir görev de 202 alır; neyin beklettiğini review söyler.

İstek sınırı. Hesap başına dakikada 60 istek, /send sınırından ayrı. Süre penceresi ilk istekle başlar ve sabittir. Aşıldığında 429 Retry-After başlığıyla döner.

Yeniden deneme. Aynı istek iki kez gönderilirse iki görev oluşur ve gruplara iki kez mesaj gider. 503 ya da 504 aldıysanız yeniden göndermeden önce GET /report ile kontrol etmelisiniz.

Request

application/json

Bodyrequired

senderstringrequired

Gönderici başlığı, POST /send'deki gibi: hesaba kayıtlı bir başlıkla yazıldığı gibi birebir eşleşmelidir, büyük/küçük harf dahil. Eşleşmezse istek 422 REJECTED_HEADER ile reddedilir.

Possible values: non-empty and <= 35 characters

Example: NETGSM

textstringrequired

Mesaj metni; tüm alıcılara aynı metin gider, addressType ile kişiselleştirilebilir. En fazla uzunluk DEFAULT için 917, TURKISH için 888 karakterdir (çğışĞİŞ iki karakter sayılır); alfanümerik bir gönderici başlığında her sınır 5 karakter azdır. Sınırı aşan metin 400 ile reddedilir.

Possible values: non-empty and <= 917 characters

encodingstring

Metnin karakter kodlaması, POST /send'deki gibi. Büyük/küçük harfe duyarlıdır. UNICODE bu uç noktada 400 ile reddedilir.

Possible values: [DEFAULT, TURKISH]

Default value: DEFAULT

iysFilterstring

İYS filtresi; değerler POST /send'deki gibidir ve büyük/küçük harf fark etmez. Listede olmayan bir değer NONE sayılır. Filtreyi platform uygular; bu başlık ya da hesap için uygulanamıyorsa istek 422 REJECTED_IYS ile reddedilir.

Possible values: [NONE, BRAND, RETAILER, BRAND_AND_RETAILER]

Default value: NONE

groupIdsint64[]

Hesabın rehberindeki kişi grupları.

contacts object[]

Array [

numberstringrequired

Alıcının numarası. Biçimini platform denetler.

Possible values: non-empty and <= 20 characters

namestring

Alıcının adı. İsteğe bağlı.

Possible values: <= 100 characters

surnamestring

Alıcının soyadı. İsteğe bağlı.

Possible values: <= 100 characters

addressstring

Kişiye özel hitap, örneğin "Sayın". Kullanılıp kullanılmayacağını addressType belirler. İsteğe bağlı.

Possible values: <= 500 characters

]

recipientsstring[]

Kişiselleştirme uygulanmayan düz numaralar. Yalnızca groupIds ya da contacts ile birlikte kullanılabilir. Numaranın biçimini platform denetler.

address1string

Tüm alıcılar için aynı olan ön hitap, örneğin "Sayın". Kullanılıp kullanılmayacağını addressType belirler.

Possible values: <= 500 characters

address2string

Tüm alıcılar için aynı olan son hitap, örneğin "Bey/Hanım,". Kullanılıp kullanılmayacağını addressType belirler.

Possible values: <= 500 characters

addressTypeinteger

Mesaj metninin başına hangi kişisel bilgilerin ekleneceğini belirler. Seçilen parçalar aşağıdaki sırayla ve aralarında birer boşlukla metnin başına eklenir; alıcıda boş olan parça atlanır. 0 ile 17 dışındaki bir değer INVALID_REQUEST ile reddedilir.

• Ad ve soyad, rehberdeki kişi kaydından ya da contacts içindeki name ve surname alanlarından gelir.
• Kişi hitabı, rehberdeki kişinin hitap bilgisi ya da contacts içindeki address alanıdır; her alıcı için ayrıdır.
• recipients içinde düz numara olarak verilen alıcılara kişiselleştirme uygulanmaz.

Değer	Metnin başına eklenen
0	Hiçbir şey; metin olduğu gibi gönderilir (varsayılan)
1	address1 + ad
2	address1 + ad + soyad
3	address1 + soyad
4	address1 + ad + address2
5	address1 + ad + soyad + address2
6	address1 + soyad + address2
7	ad
8	soyad
9	ad + soyad
10	kişi hitabı
11	kişi hitabı + ad
12	kişi hitabı + ad + soyad
13	kişi hitabı + soyad
14	kişi hitabı + address2
15	kişi hitabı + ad + address2
16	kişi hitabı + ad + soyad + address2
17	kişi hitabı + soyad + address2

Örnek: addressType 5, address1 "Sayın", address2 "Bey," ve metin "siparişiniz kargoya verildi." ise Ahmet Yılmaz'a giden mesaj "Sayın Ahmet Yılmaz Bey, siparişiniz kargoya verildi." olur.

Possible values: >= 0 and <= 17

Default value: 0

startAtdate-time

En erken gönderim zamanı, saat dilimi farkıyla. Europe/Istanbul saatine çevrilir ve dakikaya yuvarlanır; saniyeler dikkate alınmaz.

stopAtdate-time

En geç gönderim zamanı, saat dilimi farkıyla; startAt gibi dakikaya yuvarlanır. startAt'tan 1 ile 21 saat sonra olmalıdır. Aralığı platform denetler; kabul etmezse istek 400 INVALID_SEND_WINDOW ile reddedilir.

Responses

202

Kuyruğa alındı. Gönderim, gönderim aralığı içinde yapılır.

application/json

Schema

Schema

jobIdstringrequired

Oluşturulan görevin numarası. Rapor ve istatistik için kullanılır; destek taleplerinde belirtmelisiniz.

statusstringrequired

Her zaman QUEUED; startAt ileride olsa da.

Possible values: [QUEUED]

reviewstringrequired

Görevin gönderilmeden önce bekletilip bekletilmediği:

Değer	Anlamı
NONE	Bekletilmedi; gönderim aralığında gönderilir.
ADMIN_APPROVAL	Yönetici onayı bekliyor: hesap onay kontrolünde ya da gönderim hesabın sınırından büyük.
FORBIDDEN_WORD	Metin yasaklı bir kelime içerdiği için bekletiliyor.
UNKNOWN	Görev kuyruğa alındı ama bekletme nedeni bilinmiyor.

Possible values: [NONE, ADMIN_APPROVAL, FORBIDDEN_WORD, UNKNOWN]

Example (auto)

{
  "jobId": "string",
  "status": "QUEUED",
  "review": "NONE"
}

Example

{
  "jobId": "179309912974612345062827",
  "status": "QUEUED",
  "review": "NONE"
}

400

İstek geçersiz. code ve message:

code	message	Ne zaman
INVALID_REQUEST	N field(s) rejected	Alanlar doğrulamadan geçmedi (eksik sender ya da text, uzunluk sınırları, addressType 0–17 dışında, contacts[].number boş) ya da bir değer türüne uymuyor (encoding listede yok, tarih saat dilimi farkı olmadan yazılmış gibi). violations belirtir.
INVALID_REQUEST	request body could not be read as json	Gövde geçerli bir JSON değil.
INVALID_REQUEST	encoding UNICODE is not supported for directory sends	encoding UNICODE.
INVALID_REQUEST	a directory send names at least one group or contact; for numbers alone use /sms/v3/send	groupIds ve contacts ikisi de boş.
INVALID_REQUEST	text exceeds N characters for this encoding and sender	Metin, encoding ve gönderici türüne göre sınırı aşıyor; bkz. text.
INVALID_REQUEST	a required field is missing	Platform eksik bir alan bildirdi.
INVALID_SEND_WINDOW	the send window was rejected	Platform startAt / stopAt aralığını kabul etmedi; bkz. stopAt.

application/json

Schema

Schema

codestringrequired

Possible values: [INVALID_REQUEST, INVALID_SEND_WINDOW]

messagestringrequired

Okunabilir ayrıntı. UNAUTHENTICATED için no bearer token ya da invalid or expired token. REJECTED_HEADER için ret adıdır; yalnızca rakamlardan oluşan bir göndericide (subscriber number headers were not offered) ekini taşıyabilir. RATE_LIMITED için sınırı belirtir; FORBIDDEN ve REJECTED_IYS için sabit bir cümledir. SERVICE_UNAVAILABLE ve INTERNAL_ERROR genel bir cümle taşır; bildirirken requestId değerini paylaşmanız gerekir.

requestIdstringrequired

İsteğe özgü kimlik, 32 onaltılık karakter. Bir sorun bildirirken bu değeri paylaşmanız, isteğin kayıtlarda bulunmasını sağlar.

timestampdate-timerequired

violations object[]nullablerequired

Yalnızca gövde doğrulamasından gelen INVALID_REQUEST için dolu, aksi halde null.

Array [

fieldstring

messagestring

]

rejectedItems object[]

Yalnızca NO_DELIVERABLE_MESSAGES yanıtında bulunur; diğer hatalarda alan hiç yer almaz. Reddedilen kayıtlar, index sırasıyla ilk 100 tanesi; 202 yanıtındaki rejectedItems ile aynıdır.

Possible values: <= 100

Array [

indexintegerrequired

Kaydın istekteki messages dizisindeki sırası, sıfırdan başlar.

recipientstringnullablerequired

Kayıttaki alıcı. Kayıt null ise ya da alıcısı yoksa null.

reasonstringrequired

Değer	Ne zaman
INVALID_RECIPIENT	Numara eksik ya da biçimi yanlış; bkz. recipient.
INVALID_MESSAGE	Metin eksik ya da boş.
MESSAGE_TOO_LONG	Metin, encoding ve gönderici türüne göre sınırı aşıyor; bkz. encoding.
MALFORMED_ENTRY	Kayıt null.
DUPLICATE_RECIPIENT	Aynı alıcı istekte daha sonra yeniden geçiyor. Yalnızca son geçen kayıt gönderilir, öncekiler bu nedenle reddedilir; son kayıt başka bir nedenle reddedilse bile. Numaralar yazıldığı gibi karşılaştırılır. Mükerrer gönderime izin verilen hesaplarda uygulanmaz.
NO_INTERNATIONAL_PERMISSION	Numara yurt dışı (- ile başlıyor) ve hesabın yurt dışı gönderim izni yok. İzin için destek ekibiyle iletişime geçmelisiniz. Yalnızca başka bir hatası olmayan kayıtlarda bildirilir.

Bir kayıt birden fazla nedenle hatalıysa tek neden bildirilir; öncelik: DUPLICATE_RECIPIENT, MALFORMED_ENTRY, MESSAGE_TOO_LONG, INVALID_RECIPIENT, INVALID_MESSAGE, NO_INTERNATIONAL_PERMISSION.

Possible values: [INVALID_RECIPIENT, INVALID_MESSAGE, MESSAGE_TOO_LONG, MALFORMED_ENTRY, DUPLICATE_RECIPIENT, NO_INTERNATIONAL_PERMISSION]

]

rejectedItemsTruncatedboolean

Yalnızca rejectedItems ile birlikte bulunur. 100'den fazla kayıt reddedildiğinde true.

Example (auto)

{
  "code": "INVALID_REQUEST",
  "message": "string",
  "requestId": "string",
  "timestamp": "2024-07-29T15:51:28.071Z",
  "violations": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "rejectedItems": [
    {
      "index": 0,
      "recipient": "string",
      "reason": "INVALID_RECIPIENT"
    }
  ],
  "rejectedItemsTruncated": true
}

401

UNAUTHENTICATED. Bearer token yok ya da token geçersiz veya süresi dolmuş; message no bearer token ya da invalid or expired token.

application/json

Schema

Schema

codestringrequired

Possible values: [UNAUTHENTICATED]

messagestringrequired

Okunabilir ayrıntı. UNAUTHENTICATED için no bearer token ya da invalid or expired token. REJECTED_HEADER için ret adıdır; yalnızca rakamlardan oluşan bir göndericide (subscriber number headers were not offered) ekini taşıyabilir. RATE_LIMITED için sınırı belirtir; FORBIDDEN ve REJECTED_IYS için sabit bir cümledir. SERVICE_UNAVAILABLE ve INTERNAL_ERROR genel bir cümle taşır; bildirirken requestId değerini paylaşmanız gerekir.

requestIdstringrequired

İsteğe özgü kimlik, 32 onaltılık karakter. Bir sorun bildirirken bu değeri paylaşmanız, isteğin kayıtlarda bulunmasını sağlar.

timestampdate-timerequired

violations object[]nullablerequired

Yalnızca gövde doğrulamasından gelen INVALID_REQUEST için dolu, aksi halde null.

Array [

fieldstring

messagestring

]

rejectedItems object[]

Yalnızca NO_DELIVERABLE_MESSAGES yanıtında bulunur; diğer hatalarda alan hiç yer almaz. Reddedilen kayıtlar, index sırasıyla ilk 100 tanesi; 202 yanıtındaki rejectedItems ile aynıdır.

Possible values: <= 100

Array [

indexintegerrequired

Kaydın istekteki messages dizisindeki sırası, sıfırdan başlar.

recipientstringnullablerequired

Kayıttaki alıcı. Kayıt null ise ya da alıcısı yoksa null.

reasonstringrequired

Değer	Ne zaman
INVALID_RECIPIENT	Numara eksik ya da biçimi yanlış; bkz. recipient.
INVALID_MESSAGE	Metin eksik ya da boş.
MESSAGE_TOO_LONG	Metin, encoding ve gönderici türüne göre sınırı aşıyor; bkz. encoding.
MALFORMED_ENTRY	Kayıt null.
DUPLICATE_RECIPIENT	Aynı alıcı istekte daha sonra yeniden geçiyor. Yalnızca son geçen kayıt gönderilir, öncekiler bu nedenle reddedilir; son kayıt başka bir nedenle reddedilse bile. Numaralar yazıldığı gibi karşılaştırılır. Mükerrer gönderime izin verilen hesaplarda uygulanmaz.
NO_INTERNATIONAL_PERMISSION	Numara yurt dışı (- ile başlıyor) ve hesabın yurt dışı gönderim izni yok. İzin için destek ekibiyle iletişime geçmelisiniz. Yalnızca başka bir hatası olmayan kayıtlarda bildirilir.

Bir kayıt birden fazla nedenle hatalıysa tek neden bildirilir; öncelik: DUPLICATE_RECIPIENT, MALFORMED_ENTRY, MESSAGE_TOO_LONG, INVALID_RECIPIENT, INVALID_MESSAGE, NO_INTERNATIONAL_PERMISSION.

Possible values: [INVALID_RECIPIENT, INVALID_MESSAGE, MESSAGE_TOO_LONG, MALFORMED_ENTRY, DUPLICATE_RECIPIENT, NO_INTERNATIONAL_PERMISSION]

]

rejectedItemsTruncatedboolean

Yalnızca rejectedItems ile birlikte bulunur. 100'den fazla kayıt reddedildiğinde true.

Example (auto)

{
  "code": "UNAUTHENTICATED",
  "message": "string",
  "requestId": "string",
  "timestamp": "2024-07-29T15:51:28.071Z",
  "violations": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "rejectedItems": [
    {
      "index": 0,
      "recipient": "string",
      "reason": "INVALID_RECIPIENT"
    }
  ],
  "rejectedItemsTruncated": true
}

403

Hesap bu gönderimi yapamaz. code ve message:

code	message	Anlamı
FORBIDDEN	account is not activated for this operation	Hesapta SMS gönderimi etkin değil.
FORBIDDEN	sub user may not use the sms api	Alt kullanıcının SMS API'sini kullanma izni yok.
FORBIDDEN	account operator is not served for this operation	Hesabın operatörüne bu uç noktadan hizmet verilmiyor.
FORBIDDEN	account is not permitted to send	Platform, hesabın gönderim yetkisi olmadığını bildirdi.
E_SIGNATURE_REQUIRED	the requested menu requires an e-signature login on the account	Bu gönderim için hesapta e-imza ile giriş gerekiyor.

application/json

Schema

Schema

codestringrequired

Possible values: [E_SIGNATURE_REQUIRED, FORBIDDEN]

messagestringrequired

Okunabilir ayrıntı. UNAUTHENTICATED için no bearer token ya da invalid or expired token. REJECTED_HEADER için ret adıdır; yalnızca rakamlardan oluşan bir göndericide (subscriber number headers were not offered) ekini taşıyabilir. RATE_LIMITED için sınırı belirtir; FORBIDDEN ve REJECTED_IYS için sabit bir cümledir. SERVICE_UNAVAILABLE ve INTERNAL_ERROR genel bir cümle taşır; bildirirken requestId değerini paylaşmanız gerekir.

requestIdstringrequired

İsteğe özgü kimlik, 32 onaltılık karakter. Bir sorun bildirirken bu değeri paylaşmanız, isteğin kayıtlarda bulunmasını sağlar.

timestampdate-timerequired

violations object[]nullablerequired

Yalnızca gövde doğrulamasından gelen INVALID_REQUEST için dolu, aksi halde null.

Array [

fieldstring

messagestring

]

rejectedItems object[]

Yalnızca NO_DELIVERABLE_MESSAGES yanıtında bulunur; diğer hatalarda alan hiç yer almaz. Reddedilen kayıtlar, index sırasıyla ilk 100 tanesi; 202 yanıtındaki rejectedItems ile aynıdır.

Possible values: <= 100

Array [

indexintegerrequired

Kaydın istekteki messages dizisindeki sırası, sıfırdan başlar.

recipientstringnullablerequired

Kayıttaki alıcı. Kayıt null ise ya da alıcısı yoksa null.

reasonstringrequired

Değer	Ne zaman
INVALID_RECIPIENT	Numara eksik ya da biçimi yanlış; bkz. recipient.
INVALID_MESSAGE	Metin eksik ya da boş.
MESSAGE_TOO_LONG	Metin, encoding ve gönderici türüne göre sınırı aşıyor; bkz. encoding.
MALFORMED_ENTRY	Kayıt null.
DUPLICATE_RECIPIENT	Aynı alıcı istekte daha sonra yeniden geçiyor. Yalnızca son geçen kayıt gönderilir, öncekiler bu nedenle reddedilir; son kayıt başka bir nedenle reddedilse bile. Numaralar yazıldığı gibi karşılaştırılır. Mükerrer gönderime izin verilen hesaplarda uygulanmaz.
NO_INTERNATIONAL_PERMISSION	Numara yurt dışı (- ile başlıyor) ve hesabın yurt dışı gönderim izni yok. İzin için destek ekibiyle iletişime geçmelisiniz. Yalnızca başka bir hatası olmayan kayıtlarda bildirilir.

Bir kayıt birden fazla nedenle hatalıysa tek neden bildirilir; öncelik: DUPLICATE_RECIPIENT, MALFORMED_ENTRY, MESSAGE_TOO_LONG, INVALID_RECIPIENT, INVALID_MESSAGE, NO_INTERNATIONAL_PERMISSION.

Possible values: [INVALID_RECIPIENT, INVALID_MESSAGE, MESSAGE_TOO_LONG, MALFORMED_ENTRY, DUPLICATE_RECIPIENT, NO_INTERNATIONAL_PERMISSION]

]

rejectedItemsTruncatedboolean

Yalnızca rejectedItems ile birlikte bulunur. 100'den fazla kayıt reddedildiğinde true.

Example (auto)

{
  "code": "E_SIGNATURE_REQUIRED",
  "message": "string",
  "requestId": "string",
  "timestamp": "2024-07-29T15:51:28.071Z",
  "violations": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "rejectedItems": [
    {
      "index": 0,
      "recipient": "string",
      "reason": "INVALID_RECIPIENT"
    }
  ],
  "rejectedItemsTruncated": true
}

422

İstek geçerli ama gönderim yapılamaz. code ve message:

code	message	Anlamı ve çözüm
REJECTED_HEADER	NO_HEADERS_REGISTERED	Hesapta kayıtlı başlık yok.
REJECTED_HEADER	NOT_REGISTERED	sender hesaba kayıtlı değil. Kayıtlı başlıkları GET /senders ile görebilirsiniz.
REJECTED_HEADER	CASE_MISMATCH	Başlık kayıtlı ama büyük/küçük harfi farklı yazılmış; kayıtlı hâliyle göndermelisiniz.
REJECTED_HEADER	ROUTING_CODE_MISSING	Alfanümerik başlık için hesapta yönlendirme kodu tanımlı değil.
REJECTED_HEADER	SUBSCRIBER_NUMBER_RESTRICTED	Hesapta abone numarasından gönderim kısıtlı.
REJECTED_IYS	consent filtering cannot be applied to this sender or account	Platform, istenen İYS filtresini bu başlık ya da hesap için uygulayamadı.

Abone numarasından gönderime onaylı olmayan bir hesapta, tamamı rakamlardan oluşan bir sender için NOT_REGISTERED ve NO_HEADERS_REGISTERED mesajlarının sonuna (subscriber number headers were not offered) eklenir.

application/json

Schema

Schema

codestringrequired

Possible values: [REJECTED_HEADER, REJECTED_IYS]

messagestringrequired

Okunabilir ayrıntı. UNAUTHENTICATED için no bearer token ya da invalid or expired token. REJECTED_HEADER için ret adıdır; yalnızca rakamlardan oluşan bir göndericide (subscriber number headers were not offered) ekini taşıyabilir. RATE_LIMITED için sınırı belirtir; FORBIDDEN ve REJECTED_IYS için sabit bir cümledir. SERVICE_UNAVAILABLE ve INTERNAL_ERROR genel bir cümle taşır; bildirirken requestId değerini paylaşmanız gerekir.

requestIdstringrequired

İsteğe özgü kimlik, 32 onaltılık karakter. Bir sorun bildirirken bu değeri paylaşmanız, isteğin kayıtlarda bulunmasını sağlar.

timestampdate-timerequired

violations object[]nullablerequired

Yalnızca gövde doğrulamasından gelen INVALID_REQUEST için dolu, aksi halde null.

Array [

fieldstring

messagestring

]

rejectedItems object[]

Yalnızca NO_DELIVERABLE_MESSAGES yanıtında bulunur; diğer hatalarda alan hiç yer almaz. Reddedilen kayıtlar, index sırasıyla ilk 100 tanesi; 202 yanıtındaki rejectedItems ile aynıdır.

Possible values: <= 100

Array [

indexintegerrequired

Kaydın istekteki messages dizisindeki sırası, sıfırdan başlar.

recipientstringnullablerequired

Kayıttaki alıcı. Kayıt null ise ya da alıcısı yoksa null.

reasonstringrequired

Değer	Ne zaman
INVALID_RECIPIENT	Numara eksik ya da biçimi yanlış; bkz. recipient.
INVALID_MESSAGE	Metin eksik ya da boş.
MESSAGE_TOO_LONG	Metin, encoding ve gönderici türüne göre sınırı aşıyor; bkz. encoding.
MALFORMED_ENTRY	Kayıt null.
DUPLICATE_RECIPIENT	Aynı alıcı istekte daha sonra yeniden geçiyor. Yalnızca son geçen kayıt gönderilir, öncekiler bu nedenle reddedilir; son kayıt başka bir nedenle reddedilse bile. Numaralar yazıldığı gibi karşılaştırılır. Mükerrer gönderime izin verilen hesaplarda uygulanmaz.
NO_INTERNATIONAL_PERMISSION	Numara yurt dışı (- ile başlıyor) ve hesabın yurt dışı gönderim izni yok. İzin için destek ekibiyle iletişime geçmelisiniz. Yalnızca başka bir hatası olmayan kayıtlarda bildirilir.

Bir kayıt birden fazla nedenle hatalıysa tek neden bildirilir; öncelik: DUPLICATE_RECIPIENT, MALFORMED_ENTRY, MESSAGE_TOO_LONG, INVALID_RECIPIENT, INVALID_MESSAGE, NO_INTERNATIONAL_PERMISSION.

Possible values: [INVALID_RECIPIENT, INVALID_MESSAGE, MESSAGE_TOO_LONG, MALFORMED_ENTRY, DUPLICATE_RECIPIENT, NO_INTERNATIONAL_PERMISSION]

]

rejectedItemsTruncatedboolean

Yalnızca rejectedItems ile birlikte bulunur. 100'den fazla kayıt reddedildiğinde true.

Example (auto)

{
  "code": "REJECTED_HEADER",
  "message": "string",
  "requestId": "string",
  "timestamp": "2024-07-29T15:51:28.071Z",
  "violations": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "rejectedItems": [
    {
      "index": 0,
      "recipient": "string",
      "reason": "INVALID_RECIPIENT"
    }
  ],
  "rejectedItemsTruncated": true
}

429

RATE_LIMITED, message directory send rate limit exceeded. Hesap başına dakikada 60 istek aşıldı; Retry-After kadar bekleyip yeniden denemelisiniz.

Response Headers

Retry-After

Yeniden denemeden önce beklenecek süre (saniye).

application/json

Schema

Schema

codestringrequired

Possible values: [RATE_LIMITED]

messagestringrequired

Okunabilir ayrıntı. UNAUTHENTICATED için no bearer token ya da invalid or expired token. REJECTED_HEADER için ret adıdır; yalnızca rakamlardan oluşan bir göndericide (subscriber number headers were not offered) ekini taşıyabilir. RATE_LIMITED için sınırı belirtir; FORBIDDEN ve REJECTED_IYS için sabit bir cümledir. SERVICE_UNAVAILABLE ve INTERNAL_ERROR genel bir cümle taşır; bildirirken requestId değerini paylaşmanız gerekir.

requestIdstringrequired

İsteğe özgü kimlik, 32 onaltılık karakter. Bir sorun bildirirken bu değeri paylaşmanız, isteğin kayıtlarda bulunmasını sağlar.

timestampdate-timerequired

violations object[]nullablerequired

Yalnızca gövde doğrulamasından gelen INVALID_REQUEST için dolu, aksi halde null.

Array [

fieldstring

messagestring

]

rejectedItems object[]

Yalnızca NO_DELIVERABLE_MESSAGES yanıtında bulunur; diğer hatalarda alan hiç yer almaz. Reddedilen kayıtlar, index sırasıyla ilk 100 tanesi; 202 yanıtındaki rejectedItems ile aynıdır.

Possible values: <= 100

Array [

indexintegerrequired

Kaydın istekteki messages dizisindeki sırası, sıfırdan başlar.

recipientstringnullablerequired

Kayıttaki alıcı. Kayıt null ise ya da alıcısı yoksa null.

reasonstringrequired

Değer	Ne zaman
INVALID_RECIPIENT	Numara eksik ya da biçimi yanlış; bkz. recipient.
INVALID_MESSAGE	Metin eksik ya da boş.
MESSAGE_TOO_LONG	Metin, encoding ve gönderici türüne göre sınırı aşıyor; bkz. encoding.
MALFORMED_ENTRY	Kayıt null.
DUPLICATE_RECIPIENT	Aynı alıcı istekte daha sonra yeniden geçiyor. Yalnızca son geçen kayıt gönderilir, öncekiler bu nedenle reddedilir; son kayıt başka bir nedenle reddedilse bile. Numaralar yazıldığı gibi karşılaştırılır. Mükerrer gönderime izin verilen hesaplarda uygulanmaz.
NO_INTERNATIONAL_PERMISSION	Numara yurt dışı (- ile başlıyor) ve hesabın yurt dışı gönderim izni yok. İzin için destek ekibiyle iletişime geçmelisiniz. Yalnızca başka bir hatası olmayan kayıtlarda bildirilir.

Bir kayıt birden fazla nedenle hatalıysa tek neden bildirilir; öncelik: DUPLICATE_RECIPIENT, MALFORMED_ENTRY, MESSAGE_TOO_LONG, INVALID_RECIPIENT, INVALID_MESSAGE, NO_INTERNATIONAL_PERMISSION.

Possible values: [INVALID_RECIPIENT, INVALID_MESSAGE, MESSAGE_TOO_LONG, MALFORMED_ENTRY, DUPLICATE_RECIPIENT, NO_INTERNATIONAL_PERMISSION]

]

rejectedItemsTruncatedboolean

Yalnızca rejectedItems ile birlikte bulunur. 100'den fazla kayıt reddedildiğinde true.

Example (auto)

{
  "code": "RATE_LIMITED",
  "message": "string",
  "requestId": "string",
  "timestamp": "2024-07-29T15:51:28.071Z",
  "violations": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "rejectedItems": [
    {
      "index": 0,
      "recipient": "string",
      "reason": "INVALID_RECIPIENT"
    }
  ],
  "rejectedItemsTruncated": true
}

500

INTERNAL_ERROR, message internal error. Beklenmeyen hata; bildirirken requestId değerini paylaşmanız gerekir.

application/json

Schema

Schema

codestringrequired

Possible values: [INTERNAL_ERROR]

messagestringrequired

Okunabilir ayrıntı. UNAUTHENTICATED için no bearer token ya da invalid or expired token. REJECTED_HEADER için ret adıdır; yalnızca rakamlardan oluşan bir göndericide (subscriber number headers were not offered) ekini taşıyabilir. RATE_LIMITED için sınırı belirtir; FORBIDDEN ve REJECTED_IYS için sabit bir cümledir. SERVICE_UNAVAILABLE ve INTERNAL_ERROR genel bir cümle taşır; bildirirken requestId değerini paylaşmanız gerekir.

requestIdstringrequired

İsteğe özgü kimlik, 32 onaltılık karakter. Bir sorun bildirirken bu değeri paylaşmanız, isteğin kayıtlarda bulunmasını sağlar.

timestampdate-timerequired

violations object[]nullablerequired

Yalnızca gövde doğrulamasından gelen INVALID_REQUEST için dolu, aksi halde null.

Array [

fieldstring

messagestring

]

rejectedItems object[]

Yalnızca NO_DELIVERABLE_MESSAGES yanıtında bulunur; diğer hatalarda alan hiç yer almaz. Reddedilen kayıtlar, index sırasıyla ilk 100 tanesi; 202 yanıtındaki rejectedItems ile aynıdır.

Possible values: <= 100

Array [

indexintegerrequired

Kaydın istekteki messages dizisindeki sırası, sıfırdan başlar.

recipientstringnullablerequired

Kayıttaki alıcı. Kayıt null ise ya da alıcısı yoksa null.

reasonstringrequired

Değer	Ne zaman
INVALID_RECIPIENT	Numara eksik ya da biçimi yanlış; bkz. recipient.
INVALID_MESSAGE	Metin eksik ya da boş.
MESSAGE_TOO_LONG	Metin, encoding ve gönderici türüne göre sınırı aşıyor; bkz. encoding.
MALFORMED_ENTRY	Kayıt null.
DUPLICATE_RECIPIENT	Aynı alıcı istekte daha sonra yeniden geçiyor. Yalnızca son geçen kayıt gönderilir, öncekiler bu nedenle reddedilir; son kayıt başka bir nedenle reddedilse bile. Numaralar yazıldığı gibi karşılaştırılır. Mükerrer gönderime izin verilen hesaplarda uygulanmaz.
NO_INTERNATIONAL_PERMISSION	Numara yurt dışı (- ile başlıyor) ve hesabın yurt dışı gönderim izni yok. İzin için destek ekibiyle iletişime geçmelisiniz. Yalnızca başka bir hatası olmayan kayıtlarda bildirilir.

Bir kayıt birden fazla nedenle hatalıysa tek neden bildirilir; öncelik: DUPLICATE_RECIPIENT, MALFORMED_ENTRY, MESSAGE_TOO_LONG, INVALID_RECIPIENT, INVALID_MESSAGE, NO_INTERNATIONAL_PERMISSION.

Possible values: [INVALID_RECIPIENT, INVALID_MESSAGE, MESSAGE_TOO_LONG, MALFORMED_ENTRY, DUPLICATE_RECIPIENT, NO_INTERNATIONAL_PERMISSION]

]

rejectedItemsTruncatedboolean

Yalnızca rejectedItems ile birlikte bulunur. 100'den fazla kayıt reddedildiğinde true.

Example (auto)

{
  "code": "INTERNAL_ERROR",
  "message": "string",
  "requestId": "string",
  "timestamp": "2024-07-29T15:51:28.071Z",
  "violations": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "rejectedItems": [
    {
      "index": 0,
      "recipient": "string",
      "reason": "INVALID_RECIPIENT"
    }
  ],
  "rejectedItemsTruncated": true
}

503

SERVICE_UNAVAILABLE. Platforma ulaşılamadı, platform bir hata döndü ya da görev numarası vermedi. Platforma ulaşılamadıysa hiçbir şey kuyruğa alınmamıştır; diğer durumlarda görev kuyruğa alınmış olabilir. Yeniden göndermeden önce GET /report ile kontrol etmelisiniz.

application/json

Schema

Schema

codestringrequired

Possible values: [SERVICE_UNAVAILABLE]

messagestringrequired

Okunabilir ayrıntı. UNAUTHENTICATED için no bearer token ya da invalid or expired token. REJECTED_HEADER için ret adıdır; yalnızca rakamlardan oluşan bir göndericide (subscriber number headers were not offered) ekini taşıyabilir. RATE_LIMITED için sınırı belirtir; FORBIDDEN ve REJECTED_IYS için sabit bir cümledir. SERVICE_UNAVAILABLE ve INTERNAL_ERROR genel bir cümle taşır; bildirirken requestId değerini paylaşmanız gerekir.

requestIdstringrequired

İsteğe özgü kimlik, 32 onaltılık karakter. Bir sorun bildirirken bu değeri paylaşmanız, isteğin kayıtlarda bulunmasını sağlar.

timestampdate-timerequired

violations object[]nullablerequired

Yalnızca gövde doğrulamasından gelen INVALID_REQUEST için dolu, aksi halde null.

Array [

fieldstring

messagestring

]

rejectedItems object[]

Yalnızca NO_DELIVERABLE_MESSAGES yanıtında bulunur; diğer hatalarda alan hiç yer almaz. Reddedilen kayıtlar, index sırasıyla ilk 100 tanesi; 202 yanıtındaki rejectedItems ile aynıdır.

Possible values: <= 100

Array [

indexintegerrequired

Kaydın istekteki messages dizisindeki sırası, sıfırdan başlar.

recipientstringnullablerequired

Kayıttaki alıcı. Kayıt null ise ya da alıcısı yoksa null.

reasonstringrequired

Değer	Ne zaman
INVALID_RECIPIENT	Numara eksik ya da biçimi yanlış; bkz. recipient.
INVALID_MESSAGE	Metin eksik ya da boş.
MESSAGE_TOO_LONG	Metin, encoding ve gönderici türüne göre sınırı aşıyor; bkz. encoding.
MALFORMED_ENTRY	Kayıt null.
DUPLICATE_RECIPIENT	Aynı alıcı istekte daha sonra yeniden geçiyor. Yalnızca son geçen kayıt gönderilir, öncekiler bu nedenle reddedilir; son kayıt başka bir nedenle reddedilse bile. Numaralar yazıldığı gibi karşılaştırılır. Mükerrer gönderime izin verilen hesaplarda uygulanmaz.
NO_INTERNATIONAL_PERMISSION	Numara yurt dışı (- ile başlıyor) ve hesabın yurt dışı gönderim izni yok. İzin için destek ekibiyle iletişime geçmelisiniz. Yalnızca başka bir hatası olmayan kayıtlarda bildirilir.

Bir kayıt birden fazla nedenle hatalıysa tek neden bildirilir; öncelik: DUPLICATE_RECIPIENT, MALFORMED_ENTRY, MESSAGE_TOO_LONG, INVALID_RECIPIENT, INVALID_MESSAGE, NO_INTERNATIONAL_PERMISSION.

Possible values: [INVALID_RECIPIENT, INVALID_MESSAGE, MESSAGE_TOO_LONG, MALFORMED_ENTRY, DUPLICATE_RECIPIENT, NO_INTERNATIONAL_PERMISSION]

]

rejectedItemsTruncatedboolean

Yalnızca rejectedItems ile birlikte bulunur. 100'den fazla kayıt reddedildiğinde true.

Example (auto)

{
  "code": "SERVICE_UNAVAILABLE",
  "message": "string",
  "requestId": "string",
  "timestamp": "2024-07-29T15:51:28.071Z",
  "violations": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "rejectedItems": [
    {
      "index": 0,
      "recipient": "string",
      "reason": "INVALID_RECIPIENT"
    }
  ],
  "rejectedItemsTruncated": true
}

504

QUEUE_UNCONFIRMED. Gönderim platforma iletildi ama yanıtı alınamadı; görev kuyruğa alınmış olabilir. Yeniden göndermeden önce GET /report ile kontrol etmelisiniz.

application/json

Schema

Schema

codestringrequired

Possible values: [QUEUE_UNCONFIRMED]

messagestringrequired

Okunabilir ayrıntı. UNAUTHENTICATED için no bearer token ya da invalid or expired token. REJECTED_HEADER için ret adıdır; yalnızca rakamlardan oluşan bir göndericide (subscriber number headers were not offered) ekini taşıyabilir. RATE_LIMITED için sınırı belirtir; FORBIDDEN ve REJECTED_IYS için sabit bir cümledir. SERVICE_UNAVAILABLE ve INTERNAL_ERROR genel bir cümle taşır; bildirirken requestId değerini paylaşmanız gerekir.

requestIdstringrequired

İsteğe özgü kimlik, 32 onaltılık karakter. Bir sorun bildirirken bu değeri paylaşmanız, isteğin kayıtlarda bulunmasını sağlar.

timestampdate-timerequired

violations object[]nullablerequired

Yalnızca gövde doğrulamasından gelen INVALID_REQUEST için dolu, aksi halde null.

Array [

fieldstring

messagestring

]

rejectedItems object[]

Yalnızca NO_DELIVERABLE_MESSAGES yanıtında bulunur; diğer hatalarda alan hiç yer almaz. Reddedilen kayıtlar, index sırasıyla ilk 100 tanesi; 202 yanıtındaki rejectedItems ile aynıdır.

Possible values: <= 100

Array [

indexintegerrequired

Kaydın istekteki messages dizisindeki sırası, sıfırdan başlar.

recipientstringnullablerequired

Kayıttaki alıcı. Kayıt null ise ya da alıcısı yoksa null.

reasonstringrequired

Değer	Ne zaman
INVALID_RECIPIENT	Numara eksik ya da biçimi yanlış; bkz. recipient.
INVALID_MESSAGE	Metin eksik ya da boş.
MESSAGE_TOO_LONG	Metin, encoding ve gönderici türüne göre sınırı aşıyor; bkz. encoding.
MALFORMED_ENTRY	Kayıt null.
DUPLICATE_RECIPIENT	Aynı alıcı istekte daha sonra yeniden geçiyor. Yalnızca son geçen kayıt gönderilir, öncekiler bu nedenle reddedilir; son kayıt başka bir nedenle reddedilse bile. Numaralar yazıldığı gibi karşılaştırılır. Mükerrer gönderime izin verilen hesaplarda uygulanmaz.
NO_INTERNATIONAL_PERMISSION	Numara yurt dışı (- ile başlıyor) ve hesabın yurt dışı gönderim izni yok. İzin için destek ekibiyle iletişime geçmelisiniz. Yalnızca başka bir hatası olmayan kayıtlarda bildirilir.

Bir kayıt birden fazla nedenle hatalıysa tek neden bildirilir; öncelik: DUPLICATE_RECIPIENT, MALFORMED_ENTRY, MESSAGE_TOO_LONG, INVALID_RECIPIENT, INVALID_MESSAGE, NO_INTERNATIONAL_PERMISSION.

Possible values: [INVALID_RECIPIENT, INVALID_MESSAGE, MESSAGE_TOO_LONG, MALFORMED_ENTRY, DUPLICATE_RECIPIENT, NO_INTERNATIONAL_PERMISSION]

]

rejectedItemsTruncatedboolean

Yalnızca rejectedItems ile birlikte bulunur. 100'den fazla kayıt reddedildiğinde true.

Example (auto)

{
  "code": "QUEUE_UNCONFIRMED",
  "message": "string",
  "requestId": "string",
  "timestamp": "2024-07-29T15:51:28.071Z",
  "violations": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "rejectedItems": [
    {
      "index": 0,
      "recipient": "string",
      "reason": "INVALID_RECIPIENT"
    }
  ],
  "rejectedItemsTruncated": true
}

Örnek istek

curl -X POST 'https://ext-api.netgsm.com.tr/sms/v3/directory/send' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "sender": "NETGSM",
  "text": "Merhaba",
  "encoding": "TURKISH",
  "groupIds": [
    7,
    8
  ],
  "contacts": [
    {
      "number": "905xxxxxxxxx",
      "name": "Ali",
      "surname": "Veli"
    }
  ]
}'