Opt Outs - Remove

Служба:

Communication

Версия API:

2026-01-23

Удалите номера телефонов из списка отказов.

POST {endpoint}/sms/optouts:remove?api-version=2026-01-23

Параметры 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	Success
400 Bad Request	BadRequestErrorResponse	ошибка запроса
401 Unauthorized	StandardErrorResponse	Не авторизовано

Примеры

Opt In

Образец запроса

HTTP

POST {endpoint}/sms/optouts:remove?api-version=2026-01-23

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

Пример ответа

Код состояния:

200

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

Код состояния:

400

{
  "error": {
    "code": "InvalidApiVersion",
    "message": "The HTTP resource that matches the request URI 'https://global.sms.int.communication.microsoft.com/sms/optouts:remove' does not support the API version '2024-12-10w-preview'.",
    "innerError": null
  }
}

Код состояния:

401

{
  "error": {
    "code": "Unauthorized",
    "message": ""
  }
}

Определения

Имя	Описание
BadRequestErrorResponse	Ответ на ошибку плохого запроса, который может представлять собой как ошибки валидации, так и стандартные ошибки API.
ErrorDetail	Подробная информация об ошибке.
OptOutRecipient	Единый номер получателя для отказа.
OptOutRequest	Запрос на отказ.
OptOutResponse	Ответ на запрос об отказе. Проверьте возвращенные элементы в ответе, чтобы узнать, какие получатели были успешно добавлены или удалены из списка отказов.
OptOutResponseItem
StandardErrorResponse	Стандартный формат ответа об ошибке.

BadRequestErrorResponse

Object

Ответ на ошибку плохого запроса, который может представлять собой как ошибки валидации, так и стандартные ошибки API.

Имя	Тип	Описание
error	ErrorDetail	Подробная информация об ошибках (для стандартных ошибок API).
errors	object	Словарь ошибок валидации, специфичных для полей (для ошибок валидации).
status	integer (int32)	Код состояния HTTP (для ошибок проверки).
title	string	Краткая, удобочитаемая краткое описание типа проблемы (для ошибок проверки).
traceId	string	Идентификатор трассировки для запроса (для ошибок проверки).
type	string	Ссылка на URI, определяющая тип проблемы (для ошибок проверки).

ErrorDetail

Object

Подробная информация об ошибке.

Имя	Тип	Описание
code	string	Код ошибки.
innerError	object	Дополнительная информация об ошибке.
message	string	Сообщение об ошибке.

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).

StandardErrorResponse

Object

Стандартный формат ответа об ошибке.

Имя	Тип	Описание
error	ErrorDetail	Подробная информация об ошибке.