اندپوینت دریافت اعتبار SMS

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

اندپوینت

GET /wp-json/wpsms/v1/credit

نمونه‌ها

cURL

curl --location --request GET 'https://site.com/wp-json/wpsms/v1/credit' \
--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/credit',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Basic YOUR_API_KEY',
  ),
));

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

پاسخ

موفقیت‌آمیز

{
    "credit": "10.00 USD"
}

فیلد	نوع	توضیحات
credit	string	موجودی اعتبار باقی‌مانده به همراه واحد ارز

احراز هویت

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

• مدیران وب‌سایت
• کاربرانی که مجوز مشاهده اطلاعات اعتبار را دارند

مرتبط

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