Sms - Send
Odešle zprávu SMS z telefonního čísla, které patří k ověřenému účtu.
POST {endpoint}/sms?api-version=2021-03-07
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
Komunikační prostředek, například https://my-resource.communication.azure.com |
api-version
|
query | True |
string |
Verze rozhraní API, která se má vyvolat. |
Text požadavku
Name | Vyžadováno | Typ | Description |
---|---|---|---|
from | True |
string |
Telefonní číslo odesílatele ve formátu E.164, které vlastní ověřený účet. |
message | True |
string |
Obsah zprávy, která bude odeslána příjemci. Povolený obsah je definován v DOKUMENTU RFC 5724. |
smsRecipients | True |
Telefonní číslo příjemce ve formátu E.164. V této verzi se podporuje minimálně 1 až 100 příjemců v seznamu. |
|
smsSendOptions |
Volitelná konfigurace pro odesílání zpráv SMS. |
Odpovědi
Name | Typ | Description |
---|---|---|
202 Accepted |
Přijato |
Příklady
SuccessfulSend
Sample Request
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"
}
}
Sample Response
{
"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
}
]
}
Definice
Name | Description |
---|---|
Send |
Představuje vlastnosti požadavku na odeslání zprávy. |
Sms |
Podrobnosti o příjemci pro odesílání ZPRÁV SMS. |
Sms |
Volitelná konfigurace pro odesílání zpráv SMS. |
Sms |
Odpověď na úspěšnou nebo vícenásobnou žádost o odeslání SMS. |
Sms |
Odpověď pro jednoho příjemce. |
SendMessageRequest
Představuje vlastnosti požadavku na odeslání zprávy.
Name | Typ | Description |
---|---|---|
from |
string |
Telefonní číslo odesílatele ve formátu E.164, které vlastní ověřený účet. |
message |
string |
Obsah zprávy, která bude odeslána příjemci. Povolený obsah je definován v DOKUMENTU RFC 5724. |
smsRecipients |
Telefonní číslo příjemce ve formátu E.164. V této verzi se podporuje minimálně 1 až 100 příjemců v seznamu. |
|
smsSendOptions |
Volitelná konfigurace pro odesílání zpráv SMS. |
SmsRecipient
Podrobnosti o příjemci pro odesílání ZPRÁV SMS.
Name | Typ | Description |
---|---|---|
repeatabilityFirstSent |
string |
Musí být odeslán klienty, aby bylo možné určit, že je požadavek opakovatelný. Opakovatelnost-First-Sent slouží k určení data a času, kdy byla žádost první created.eg– Út, 26 Mar 2019 16:06:51 GMT. |
repeatabilityRequestId |
string |
Pokud je zadán, klient nasměruje, že požadavek je opakovatelný; To znamená, že klient může požadavek provést vícekrát se stejným Id požadavku Repeatability-Request-ID a získat odpovídající odpověď, aniž by server požadavek několikrát spouštějí. Hodnota Repeatability-Request-ID je neprůhledný řetězec představující klientem generované 36znakové šestnáctkové kódování identifikátoru UUID (GUID), které nerozlišuje malá a velká písmena. |
to |
string |
Telefonní číslo příjemce ve formátu E.164. |
SmsSendOptions
Volitelná konfigurace pro odesílání zpráv SMS.
Name | Typ | Description |
---|---|---|
enableDeliveryReport |
boolean |
Povolením tohoto příznaku obdržíte zprávu o doručení této zprávy ve službě Azure Resource EventGrid. |
tag |
string |
Toto pole použijte k zadání metadat, která se pak odešlou zpět v odpovídající zprávě o doručení. |
SmsSendResponse
Odpověď na úspěšnou nebo vícenásobnou žádost o odeslání SMS.
Name | Typ | Description |
---|---|---|
value |
Odpověď pro jednoho příjemce. |
SmsSendResponseItem
Odpověď pro jednoho příjemce.
Name | Typ | Description |
---|---|---|
errorMessage |
string |
Volitelná chybová zpráva v případě chyb 4xx, 5xx nebo opakovatelných chyb. |
httpStatusCode |
integer |
Stavový kód HTTP. |
messageId |
string |
Identifikátor odchozí sms zprávy. Zobrazí se pouze při zpracování zprávy. |
repeatabilityResult |
enum:
|
Výsledek opakovatelného požadavku s některou z hodnot nerozlišující malá a velká písmena byla přijata nebo odmítnuta. |
successful |
boolean |
Označuje, jestli byla zpráva úspěšně zpracována, nebo ne. |
to |
string |
Telefonní číslo příjemce ve formátu E.164. |