Sms - Send

Başvuru

Hizmet:: Communication

API Sürümü:: 2021-03-07

Kimliği doğrulanmış hesaba ait bir telefon numarasından SMS iletisi gönderir.

POST {endpoint}/sms?api-version=2021-03-07

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
endpoint	path	True	string	İletişim kaynağı, örneğin https://my-resource.communication.azure.com
api-version	query	True	string	Çağrılacak API sürümü.

İstek Gövdesi

Name	Gerekli	Tür	Description
from	True	string	Gönderenin, kimliği doğrulanmış hesaba ait E.164 biçimindeki telefon numarası.
message	True	string minLength: 0 maxLength: 2048	Alıcıya gönderilecek iletinin içeriği. İzin verilebilen içerik RFC 5724 tarafından tanımlanır.
smsRecipients	True	SmsRecipient[]	Alıcının E.164 biçimindeki telefon numarası. Bu sürümde, listedeki en az 1 ve en çok 100 alıcı desteklenir.
smsSendOptions		SmsSendOptions	SMS iletileri göndermek için isteğe bağlı yapılandırma.

Yanıtlar

Name	Tür	Description
202 Accepted	SmsSendResponse	Kabul

Örnekler

SuccessfulSend

Örnek isteği

HTTP

POST https://contoso.communication.azure.com//sms?api-version=2021-03-07

{
  "from": "+18001110000",
  "smsRecipients": [
    {
      "to": "+11234567890"
    },
    {
      "to": "+11234567891"
    },
    {
      "to": "+112345678901"
    },
    {
      "to": "+11234567892"
    },
    {
      "to": "+11234567893",
      "repeatabilityRequestId": "fda6d242-46aa-4247-8bf6-619a1206f9c3",
      "repeatabilityFirstSent": "Mon, 01 Apr 2019 06:22:03 GMT"
    },
    {
      "to": "+11234567894",
      "repeatabilityRequestId": "fda6d242-46aa-4247-8bf6-619a1206f9c3"
    }
  ],
  "message": "Hello world!",
  "smsSendOptions": {
    "enableDeliveryReport": true,
    "tag": "testSmsRequest"
  }
}

Örnek yanıt

Durum kodu:: 202

{
  "value": [
    {
      "to": "+11234567890",
      "messageId": "Outgoing_20200610203725bfd4ba70-70bf-4f77-925d-c0bdb5161bb3",
      "httpStatusCode": 202,
      "successful": true
    },
    {
      "to": "+11234567891",
      "messageId": "Outgoing_2020061020025100d1-d07e-4b19-b25d-13525d552822",
      "httpStatusCode": 202,
      "successful": true
    },
    {
      "to": "+112345678901",
      "httpStatusCode": 400,
      "errorMessage": "Invalid To phone number format.",
      "successful": false
    },
    {
      "to": "+11234567892",
      "messageId": "Outgoing_2020061020025100d1-d07e-4b19-b25d-13525d552822",
      "httpStatusCode": 503,
      "errorMessage": "ServiceUnavailable",
      "successful": false
    },
    {
      "to": "+11234567893",
      "messageId": "Outgoing_2020061020025100d1-d07e-4b19-b25d-13525d552822_noam",
      "httpStatusCode": 202,
      "repeatabilityResult": "accepted",
      "successful": true
    },
    {
      "to": "+11234567894",
      "messageId": "Outgoing_2020061020025100d1-d07e-4b19-b25d-13525d552822",
      "httpStatusCode": 400,
      "repeatabilityResult": "rejected",
      "errorMessage": "Request sent with Invalid DateTime value for repeatability-first-sent. Expected is DateTime ,RFC1123 pattern.",
      "successful": false
    }
  ]
}

Tanımlar

Name	Description
SendMessageRequest	İleti gönderme isteğinin özelliklerini temsil eder.
SmsRecipient	SMS iletileri göndermek için alıcı ayrıntıları.
SmsSendOptions	SMS iletileri göndermek için isteğe bağlı yapılandırma.
SmsSendResponse	Başarılı veya çok durumlu sms isteği gönderme yanıtı.
SmsSendResponseItem	Tek bir alıcı için yanıt.

SendMessageRequest

Object

İleti gönderme isteğinin özelliklerini temsil eder.

Name	Tür	Description
from	string	Gönderenin, kimliği doğrulanmış hesaba ait E.164 biçimindeki telefon numarası.
message	string minLength: 0 maxLength: 2048	Alıcıya gönderilecek iletinin içeriği. İzin verilebilen içerik RFC 5724 tarafından tanımlanır.
smsRecipients	SmsRecipient[]	Alıcının E.164 biçimindeki telefon numarası. Bu sürümde, listedeki en az 1 ve en çok 100 alıcı desteklenir.
smsSendOptions	SmsSendOptions	SMS iletileri göndermek için isteğe bağlı yapılandırma.

SmsRecipient

Object

SMS iletileri göndermek için alıcı ayrıntıları.

Name	Tür	Description
repeatabilityFirstSent	string	bir isteğin yinelenebilir olduğunu belirtmek için istemciler tarafından gönderilmelidir. Yinelenebilirlik-First-Sent isteğin ilk created.eg tarih ve saati belirtmek için kullanılır- Sal, 26 Mart 2019 16:06:51 GMT
repeatabilityRequestId	string	Belirtilirse, istemci isteğin yinelenebilir olduğunu yönlendirir; başka bir ifadeyle, istemci isteği aynı Repeatability-Request-ID ile birden çok kez yapabilir ve sunucu isteği birden çok kez yürütmeden uygun yanıtı geri alabilir. Repeatability-Request-ID değeri, istek için bir UUID (GUID) tanımlayıcısının istemci tarafından oluşturulan, 36 karakterlik onaltılık büyük/küçük harfe duyarsız kodlamasını temsil eden opak bir dizedir.
to	string	Alıcının E.164 biçimindeki telefon numarası.

SmsSendOptions

Object

SMS iletileri göndermek için isteğe bağlı yapılandırma.

Name	Tür	Description
enableDeliveryReport	boolean	Azure Resource EventGrid'de bu ileti için bir teslim raporu almak için bu bayrağı etkinleştirin.
tag	string	Daha sonra ilgili Teslim Raporu'na geri gönderilecek meta verileri sağlamak için bu alanı kullanın.

SmsSendResponse

Object

Başarılı veya çok durumlu sms isteği gönderme yanıtı.

Name	Tür	Description
value	SmsSendResponseItem[]	Tek bir alıcı için yanıt.

SmsSendResponseItem

Object

Tek bir alıcı için yanıt.

Name	Tür	Description
errorMessage	string	4xx/5xx/repeatable hataları durumunda isteğe bağlı hata iletisi.
httpStatusCode	integer	HTTP Durum kodu.
messageId	string	Giden Sms iletisinin tanımlayıcısı. Yalnızca ileti işlenirse sunulur.
repeatabilityResult	enum: accepted rejected	Büyük/küçük harfe duyarlı olmayan değerlerden birinin kabul edildiği veya reddedildiği yinelenebilir bir isteğin sonucu.
successful	boolean	İletinin başarıyla işlenip işlenmediğini gösterir.
to	string	Alıcının E.164 biçimindeki telefon numarası.

Aracılığıyla paylaş

Sms - Send

URI Parametreleri

İstek Gövdesi

Yanıtlar

Örnekler

SuccessfulSend

Örnek isteği

Örnek yanıt

Tanımlar

SendMessageRequest

SmsRecipient

SmsSendOptions

SmsSendResponse

SmsSendResponseItem