اندپوینت ارسال SMS

این اندپوینت به شما امکان می‌دهد پیامک‌ها را از طریق افزونه ارسال کنید. از آن برای ارسال SMS به یک یا چند گیرنده به صورت برنامه‌نویسی استفاده کنید.

اندپوینت

POST /wp-json/wpsms/v1/send

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

پارامتر	نوع	الزامی	توضیحات
sender	string	خیر	شناسه فرستنده یا شماره تلفن
recipients	string/array	بله	شماره تلفن‌ها یا "subscribers" برای ارسال به گروه‌های مشترکین
group_ids	array	خیر	آرایه‌ای از شناسه‌های گروه مشترکین (زمانی که recipients برابر "subscribers" است)
message	string	بله	محتوای پیامک
media_urls	array	خیر	آرایه‌ای از آدرس‌های رسانه برای پیام‌های MMS

نمونه‌ها

cURL

curl --location --request POST 'https://site.com/wp-json/wpsms/v1/send' \
--header 'Content-Type: application/json' \
--data-raw '{
   "sender": "+15058713629",
   "recipients": "subscribers",
   "group_ids": [13, 4],
   "message": "Hello!",
   "media_urls": [
      "https://site.com/image.jpg"
   ]
}'

PHP

<?php
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://site.com/wp-json/wpsms/v1/send',
  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_POSTFIELDS => json_encode([
    'sender' => '+15058713629',
    'recipients' => 'subscribers',
    'group_ids' => [13, 4],
    'message' => 'Hello!',
    'media_urls' => ['https://site.com/image.jpg']
  ]),
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
  ),
));

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

پاسخ

موفقیت‌آمیز

{
   "message": "Successfully send SMS!",
   "error": [],
   "data": {
      "balance": 2
   }
}

فیلد	نوع	توضیحات
message	string	پیام موفقیت
error	array	آرایه خطاها (در صورت موفقیت خالی است)
data.balance	number	موجودی باقی‌مانده SMS

احراز هویت

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

مرتبط

• API عضویت در خبرنامه - عضویت در خبرنامه از طریق API
• API دریافت اعتبار - بررسی موجودی SMS
• wp_sms_send() - ارسال SMS از طریق تابع PHP