Opt Outs - Add

服务:

Communication

API 版本:

2025-05-29-preview

将电话号码添加到选择列表，该列表应停止从发件人号码接收消息。

POST {endpoint}/sms/optouts:add?api-version=2025-05-29-preview

URI 参数

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

请求正文

名称	必需	类型	说明
from	True	string minLength: 1	发件人的标识符（通常是 E.164 格式的电话号码）由经过身份验证的帐户拥有。
recipients	True	OptOutRecipient[]	单个选择退出收件人号码。

响应

名称	类型	说明
200 OK	OptOutResponse	成功

示例

Opt Out

示例请求

HTTP

POST {endpoint}/sms/optouts:add?api-version=2025-05-29-preview

{
  "from": "+18001234567",
  "recipients": [
    {
      "to": "+15555555551"
    },
    {
      "to": "+123"
    },
    {
      "to": "+15555555552"
    }
  ]
}

示例响应

状态代码:

200

{
  "value": [
    {
      "to": "+15555555551",
      "httpStatusCode": 200
    },
    {
      "to": "+123",
      "httpStatusCode": 400,
      "errorMessage": "Invalid recipient phone number format"
    },
    {
      "to": "+15555555552",
      "httpStatusCode": 500,
      "errorMessage": "Internal Server Error"
    }
  ]
}

定义

名称	说明
OptOutRecipient	单个选择退出收件人号码。
OptOutRequest	选择退出请求。
OptOutResponse	选择退出请求的响应。 验证响应中返回的项目，以查看哪些收件人已成功从选择退出列表中添加或删除。
OptOutResponseItem

OptOutRecipient

Object

单个选择退出收件人号码。

名称	类型	说明
to	string minLength: 1	收件人的电话号码（采用 E.164 格式）。

OptOutRequest

Object

选择退出请求。

名称	类型	说明
from	string minLength: 1	发件人的标识符（通常是 E.164 格式的电话号码）由经过身份验证的帐户拥有。
recipients	OptOutRecipient[]	单个选择退出收件人号码。

OptOutResponse

Object

选择退出请求的响应。 验证响应中返回的项目，以查看哪些收件人已成功从选择退出列表中添加或删除。

名称	类型	说明
value	OptOutResponseItem[]

OptOutResponseItem

Object

名称	类型	说明
errorMessage	string	如果出现 4xx/5xx 错误，则为可选错误消息。
httpStatusCode	integer (int32)
isOptedOut	boolean	可选标志，指定是否选择退出号码接收消息
to	string minLength: 1	收件人电话号码（采用 E.164 格式）。