Opt Outs - Remove

Služba:

Communication

Verze rozhraní API:

2026-01-23

Odebrat telefonní čísla ze seznamu odhlášení.

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

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ý je vlastněn ověřeným účtem.
recipients	True	OptOutRecipient[]	Jedno číslo příjemce pro odhlášení.

Odpovědi

Name	Typ	Description
200 OK	OptOutResponse	Success
400 Bad Request	BadRequestErrorResponse	Nesprávná žádost
401 Unauthorized	StandardErrorResponse	Neautorizováno

Příklady

Opt In

Ukázkový požadavek

HTTP

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

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

Ukázková odpověď

Stavový kód:

200

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

Stavový kód:

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

Stavový kód:

401

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

Definice

Name	Description
BadRequestErrorResponse	Chybná chybová odpověď požadavku, která může představovat chyby ověření i standardní chyby rozhraní API.
ErrorDetail	Podrobné informace o chybě.
OptOutRecipient	Jedno číslo příjemce pro odhlášení.
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
StandardErrorResponse	Standardní formát chybové odpovědi.

BadRequestErrorResponse

Objekt

Chybná chybová odpověď požadavku, která může představovat chyby ověření i standardní chyby rozhraní API.

Name	Typ	Description
error	ErrorDetail	Podrobné informace o chybě (pro standardní chyby API).
errors	object	Slovník chyb ověřování specifických pro pole (pro chyby ověřování).
status	integer (int32)	Stavový kód HTTP (pro chyby ověření).
title	string	Krátké, lidsky čitelné shrnutí typu problému (pro chyby ověřování).
traceId	string	Identifikátor trasování pro požadavek (v případě chyb ověření).
type	string	Odkaz na identifikátor URI, který identifikuje typ problému (pro chyby ověřování).

ErrorDetail

Objekt

Podrobné informace o chybě.

Name	Typ	Description
code	string	Kód chyby.
innerError	object	Další podrobnosti o chybě.
message	string	Chybová zpráva.

OptOutRecipient

Objekt

Jedno číslo příjemce pro odhlášení.

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ý je vlastněn ověřeným účtem.
recipients	OptOutRecipient[]	Jedno číslo příjemce pro odhlášení.

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á hláška v případě chyb 4xx/5xx.
httpStatusCode	integer (int32)
isOptedOut	boolean	Volitelný příznak určující, zda bylo číslo odhlášeno z přijímání zpráv
to	string minLength: 1	Telefonní číslo příjemce (ve formátu E.164).

StandardErrorResponse

Objekt

Standardní formát chybové odpovědi.

Name	Typ	Description
error	ErrorDetail	Podrobné informace o chybě.