Sms - Send
Invia un messaggio SMS da un numero di telefono appartenente all'account autenticato.
POST {endpoint}/sms?api-version=2021-03-07
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
endpoint
|
path | True |
string |
Risorsa di comunicazione, ad esempio https://my-resource.communication.azure.com |
api-version
|
query | True |
string |
Versione dell'API da richiamare. |
Corpo della richiesta
Nome | Necessario | Tipo | Descrizione |
---|---|---|---|
from | True |
string |
Numero di telefono del mittente in formato E.164 di proprietà dell'account autenticato. |
message | True |
string |
Contenuto del messaggio che verrà inviato al destinatario. Il contenuto consentito è definito da RFC 5724. |
smsRecipients | True |
Numero di telefono del destinatario in formato E.164. In questa versione sono supportati almeno 1 e fino a 100 destinatari nell'elenco. |
|
smsSendOptions |
Configurazione facoltativa per l'invio di messaggi SMS. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
202 Accepted |
Accettato |
Esempio
SuccessfulSend
Esempio di richiesta
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"
}
}
Risposta di esempio
{
"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
}
]
}
Definizioni
Nome | Descrizione |
---|---|
Send |
Rappresenta le proprietà di una richiesta di messaggio di invio. |
Sms |
Dettagli del destinatario per l'invio di messaggi SMS. |
Sms |
Configurazione facoltativa per l'invio di messaggi SMS. |
Sms |
Risposta per una richiesta sms con stato positivo o multi-stato. |
Sms |
Risposta per un singolo destinatario. |
SendMessageRequest
Rappresenta le proprietà di una richiesta di messaggio di invio.
Nome | Tipo | Descrizione |
---|---|---|
from |
string |
Numero di telefono del mittente in formato E.164 di proprietà dell'account autenticato. |
message |
string |
Contenuto del messaggio che verrà inviato al destinatario. Il contenuto consentito è definito da RFC 5724. |
smsRecipients |
Numero di telefono del destinatario in formato E.164. In questa versione sono supportati almeno 1 e fino a 100 destinatari nell'elenco. |
|
smsSendOptions |
Configurazione facoltativa per l'invio di messaggi SMS. |
SmsRecipient
Dettagli del destinatario per l'invio di messaggi SMS.
Nome | Tipo | Descrizione |
---|---|---|
repeatabilityFirstSent |
string |
DEVE essere inviato dai client per specificare che una richiesta è ripetibile. La ripetibilità-First-Sent viene usata per specificare la data e l'ora in cui la richiesta è stata created.eg- Tue, 26 mar 2019 16:06:51 GMT |
repeatabilityRequestId |
string |
Se specificato, il client indirizza che la richiesta è ripetibile; ovvero, il client può effettuare la richiesta più volte con lo stesso ID richiesta ripetibilità e recuperare una risposta appropriata senza che il server eseva la richiesta più volte. Il valore dell'ID ripetibilità-richiesta è una stringa opaca che rappresenta una stringa generata dal client, 36 caratteri esadecimali senza distinzione tra maiuscole esadecimali di un identificatore UUID (GUID) per la richiesta. |
to |
string |
Numero di telefono del destinatario in formato E.164. |
SmsSendOptions
Configurazione facoltativa per l'invio di messaggi SMS.
Nome | Tipo | Descrizione |
---|---|---|
enableDeliveryReport |
boolean |
Abilitare questo flag per ricevere un report di recapito per questo messaggio in Azure Resource EventGrid. |
tag |
string |
Usare questo campo per specificare i metadati che verranno quindi inviati nel report di recapito corrispondente. |
SmsSendResponse
Risposta per una richiesta sms con stato positivo o multi-stato.
Nome | Tipo | Descrizione |
---|---|---|
value |
Risposta per un singolo destinatario. |
SmsSendResponseItem
Risposta per un singolo destinatario.
Nome | Tipo | Descrizione |
---|---|---|
errorMessage |
string |
Messaggio di errore facoltativo nel caso di errori ripetibili 4xx/5xx. |
httpStatusCode |
integer |
Codice di stato HTTP. |
messageId |
string |
Identificatore del messaggio Sms in uscita. Presente solo se il messaggio è stato elaborato. |
repeatabilityResult |
enum:
|
Risultato di una richiesta ripetibile con uno dei valori senza distinzione tra maiuscole e minuscole accettati o rifiutati. |
successful |
boolean |
Indica se il messaggio viene elaborato correttamente o meno. |
to |
string |
Numero di telefono del destinatario in formato E.164. |