Skip to content

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

اندپوینت REST API برای عضویت کاربران در خبرنامه SMS شما.

این اندپوینت به شما امکان می‌دهد کاربران را به صورت برنامه‌نویسی در خبرنامه SMS خود عضو کنید. برای یکپارچه‌سازی با فرم‌های سفارشی یا فرم‌سازهایی که به طور مستقیم پشتیبانی نمی‌شوند مفید است.

اندپوینت

POST /wp-json/wpsms/v1/newsletter

احراز هویت

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

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

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

پارامترنوعالزامیتوضیحات
namestringبلهنام مشترک
mobilestringبلهشماره موبایل مشترک

نمونه‌ها

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'
);

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

// 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' \
--header 'Authorization: Basic YOUR_BASE64_CREDENTIALS' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'name=User Name' \
--data-urlencode 'mobile=912345678'

پاسخ

موفقیت‌آمیز

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

مرتبط

آخرین به‌روزرسانی: ۳ دی ۱۴۰۳