Opt Outs - Remove

Szolgáltatás:

Communication

API-verzió:

2026-01-23

Telefonszámok eltávolítása a leiratkozási listáról.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string (url)	A kommunikációs erőforrás, például https://my-resource.communication.azure.com
api-version	query	True	string	A meghívandó API verziója.

Kérelem törzse

Name	Kötelező	Típus	Description
from	True	string minLength: 1	A feladó azonosítója (általában telefonszám E.164 formátumban), amely a hitelesített fiók tulajdonában van.
recipients	True	OptOutRecipient[]	Egyetlen leiratkozási címzett száma.

Válaszok

Name	Típus	Description
200 OK	OptOutResponse	Success
400 Bad Request	BadRequestErrorResponse	Hibás kérés
401 Unauthorized	StandardErrorResponse	Nem engedélyezett

Példák

Opt In

Mintakérelem

HTTP

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

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

Mintaválasz

Állapotkó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"
    }
  ]
}

Állapotkó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
  }
}

Állapotkód:

401

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

Definíciók

Name	Description
BadRequestErrorResponse	Hibás kérés hibaválasz, amely érvényesítési hibákat és szabványos API-hibákat is jelenthet.
ErrorDetail	Hiba részletei.
OptOutRecipient	Egyetlen leiratkozási címzett száma.
OptOutRequest	Leiratkozási kérelem.
OptOutResponse	Válasz egy leiratkozási kérelemre. Ellenőrizze a válaszban a visszaadott elemeket, hogy lássa, mely címzetteket adta hozzá vagy távolította el sikeresen a leiratkozási listáról.
OptOutResponseItem
StandardErrorResponse	Szabványos hibaválasz formátum.

BadRequestErrorResponse

Objektum

Hibás kérés hibaválasz, amely érvényesítési hibákat és szabványos API-hibákat is jelenthet.

Name	Típus	Description
error	ErrorDetail	Hiba részletei (standard API-hibák esetén).
errors	object	Mezőspecifikus érvényesítési hibák szótára (érvényesítési hibák esetén).
status	integer (int32)	A HTTP-állapotkód (érvényesítési hibák esetén).
title	string	A probléma típusának rövid, ember által olvasható összefoglalása (érvényesítési hibák esetén).
traceId	string	A kérelem nyomkövetési azonosítója (érvényesítési hibák esetén).
type	string	A probléma típusát azonosító URI-hivatkozás (érvényesítési hibák esetén).

ErrorDetail

Objektum

Hiba részletei.

Name	Típus	Description
code	string	A hibakód.
innerError	object	További hibaadatok.
message	string	A hibaüzenet.

OptOutRecipient

Objektum

Egyetlen leiratkozási címzett száma.

Name	Típus	Description
to	string minLength: 1	A címzett telefonszáma (E.164 formátumban).

OptOutRequest

Objektum

Leiratkozási kérelem.

Name	Típus	Description
from	string minLength: 1	A feladó azonosítója (általában telefonszám E.164 formátumban), amely a hitelesített fiók tulajdonában van.
recipients	OptOutRecipient[]	Egyetlen leiratkozási címzett száma.

OptOutResponse

Objektum

Válasz egy leiratkozási kérelemre. Ellenőrizze a válaszban a visszaadott elemeket, hogy lássa, mely címzetteket adta hozzá vagy távolította el sikeresen a leiratkozási listáról.

Name	Típus	Description
value	OptOutResponseItem[]

OptOutResponseItem

Objektum

Name	Típus	Description
errorMessage	string	Opcionális hibaüzenet 4xx/5xx hiba esetén.
httpStatusCode	integer (int32)
isOptedOut	boolean	Opcionális jelző, amely meghatározza, hogy a szám le lett-e tiltva az üzenetek fogadására
to	string minLength: 1	A címzett telefonszáma (E.164 formátumban).

StandardErrorResponse

Objektum

Szabványos hibaválasz formátum.

Name	Típus	Description
error	ErrorDetail	Hiba részletei.