FAQAPI

Nömrənin icarə statusunu əldə et

getRentStatus metodu SMS.online API vasitəsilə icarəyə götürülmüş virtual nömrənin aktual statusunu əldə etmək üçün istifadə olunur. Bu, icarə vəziyyətinin yoxlanılması prosesini avtomatlaşdırmağa və icarəyə götürülmüş nömrəyə gələn SMS kodlarını izləməyə imkan tanıyır.

Bu metod, icarəyə götürülmüş nömrənin müntəzəm monitorinqini tələb edən sistemlər üçün nəzərdə tutulub ki, təsdiq kodlarını və icarə müddətində gələn digər məlumatları vaxtında əldə edə bilsin.

Uğurlu sorğu, icarənin cari statusu, unikal icarə identifikatoru, alınan SMS kodlarının siyahısı və icarənin bitmə vaxtı ilə bağlı məlumatları ehtiva edən bir obyekt qaytarır. Bu, nömrənin istifadəsini və real vaxtda mesajların alınmasını effektiv şəkildə idarə etməyə imkan verir.

Sorğu nümunəsi:

Giriş məlumatları

ParametrMəcburiQeydlərTəsvir
BəliProfilinizdə API Açarı bölməsində baxınAPI açarı ödənilən xidmətlərə giriş təmin edir
BəligetRentStatusMetodun adı
BəliRəqəmsal dəyərNömrə sorğusu zamanı alınan aktivləşdirmə ID-si
XeyrRəqəmsal dəyərSeçim başlanğıcından etibarən səhifə nömrəsi (səhifələrin sayı 0-dan başlayır, yeni olanlardan köhnələrə; default 0)
XeyrRəqəmsal dəyərSoruşulan səhifələrin sayı (default 10)

Serverin cavabı

JSON
{
  "status": "success", 
  "quantity": "2", 
  "values": { 
    "0": { 
      "phoneFrom": "79180230628", 
      "text": "5", 
      "service": "ot", 
      "date": "2020-01-30 14:31:58" 
    }, 
    "1": { 
      "phoneFrom": "79180230628", 
      "text": "4", 
      "service": "ot", 
      "date": "2025-05-30 14:04:16" 
    } 
  } 
}

Kod nümunəsi

const api_key = "API_KEY"; # 'API_KEY' yerinə sizin real API açarınızı qoyun.
const id = 1; # Nömrə sorğusu zamanı alınan aktivləşdirmə ID-sini daxil edin
try {
const response = await fetch(`https://api.sms.onlinestubs/handler_api.php?api_key=${api_key}&action=getRentStatus&id=${id}`);
# Göstərilən URL-ə GET sorğusu icra edirik
const data = await response.json();
# Serverdən alınan cavabın məzmununu çap edirik
console.log(data);
} catch (err) {
# Xəta baş verərsə, xəta mesajını çap edirik
console.error(err);
}

Mümkün xətalar

ParametrTəsvir
Yanlış hərəkət
Yanlış API açarı
Sorğuda xəta
Hesabın bloklandığı vaxt
Hesab aktiv deyil
İcarə ID-si göstərilməyib
Nömrə sizin tərəfinizdən icarəyə götürülməyib (yanlış icarə ID-si)
İcarə ödənilib və başa çatıb
İcarə ləğv edilib və pul geri qaytarılıb
İlk SMS-i gözləyir
Nömrə bloklanıb, sizə vəsait qaytarılıb