Opt Outs - Add

Služba:

Communication

Verze rozhraní API:

2025-05-29-preview

Přidejte telefonní čísla do seznamu odhlasovaných oznámení, která přestanou přijímat zprávy od čísla odesílatele.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string (url)	Komunikační prostředek, například https://my-resource.communication.azure.com
api-version	query	True	string	Verze rozhraní API k vyvolání

Text požadavku

Name	Vyžadováno	Typ	Description
from	True	string minLength: 1	Identifikátor odesílatele (obvykle telefonní číslo ve formátu E.164), který vlastní ověřený účet.
recipients	True	OptOutRecipient[]	Jediné vyjádření nesouhlasu s číslem příjemce.

Odpovědi

Name	Typ	Description
200 OK	OptOutResponse	Úspěch

Příklady

Opt Out

Ukázkový požadavek

HTTP

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

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

Ukázková odpověď

Stavový kód:

200

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

Definice

Name	Description
OptOutRecipient	Jediné vyjádření nesouhlasu s číslem příjemce.
OptOutRequest	Žádost o odhlášení.
OptOutResponse	Odpověď na žádost o odhlášení. Ověřte vrácené položky v odpovědi a zjistěte, kteří příjemci byli úspěšně přidáni nebo odebráni ze seznamu odhlášení.
OptOutResponseItem

OptOutRecipient

Objekt

Jediné vyjádření nesouhlasu s číslem příjemce.

Name	Typ	Description
to	string minLength: 1	Telefonní číslo příjemce (ve formátu E.164).

OptOutRequest

Objekt

Žádost o odhlášení.

Name	Typ	Description
from	string minLength: 1	Identifikátor odesílatele (obvykle telefonní číslo ve formátu E.164), který vlastní ověřený účet.
recipients	OptOutRecipient[]	Jediné vyjádření nesouhlasu s číslem příjemce.

OptOutResponse

Objekt

Odpověď na žádost o odhlášení. Ověřte vrácené položky v odpovědi a zjistěte, kteří příjemci byli úspěšně přidáni nebo odebráni ze seznamu odhlášení.

Name	Typ	Description
value	OptOutResponseItem[]

OptOutResponseItem

Objekt

Name	Typ	Description
errorMessage	string	Volitelná chybová zpráva v případě chyb 4xx/5xx.
httpStatusCode	integer (int32)
isOptedOut	boolean	Volitelný příznak určující, jestli bylo číslo odhlasováno od příjmu zpráv
to	string minLength: 1	Telefonní číslo příjemce (ve formátu E.164).