Varsayılan gönderici başlığını değiştirme

PUT 
/senders/default

İstek: PUT https://ext-api.netgsm.com.tr/sms/v3/senders/default
Canlı ortam: https://ext-api.netgsm.com.tr/sms/v3

Kayıtlı bir başlığı varsayılan yapar. Ad, kayıtlı bir başlıkla birebir eşleşmelidir: büyük/küçük harf dahil ve yazıldığı gibi - kırpma yapılmaz, 0 ya da 90 öneki olmaz. Yeni varsayılanı döndürür. Gönderim için kullanılamayan bir başlık da varsayılan yapılabilir; bu durumda yanıtta usable false olur ve reason nedenini belirtir.

Request

application/json

Bodyrequired

namestringrequired

Varsayılan yapılacak başlık, birebir kayıtlı hâliyle - büyük/küçük harf dahil, kırpma yapılmaz, 0 ya da 90 öneki olmaz.

Possible values: non-empty

Responses

200

Yeni varsayılan.

application/json

Schema

Schema

sender objectnullable

Varsayılan ayarlanmamışsa null.

namestringnullablerequired

Kayıtlı hâliyle başlık - bir gönderimde sender için kullanılacak değer. Abone numaraları yalın numaradır.

typestringrequired

Possible values: [ALPHANUMERIC, SUBSCRIBER_NUMBER, UNKNOWN]

brandCodeint64required

Kayıtlı İYS marka kodu; başlığın yoksa 0. Her zaman bulunur.

usablebooleanrequired

Bu başlıktan yapılacak bir gönderimin bu hesap için kabul edilip edilmeyeceği.

reasonstringnullablerequired

Yalnızca usable false olduğunda dolu, aksi halde null. Gönderimin reddederken kullandığı adın aynısı. ROUTING_CODE_MISSING, hesapta yönlendirme kodu tanımlı olmadığı için bu başlıktan gönderim yapılamayacağı anlamına gelir; alfanümerik başlıklar yönlendirme kodu gerektirir. SUBSCRIBER_NUMBER_RESTRICTED, hesapta abone numaralarından SMS gönderiminin kısıtlı olduğu anlamına gelir; abone numarası başlıkları için onaylı olmayan hesaplar bunları hiç görmez.

Possible values: [ROUTING_CODE_MISSING, SUBSCRIBER_NUMBER_RESTRICTED]

Example (auto)

{
  "sender": {
    "name": "string",
    "type": "ALPHANUMERIC",
    "brandCode": 0,
    "usable": true,
    "reason": "ROUTING_CODE_MISSING"
  }
}

Example

{
  "sender": {
    "name": "NETGSM",
    "type": "ALPHANUMERIC",
    "brandCode": 4567,
    "usable": true,
    "reason": null
  }
}

400

INVALID_REQUEST. name eksik ya da boş (violations belirtir) veya gövde JSON değil.

application/json

Schema

Schema

codestringrequired

Possible values: [INVALID_REQUEST]

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

FORBIDDEN. SMS menüsü olmayan bir alt kullanıcı.

application/json

Schema

Schema

codestringrequired

Possible values: [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": "FORBIDDEN",
  "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

REJECTED_HEADER. message NO_HEADERS_REGISTERED, NOT_REGISTERED ya da CASE_MISMATCH.

application/json

Schema

Schema

codestringrequired

Possible values: [REJECTED_HEADER]

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. Hesap için bu uç noktanın sınırı aşıldı; message sınırı belirtir. Retry-After yalnızca hesabın gönderimi askıya alındığında bulunmaz.

Response Headers

Retry-After

İsteğin tekrarlanabileceği zamana kadar kalan tam 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. İstek daha sonra yeniden gönderilebilir.

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
}

Örnek istek

curl -X PUT 'https://ext-api.netgsm.com.tr/sms/v3/senders/default' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "NETGSM"
}'