Sms - Send

Referenz

Dienst:: Communication

API-Version:: 2021-03-07

Sendet eine SMS-Nachricht von einer Telefonnummer, die zum authentifizierten Konto gehört.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Die Kommunikationsressource, z. B. https://my-resource.communication.azure.com
api-version	query	True	string	Version der aufgerufenen API.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
from	True	string	Die Telefonnummer des Absenders im E.164-Format, die dem authentifizierten Konto gehört.
message	True	string	Der Inhalt der Nachricht, die an den Empfänger gesendet wird. Der zulässige Inhalt wird durch RFC 5724 definiert.
smsRecipients	True	SmsRecipient[]	Die Telefonnummer des Empfängers im E.164-Format. In dieser Version werden mindestens 1 und bis zu 100 Empfänger in der Liste unterstützt.
smsSendOptions		SmsSendOptions	Optionale Konfiguration zum Senden von SMS-Nachrichten.

Antworten

Name	Typ	Beschreibung
202 Accepted	SmsSendResponse	Akzeptiert

Beispiele

SuccessfulSend

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:: 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
    }
  ]
}

Definitionen

Name	Beschreibung
SendMessageRequest	Stellt die Eigenschaften einer Anforderung zum Senden von Nachrichten dar.
SmsRecipient	Empfängerdetails zum Senden von SMS-Nachrichten.
SmsSendOptions	Optionale Konfiguration zum Senden von SMS-Nachrichten.
SmsSendResponse	Antwort für eine erfolgreiche oder mehrere status Senden einer SMS-Anforderung.
SmsSendResponseItem	Antwort für einen einzelnen Empfänger.

SendMessageRequest

Stellt die Eigenschaften einer Anforderung zum Senden von Nachrichten dar.

Name	Typ	Beschreibung
from	string	Die Telefonnummer des Absenders im E.164-Format, die dem authentifizierten Konto gehört.
message	string	Der Inhalt der Nachricht, die an den Empfänger gesendet wird. Der zulässige Inhalt wird durch RFC 5724 definiert.
smsRecipients	SmsRecipient[]	Die Telefonnummer des Empfängers im E.164-Format. In dieser Version werden mindestens 1 und bis zu 100 Empfänger in der Liste unterstützt.
smsSendOptions	SmsSendOptions	Optionale Konfiguration zum Senden von SMS-Nachrichten.

SmsRecipient

Empfängerdetails zum Senden von SMS-Nachrichten.

Name	Typ	Beschreibung
repeatabilityFirstSent	string	MUSS von Clients gesendet werden, um anzugeben, dass eine Anforderung wiederholbar ist. Repeatability-First-Sent wird verwendet, um das Datum und die Uhrzeit anzugeben, an dem die Anforderung zum ersten Mal created.eg - Di, 26. März 2019 16:06:51 GMT
repeatabilityRequestId	string	Falls angegeben, leitet der Client an, dass die Anforderung wiederholbar ist. Das heißt, der Client kann die Anforderung mehrmals mit derselben Wiederholbarkeitsanforderungs-ID stellen und eine entsprechende Antwort zurück erhalten, ohne dass der Server die Anforderung mehrmals ausführt. Der Wert der Repeatability-Request-ID ist eine undurchsichtige Zeichenfolge, die eine vom Client generierte, 36-stellige hexadezimale Codierung einer UUID (GUID), bezeichner für die Anforderung, darstellt.
to	string	Die Telefonnummer des Empfängers im E.164-Format.

SmsSendOptions

Optionale Konfiguration zum Senden von SMS-Nachrichten.

Name	Typ	Beschreibung
enableDeliveryReport	boolean	Aktivieren Sie dieses Flag, um einen Übermittlungsbericht für diese Nachricht im Azure Resource EventGrid zu erhalten.
tag	string	Verwenden Sie dieses Feld, um Metadaten bereitzustellen, die dann im entsprechenden Übermittlungsbericht zurückgesendet werden.

SmsSendResponse

Antwort für eine erfolgreiche oder mehrere status Senden einer SMS-Anforderung.

Name	Typ	Beschreibung
value	SmsSendResponseItem[]	Antwort für einen einzelnen Empfänger.

SmsSendResponseItem

Antwort für einen einzelnen Empfänger.

Name	Typ	Beschreibung
errorMessage	string	Optionale Fehlermeldung bei 4xx/5xx/wiederholbaren Fehlern.
httpStatusCode	integer	HTTP-Statuscode.
messageId	string	Der Bezeichner der ausgehenden SMS-Nachricht. Nur vorhanden, wenn die Nachricht verarbeitet wurde.
repeatabilityResult	enum: accepted rejected	Das Ergebnis einer wiederholbaren Anforderung mit einem der Werte ohne Beachtung der Groß-/Kleinschreibung, die akzeptiert oder abgelehnt werden.
successful	boolean	Gibt an, ob die Nachricht erfolgreich verarbeitet wurde oder nicht.
to	string	Die Telefonnummer des Empfängers im E.164-Format.

Freigeben über