Opt Outs - Add

Tjänst:

Communication

API-version:

2025-05-29-preview

Lägg till telefonnummer i listan över avanmälningar som ska sluta ta emot meddelanden från ett avsändarnummer.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string (url)	Kommunikationsresursen, till exempel https://my-resource.communication.azure.com
api-version	query	True	string	Version av API som ska anropas.

Begärandetext

Name	Obligatorisk	Typ	Description
from	True	string minLength: 1	Avsändarens identifierare (vanligtvis telefonnummer i E.164-format) som ägs av det autentiserade kontot.
recipients	True	OptOutRecipient[]	Ett enskilt avanmält mottagarnummer.

Svar

Name	Typ	Description
200 OK	OptOutResponse	Framgång

Exempel

Opt Out

Exempelbegäran

HTTP

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

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

Exempelsvar

Statuskod:

200

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

Definitioner

Name	Description
OptOutRecipient	Ett enskilt avanmält mottagarnummer.
OptOutRequest	En avregistrera begäran.
OptOutResponse	Svar på en begäran om att avregistrera dig. Verifiera de returnerade objekten i svaret för att se vilka mottagare som har lagts till eller tagits bort från avanmälningslistan.
OptOutResponseItem

OptOutRecipient

Objekt

Ett enskilt avanmält mottagarnummer.

Name	Typ	Description
to	string minLength: 1	Mottagarens telefonnummer (i E.164-format).

OptOutRequest

Objekt

En avregistrera begäran.

Name	Typ	Description
from	string minLength: 1	Avsändarens identifierare (vanligtvis telefonnummer i E.164-format) som ägs av det autentiserade kontot.
recipients	OptOutRecipient[]	Ett enskilt avanmält mottagarnummer.

OptOutResponse

Objekt

Svar på en begäran om att avregistrera dig. Verifiera de returnerade objekten i svaret för att se vilka mottagare som har lagts till eller tagits bort från avanmälningslistan.

Name	Typ	Description
value	OptOutResponseItem[]

OptOutResponseItem

Objekt

Name	Typ	Description
errorMessage	string	Valfritt felmeddelande vid 4xx/5xx-fel.
httpStatusCode	integer (int32)
isOptedOut	boolean	Valfri flagga som anger om numret avanmäldes från att ta emot meddelanden
to	string minLength: 1	Mottagarens telefonnummer (i E.164-format).