Opt Outs - Remove

Layanan:

Communication

Versi API:

2026-01-23

Hapus nomor telepon dari daftar pemilih.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string (url)	Sumber daya komunikasi, misalnya https://my-resource.communication.azure.com
api-version	query	True	string	Versi API yang akan dipanggil.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
from	True	string minLength: 1	ID pengirim (biasanya nomor telepon dalam format E.164) yang dimiliki oleh akun yang diautentikasi.
recipients	True	OptOutRecipient[]	Satu nomor penerima penolakan.

Respons

Nama	Jenis	Deskripsi
200 OK	OptOutResponse	Keberhasilan
400 Bad Request	BadRequestErrorResponse	Permintaan Tidak Valid
401 Unauthorized	StandardErrorResponse	Tidak diizinkan

Contoh

Opt In

Permintaan sampel

HTTP

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

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

Respon sampel

Kode status:

200

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

Kode status:

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

Kode status:

401

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

Definisi

Nama	Deskripsi
BadRequestErrorResponse	Respons kesalahan Permintaan Buruk yang dapat mewakili kesalahan validasi dan kesalahan API standar.
ErrorDetail	Informasi detail kesalahan.
OptOutRecipient	Satu nomor penerima penolakan.
OptOutRequest	Permintaan penyisihan.
OptOutResponse	Respons untuk permintaan penolakan. Validasi item yang dikembalikan dalam respons untuk melihat penerima mana yang berhasil ditambahkan atau dihapus dari daftar penyisihan.
OptOutResponseItem
StandardErrorResponse	Format respons kesalahan standar.

BadRequestErrorResponse

Objek

Respons kesalahan Permintaan Buruk yang dapat mewakili kesalahan validasi dan kesalahan API standar.

Nama	Jenis	Deskripsi
error	ErrorDetail	Informasi detail kesalahan (untuk kesalahan API standar).
errors	object	Kamus kesalahan validasi khusus bidang (untuk kesalahan validasi).
status	integer (int32)	Kode status HTTP (untuk kesalahan validasi).
title	string	Ringkasan singkat yang dapat dibaca manusia dari jenis masalah (untuk kesalahan validasi).
traceId	string	Pengidentifikasi pelacakan untuk permintaan (untuk kesalahan validasi).
type	string	Referensi URI yang mengidentifikasi jenis masalah (untuk kesalahan validasi).

ErrorDetail

Objek

Informasi detail kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan.
innerError	object	Detail kesalahan tambahan.
message	string	Pesan kesalahan.

OptOutRecipient

Objek

Satu nomor penerima penolakan.

Nama	Jenis	Deskripsi
to	string minLength: 1	Nomor telepon penerima (dalam format E.164).

OptOutRequest

Objek

Permintaan penyisihan.

Nama	Jenis	Deskripsi
from	string minLength: 1	ID pengirim (biasanya nomor telepon dalam format E.164) yang dimiliki oleh akun yang diautentikasi.
recipients	OptOutRecipient[]	Satu nomor penerima penolakan.

OptOutResponse

Objek

Respons untuk permintaan penolakan. Validasi item yang dikembalikan dalam respons untuk melihat penerima mana yang berhasil ditambahkan atau dihapus dari daftar penyisihan.

Nama	Jenis	Deskripsi
value	OptOutResponseItem[]

OptOutResponseItem

Objek

Nama	Jenis	Deskripsi
errorMessage	string	Pesan kesalahan opsional jika terjadi kesalahan 4xx/5xx.
httpStatusCode	integer (int32)
isOptedOut	boolean	Bendera opsional yang menentukan apakah nomor telah memilih untuk tidak menerima pesan
to	string minLength: 1	Nomor telepon penerima (dalam format E.164).

StandardErrorResponse

Objek

Format respons kesalahan standar.

Nama	Jenis	Deskripsi
error	ErrorDetail	Informasi detail kesalahan.