Udostępnij za pośrednictwem

Mms - Send

  • Odwołanie
Usługa:
Communication
Wersja interfejsu API:
2024-01-14-preview

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

POST {endpoint}/mms?api-version=2024-01-14-preview

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
endpoint
 path True

string (url)

Zasób komunikacji, na przykład https://resourcename.communication.azure.com
api-version
 query True

string

Wersja interfejsu API do wywołania

Treść żądania

Nazwa Wymagane Typ Opis
attachments True

MmsSendRequestAttachment[]

Lista załączników multimedialnych do uwzględnienia w ramach programu MMS. Możesz mieć maksymalnie 10 załączników.
from True

string

Identyfikator nadawcy (zazwyczaj numer telefonu w formacie E.164), który jest własnością uwierzytelnionego konta.
recipients True

MmsRecipient[]

Numery telefonów adresatów w formacie E.164.
message

string

minLength: 0
maxLength: 1000

Zawartość wiadomości, która zostanie wysłana do adresata.
sendOptions

MmsSendOptions

Opcjonalna konfiguracja wysyłania komunikatów MMS.

Odpowiedzi

Nazwa Typ Opis
202 Accepted

MmsSendResponse

Akceptowane

Przykłady

Send Message

Przykładowe żądanie

POST https://resourcename.communication.azure.com//mms?api-version=2024-01-14-preview

{
  "from": "+18004567891",
  "recipients": [
    {
      "to": "+18335852071"
    },
    {
      "to": "+11234567890"
    },
    {
      "to": "+112345678910abc"
    }
  ],
  "message": "Hey, Let's go for Dinner to these nice place",
  "attachments": [
    {
      "contentType": "image/png",
      "contentInBase64": "iVBORw0KGgoAAAANSUhEUgAAAGQAAABkCAYAAABw4pVUAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAF1SURBVHhe7dyxUVVRGEbRc28sCR04YxMklkAmAQ4d2ANUYBEOERppwJAb2AQJDUBA/K7Dm1OCwb7jWsk5X7zzf3k9/7CNvdq2H+9+PX6a6+jmflwt6/g25+6s8yVCkBhBYgSJESRGkBhBYgSJESRGkBhBYgSJESRGkBhBYgSJESRGkBhBYgSJESRGkBhBYgSJESRGkBhBYgSJESRGkBhBYgSJESRGkBhBYgSJESRGkBhBYgSJESRGkBhBYgSJESRGkJi380x3878729j+nPx8/Drn0fXD+Lhu48ucAPDfWMbty+X8789yeBqfT3/PdXR4GO/Hsp7NuTvLcvu85yOY37er04u5jg73qyOY/DuCxAgSI0iMIDGCxAgSI0iMIDGCxAgSI0iMIDGCxAgSI0iMIDGCxAgSI0iMIDGCxAgSI0iMIDGCxAgSI0iMIDGCxAgSI0iMIDGCxAgSI0iMIDGCxAgSI0iMIDGCxAgSI0iMIDGCpIzxF44oJKb+uryCAAAAAElFTkSuQmCC"
    }
  ],
  "sendOptions": {
    "enableDeliveryReport": true,
    "tag": "CustomerId"
  }
}

Przykładowa odpowiedź

Kod stanu:
202 
{
  "value": [
    {
      "to": "+18335852071",
      "messageId": "9f339141-1539-49e1-828f-80ee3b5804e5",
      "httpStatusCode": 202,
      "successful": true
    },
    {
      "to": "+11234567890",
      "messageId": "571697e9-baba-4d8a-b493-e919bde9723a",
      "httpStatusCode": 202,
      "successful": true
    },
    {
      "to": "+112345678910abc",
      "httpStatusCode": 400,
      "errorMessage": "Invalid phone number format.",
      "successful": false
    }
  ]
}

Definicje

Nazwa Opis
MmsContentType

Typ załącznika MIME.
MmsRecipient

Reprezentuje właściwości pojedynczego adresata.
MmsSendMessageRequest

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

Opcjonalna konfiguracja wysyłania komunikatów MMS.
MmsSendRequestAttachment

Reprezentuje właściwości załącznika żądania wysyłania.
MmsSendResponse

Odpowiedź na żądanie wysyłania mms o pomyślnym lub wielostanowym stanie.
MmsSendResponseItem

Odpowiedź MMS dla pojedynczego adresata.

MmsContentType

Wyliczanie

Typ załącznika MIME.

Wartość Opis
audio/ac3
audio/amr
audio/wav
audio/x-wav
image/bmp
image/gif
image/jpeg
image/png
text/plain
video/mp4
video/x-msvideo

MmsRecipient

Objekt

Reprezentuje właściwości pojedynczego adresata.

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

minLength: 1

Numer telefonu odbiorcy w formacie E.164.

MmsSendMessageRequest

Objekt

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

Nazwa Typ Opis
attachments

MmsSendRequestAttachment[]

Lista załączników multimedialnych do uwzględnienia w ramach programu MMS. Możesz mieć maksymalnie 10 załączników.
from

string

Identyfikator nadawcy (zazwyczaj numer telefonu w formacie E.164), który jest własnością uwierzytelnionego konta.
message

string

minLength: 0
maxLength: 1000

Zawartość wiadomości, która zostanie wysłana do adresata.
recipients

MmsRecipient[]

Numery telefonów adresatów w formacie E.164.
sendOptions

MmsSendOptions

Opcjonalna konfiguracja wysyłania komunikatów MMS.

MmsSendOptions

Objekt

Opcjonalna konfiguracja wysyłania komunikatów MMS.

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.

MmsSendRequestAttachment

Objekt

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

Nazwa Typ Opis
contentInBase64

string (byte)

minLength: 1

Zawartość załącznika zakodowana w bazie 64.
contentType

MmsContentType

Typ załącznika MIME.

MmsSendResponse

Objekt

Odpowiedź na żądanie wysyłania mms o pomyślnym lub wielostanowym stanie.

Nazwa Typ Opis
value

MmsSendResponseItem[]

Odpowiedź MMS dla pojedynczego adresata.

MmsSendResponseItem

Objekt

Odpowiedź MMS dla pojedynczego adresata.

Nazwa Typ Opis
errorMessage

string

Opcjonalny komunikat o błędzie w przypadku błędów 4xx/5xx/powtarzalnych.
httpStatusCode

integer (int32)

Kod stanu HTTP.
messageId

string

Identyfikator wiadomości wychodzącej. 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

minLength: 1

Numer telefonu odbiorcy w formacie E.164.