Sms - Send

Odwołanie

Usługa:: Communication

Wersja interfejsu API:: 2021-03-07

Wysyła wiadomość SMS z numeru telefonu należącego do uwierzytelnionego konta.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string	Zasób komunikacji, na przykład https://my-resource.communication.azure.com
api-version	query	True	string	Wersja interfejsu API do wywołania.

Treść żądania

Nazwa	Wymagane	Typ	Opis
from	True	string	Numer telefonu nadawcy w formacie E.164, który jest własnością uwierzytelnionego konta.
message	True	string minLength: 0 maxLength: 2048	Zawartość wiadomości, która zostanie wysłana do adresata. Dozwolona zawartość jest definiowana przez RFC 5724.
smsRecipients	True	SmsRecipient[]	Numer telefonu odbiorcy w formacie E.164. W tej wersji obsługiwanych jest co najmniej 1 i maksymalnie 100 adresatów na liście.
smsSendOptions		SmsSendOptions	Opcjonalna konfiguracja wysyłania wiadomości SMS.

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted	SmsSendResponse	Akceptowane

Przykłady

SuccessfulSend

Przykładowe żądanie

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"
  }
}

Przykładowa odpowiedź

Kod stanu:: 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
    }
  ]
}

Definicje

Nazwa	Opis
SendMessageRequest	Reprezentuje właściwości żądania wysyłania wiadomości.
SmsRecipient	Szczegóły adresata dotyczące wysyłania wiadomości SMS.
SmsSendOptions	Opcjonalna konfiguracja wysyłania wiadomości SMS.
SmsSendResponse	Odpowiedź na żądanie sms o pomyślnym lub wielostanowym wysłaniu.
SmsSendResponseItem	Odpowiedź dla pojedynczego adresata.

SendMessageRequest

Objekt

Reprezentuje właściwości żądania wysyłania wiadomości.

Nazwa	Typ	Opis
from	string	Numer telefonu nadawcy w formacie E.164, który jest własnością uwierzytelnionego konta.
message	string minLength: 0 maxLength: 2048	Zawartość wiadomości, która zostanie wysłana do adresata. Dozwolona zawartość jest definiowana przez RFC 5724.
smsRecipients	SmsRecipient[]	Numer telefonu odbiorcy w formacie E.164. W tej wersji obsługiwanych jest co najmniej 1 i maksymalnie 100 adresatów na liście.
smsSendOptions	SmsSendOptions	Opcjonalna konfiguracja wysyłania wiadomości SMS.

SmsRecipient

Objekt

Szczegóły adresata dotyczące wysyłania wiadomości SMS.

Nazwa	Typ	Opis
repeatabilityFirstSent	string	Aby określić, że żądanie jest powtarzalne, należy wysłać przez klientów. Powtarzalność —First-Sent służy do określania daty i godziny, o której żądanie zostało po raz pierwszy created.eg- Wt, 26 mar 2019 16:06:51 GMT
repeatabilityRequestId	string	Jeśli zostanie określony, klient kieruje żądanie jest powtarzalne; oznacza to, że klient może wykonać żądanie wiele razy z tą samą powtarzalnością —Request-ID i wrócić odpowiednią odpowiedź bez konieczności wielokrotnego wykonywania żądania przez serwer. Wartość repeatability-Request-ID jest nieprzezroczystym ciągiem reprezentującym wygenerowaną przez klienta, 36-znakową wielkość liter bez uwzględniania wielkości liter w kodowaniu UUID (GUID), identyfikatora żądania.
to	string	Numer telefonu odbiorcy w formacie E.164.

SmsSendOptions

Objekt

Opcjonalna konfiguracja wysyłania wiadomości SMS.

Nazwa	Typ	Opis
enableDeliveryReport	boolean	Włącz tę flagę, aby otrzymać raport dostarczania dla tego komunikatu w usłudze Azure Resource EventGrid.
tag	string	Użyj tego pola, aby podać metadane, które zostaną następnie wysłane z powrotem w odpowiednim raporcie dostarczania.

SmsSendResponse

Objekt

Odpowiedź na żądanie sms o pomyślnym lub wielostanowym wysłaniu.

Nazwa	Typ	Opis
value	SmsSendResponseItem[]	Odpowiedź dla pojedynczego adresata.

SmsSendResponseItem

Objekt

Odpowiedź dla pojedynczego adresata.

Nazwa	Typ	Opis
errorMessage	string	Opcjonalny komunikat o błędzie w przypadku błędów 4xx/5xx/powtarzalnych.
httpStatusCode	integer	Kod stanu HTTP.
messageId	string	Identyfikator wychodzącej wiadomości SMS. Prezentuj tylko wtedy, gdy komunikat został przetworzony.
repeatabilityResult	enum: accepted rejected	Wynik powtarzalnego żądania z jedną z wartości bez uwzględniania wielkości liter zaakceptowanych lub odrzuconych.
successful	boolean	Wskazuje, czy komunikat został pomyślnie przetworzony, czy nie.
to	string	Numer telefonu odbiorcy w formacie E.164.

Udostępnij za pośrednictwem

Sms - Send

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Przykłady

SuccessfulSend

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

SendMessageRequest

SmsRecipient

SmsSendOptions

SmsSendResponse

SmsSendResponseItem