Opt Outs - Add

Hizmet:

Communication

API Sürümü:

2025-05-29-preview

Geri çevirme listesine bir gönderen numarasından ileti almayı durduracak telefon numaraları ekleyin.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
endpoint	path	True	string (url)	İletişim kaynağı, örneğin https://my-resource.communication.azure.com
api-version	query	True	string	Çağrılacak API sürümü.

İstek Gövdesi

Name	Gerekli	Tür	Description
from	True	string minLength: 1	Kimliği doğrulanmış hesaba ait olan gönderenin tanımlayıcısı (genellikle E.164 biçimindeki telefon numarası).
recipients	True	OptOutRecipient[]	Tek bir geri çevirme alıcısı numarası.

Yanıtlar

Name	Tür	Description
200 OK	OptOutResponse	Başarı

Örnekler

Opt Out

Örnek isteği

HTTP

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

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

Örnek yanıt

Durum kodu:

200

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

Tanımlar

Name	Description
OptOutRecipient	Tek bir geri çevirme alıcısı numarası.
OptOutRequest	Geri çevirme isteği.
OptOutResponse	Geri çevirme isteği için yanıt. Hangi alıcıların başarıyla eklendiğini veya geri çevirme listesinden kaldırıldığını görmek için yanıtta döndürülen öğeleri doğrulayın.
OptOutResponseItem

OptOutRecipient

Object

Tek bir geri çevirme alıcısı numarası.

Name	Tür	Description
to	string minLength: 1	Alıcının telefon numarası (E.164 biçiminde).

OptOutRequest

Object

Geri çevirme isteği.

Name	Tür	Description
from	string minLength: 1	Kimliği doğrulanmış hesaba ait olan gönderenin tanımlayıcısı (genellikle E.164 biçimindeki telefon numarası).
recipients	OptOutRecipient[]	Tek bir geri çevirme alıcısı numarası.

OptOutResponse

Object

Geri çevirme isteği için yanıt. Hangi alıcıların başarıyla eklendiğini veya geri çevirme listesinden kaldırıldığını görmek için yanıtta döndürülen öğeleri doğrulayın.

Name	Tür	Description
value	OptOutResponseItem[]

OptOutResponseItem

Object

Name	Tür	Description
errorMessage	string	4xx/5xx hatalarında isteğe bağlı hata iletisi.
httpStatusCode	integer (int32)
isOptedOut	boolean	Numaranın iletileri almayı geri çevirip geri çevirmediğini belirten isteğe bağlı bayrak
to	string minLength: 1	Alıcı telefon numarası (E.164 biçiminde).