Mms - Send

服务:

Communication

API 版本:

2024-01-14-preview

从属于经过身份验证的帐户的电话号码发送 MMS 消息。

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

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string (url)	通信资源，例如 https://resourcename.communication.azure.com
api-version	query	True	string	要调用的 API 版本

请求正文

名称	必需	类型	说明
attachments	True	MmsSendRequestAttachment[]	要作为 MMS 的一部分包含的媒体附件列表。 最多可以有 10 个附件。
from	True	string	发件人的标识符（通常是 E.164 格式的电话号码）由经过身份验证的帐户拥有。
recipients	True	MmsRecipient[]	E.164 格式的收件人电话号码。
message		string minLength: 0 maxLength: 1000	要发送给收件人的邮件的内容。
sendOptions		MmsSendOptions	用于发送 MMS 消息的可选配置。

响应

名称	类型	说明
202 Accepted	MmsSendResponse	接受

示例

Send Message

示例请求

HTTP

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

示例响应

状态代码:

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

定义

名称	说明
MmsContentType	MIME 类型的附件。
MmsRecipient	表示单个收件人的属性。
MmsSendMessageRequest	表示发送 MMS 消息请求的属性。
MmsSendOptions	用于发送 MMS 消息的可选配置。
MmsSendRequestAttachment	表示发送请求附件的属性。
MmsSendResponse	成功或多状态彩信发送请求的响应。
MmsSendResponseItem	单个收件人的 MMS 响应。

MmsContentType

枚举

MIME 类型的附件。

值	说明
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

Object

表示单个收件人的属性。

名称	类型	说明
repeatabilityFirstSent	string	必须由客户端发送，以指定请求可重复。 可重复性 -First-Sent 用于指定请求首次 created.eg- 2019 年 3 月 26 日 16：06：51 GMT 的日期和时间。
repeatabilityRequestId	string	如果指定，客户端将指示请求可重复;也就是说，客户端可以使用相同的可重复性-Request-ID 多次发出请求，并返回适当的响应，而无需服务器多次执行请求。 Repeatability-Request-ID 的值是一个不透明字符串，表示请求的 UUID （GUID） 标识符的客户端生成的 36 个字符十六进制不区分大小写编码。
to	string minLength: 1	收件人的电话号码采用 E.164 格式。

MmsSendMessageRequest

Object

表示发送 MMS 消息请求的属性。

名称	类型	说明
attachments	MmsSendRequestAttachment[]	要作为 MMS 的一部分包含的媒体附件列表。 最多可以有 10 个附件。
from	string	发件人的标识符（通常是 E.164 格式的电话号码）由经过身份验证的帐户拥有。
message	string minLength: 0 maxLength: 1000	要发送给收件人的邮件的内容。
recipients	MmsRecipient[]	E.164 格式的收件人电话号码。
sendOptions	MmsSendOptions	用于发送 MMS 消息的可选配置。

MmsSendOptions

Object

用于发送 MMS 消息的可选配置。

名称	类型	说明
enableDeliveryReport	boolean	启用此标志以在 Azure Resource EventGrid 上接收此消息的传递报告。
tag	string	使用此字段提供元数据，然后将发送回相应的传递报告。

MmsSendRequestAttachment

Object

表示发送请求附件的属性。

名称	类型	说明
contentInBase64	string (byte) minLength: 1	以 base 64 编码的附件的内容。
contentType	MmsContentType	MIME 类型的附件。

MmsSendResponse

Object

成功或多状态彩信发送请求的响应。

名称	类型	说明
value	MmsSendResponseItem[]	单个收件人的 MMS 响应。

MmsSendResponseItem

Object

单个收件人的 MMS 响应。

名称	类型	说明
errorMessage	string	可选错误消息（如果出现 4xx/5xx/可重复错误）。
httpStatusCode	integer (int32)	HTTP 状态代码。
messageId	string	传出消息的标识符。 仅当消息已处理时才存在。
repeatabilityResult	enum: accepted rejected	可重复请求的结果，其中一个不区分大小写的值已接受或拒绝。
successful	boolean	指示消息是否已成功处理。
to	string minLength: 1	收件人的电话号码采用 E.164 格式。