Skip to content

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

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

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

اندپوینت

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

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

پارامترنوعالزامیتوضیحات
namestringبلهنام مشترک
mobilestringبلهشماره موبایل مشترک
activationstringبلهکد فعال‌سازی دریافت شده از طریق SMS

نمونه‌ها

cURL

curl --location --request POST 'https://site.com/wp-json/wpsms/v1/newsletter/verify?name=John&mobile=0911111113&activation=1857' \
--header 'Authorization: Basic YOUR_API_KEY'

PHP

<?php
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://site.com/wp-json/wpsms/v1/newsletter/verify?name=John&mobile=0911111113&activation=1857',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Basic YOUR_API_KEY',
  ),
));

$response = curl_exec($curl);
curl_close($curl);
echo $response;

پاسخ

موفقیت‌آمیز

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

فرآیند تایید

  1. کاربر از طریق اندپوینت عضویت در خبرنامه عضو می‌شود
  2. سیستم یک SMS حاوی کد فعال‌سازی ارسال می‌کند
  3. کاربر کد را از طریق این اندپوینت تایید ارسال می‌کند
  4. پس از تایید موفق، مشترک فعال می‌شود

احراز هویت

این اندپوینت نیاز به احراز هویت دارد. هدر Authorization را با اطلاعات معتبر ارسال کنید.

مرتبط

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