اندپوینت لغو عضویت خبرنامه

این اندپوینت به شما امکان می‌دهد عضویت کاربران را از خبرنامه SMS خود به صورت برنامه‌نویسی لغو کنید.

اندپوینت

POST /wp-json/wpsms/v1/newsletter/unsubscribe

احراز هویت

از نسخه 6.9.4 به بعد، احراز هویت برای تمام اندپوینت‌های /newsletter/* الزامی است. کاربر احراز هویت شده باید قابلیت wpsms_subscribers را داشته باشد.

از رمزهای عبور برنامه‌ای وردپرس برای احراز هویت استفاده کنید. اطلاعات بیشتر درباره احراز هویت REST API وردپرس.

پارامترهای درخواست

پارامتر	نوع	الزامی	توضیحات
name	string	بله	نام مشترک
mobile	string	بله	شماره موبایل مشترک
group_id	string	خیر	شناسه گروه خاص برای لغو عضویت

نمونه‌ها

PHP با wp_remote_post

<?php
// WordPress username and Application Password
$username = 'your-username';
$password = 'your-application-password';

// Encode credentials for Basic Authentication
$auth = base64_encode("$username:$password");

// Subscriber's information
$postData = array(
    'name'     => 'User Name',
    'mobile'   => '912345678',
    'group_id' => '5', // Optional
);

// The endpoint URL
$url = 'https://site.com/wp-json/wpsms/v1/newsletter/unsubscribe';

// Set up the arguments
$args = array(
    'headers' => array(
        'Authorization' => 'Basic ' . $auth,
        'Content-Type'  => 'application/x-www-form-urlencoded',
    ),
    'body' => $postData,
);

// Make the request
$response = wp_remote_post($url, $args);

if (is_wp_error($response)) {
    echo "Error: " . $response->get_error_message();
} else {
    $body = wp_remote_retrieve_body($response);
    echo "Response: $body";
}

cURL

curl --location --request POST 'https://site.com/wp-json/wpsms/v1/newsletter/unsubscribe' \
--header 'Authorization: Basic YOUR_BASE64_CREDENTIALS' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'name=User Name' \
--data-urlencode 'mobile=912345678' \
--data-urlencode 'group_id=5'

پاسخ

موفقیت‌آمیز

{
  "message": "Your mobile number has been successfully unsubscribed.",
  "error": [],
  "data": []
}

مرتبط

• اندپوینت عضویت در خبرنامه - عضویت کاربران در خبرنامه
• اندپوینت تایید خبرنامه - تایید شماره تلفن مشترکین