REST API - Get Credit

Check your account SMS credit balance.

Endpoint

GET https://sms.deals/api/ws.php?service=get_credit

Parameters

Parameter	Type	Required	Description
service	String	Required	Must be get_credit
token	String	Optional	Account identification token

Response

<?xml version="1.0" encoding="UTF-8"?>
<SMS_Service>
    <service>get_credit</service>
    <username>[email protected]</username>
    <status>Success</status>
    <account_credit>-1</account_credit>
</SMS_Service>

Response Variables

Variable	Type	Description
Service	String	get_credit
Username	String	Account username
Status	String	Success or Error
Account_credit	Integer	Credit balance (-1 = unlimited)

PHP Example

<?php
$token = "xxxxxx...";
$params = array("service" => "get_credit");
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://www.sms.deals/api/ws.php",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "UTF-8",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_POSTFIELDS => json_encode($params),
    CURLOPT_HTTPHEADER => array(
        "Authorization: Bearer " . $token
    )
));

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

JSON Response

Request with format=json:

{
    "service": "get_credit",
    "username": "[email protected]",
    "status": "Success",
    "account_credit": -1
}

Credit Values

• A value of -1 indicates unlimited credit
• Positive values indicate the remaining SMS credits
• A value of 0 means no credits remaining

השפעות על המערכת

endpoint הקרדיט הוא כלי ניטור חשוב לבקרת הוצאות:

• ניטור — מומלץ לקרוא ל‑/credit לפני שליחת Bulk גדול כדי לוודא שהחשבון מכיל די נקודות
• חסימת שליחה — כאשר הקרדיט 0 ההודעה לא תישלח; חשבונות unlimited (ערך -1) אינם מוגבלים בנקודות
• התראות — ניתן להגדיר התראות אוטומטיות על ירידה מתחת לרף; מקובל לקרוא ל‑endpoint זה מ‑cron לסריקה תקופתית
• דיווח — ערך הקרדיט זהה למה שמוצג בממשק תחת יתרת SMS
• ללא חיוב — קריאה ל‑/credit אינה עולה נקודה

ראו גם

• שליחה בודדת
• שליחה מרוכזת
• ניהול שולחים