نقطة نهاية إلغاء الاشتراك في النشرة الإخبارية

تتيح لك نقطة النهاية هذه إلغاء اشتراك المستخدمين من النشرة الإخبارية عبر الرسائل القصيرة برمجياً.

نقطة النهاية

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

المصادقة

اعتباراً من الإصدار 6.9.4، المصادقة مطلوبة لجميع نقاط نهاية /newsletter/*. يجب أن يمتلك المستخدم المصادق صلاحية wpsms_subscribers.

استخدم كلمات مرور التطبيقات في WordPress للمصادقة. تعرف على المزيد حول مصادقة REST API في WordPress.

معاملات الطلب

المعامل	النوع	مطلوب	الوصف
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": []
}

ذات صلة

• نقطة نهاية الاشتراك في النشرة الإخبارية - اشتراك المستخدمين في النشرة الإخبارية
• نقطة نهاية التحقق من النشرة الإخبارية - التحقق من أرقام هواتف المشتركين