API المتوافقة

API هي بروتوكول التفاعل بين برنامجك وخادم التفعيل الخاص بنا. تُستخدم API لأتمتة عملية استلام رسائل SMS للتفعيل من جانبك. لاستخدام API، يجب عليك استخدام مفتاح API الخاص بك، يمكنك الحصول عليه في قسم الملف الشخصي، بعد اجتياز إجراء تسجيل بسيط. API الخاصة بنا متوافقة تمامًا مع مواقع SMS المنافسة.

وصف بروتوكول API

يجب أن تذهب جميع الطلبات إلى https://api.sms-man.com/stubs/handler_api.php طلب POST أو GET. يجب أن تحتوي جميع الطلبات على مفتاح API في شكل معلمة api_key. جميع الإجابات بتنسيق JSON

طلب الرصيد

المعلمات

معامل	النوع	مطلوب	القيمة
`action`	String	نعم	`getBalance`
`api_key`	String	نعم	مفتاح API الخاص بك

النتيجة

ACCESS_BALANCE:$balance (حيث $balance هو رصيد حسابك)

الأخطاء المحتملة

خطأ	الوصف
`BAD_KEY`	مفتاح API غير صحيح

احصل على الأسعار الحالية

المعلمات

معامل	النوع	مطلوب	القيمة
`action`	String	نعم	`getPrices`
`api_key`	String	نعم	مفتاح API الخاص بك
`country`	Number	لا
`service`	String	لا

النتيجة

{
  "0": {"vk":{"cost":"15","count":6455},"wb":{"cost":"50","count":124}},
  "1": {"fb":{"cost":"6","count":1000}}
}

الأخطاء المحتملة

خطأ	الوصف
`BAD_KEY`	مفتاح API غير صحيح

احصل على رقم

المعلمات

معامل	النوع	مطلوب	القيمة
`action`	String	نعم	`getNumber`
`api_key`	String	نعم	مفتاح API الخاص بك
`country`	Number	نعم
`service`	String	نعم
`maxPrice`	Number	لا	القيمة المطلوبة الخاصة بك
`currency`	String	لا	`RUB/USD/EUR`
`ref`	String	لا	قم بتمرير ID الإحالة

النتيجة

ACCESS_NUMBER:$id:$number
$id - ID التفعيل
$number - رقم الهاتف

الأخطاء المحتملة

خطأ	الوصف
`BAD_KEY`	مفتاح API غير صحيح
`NO_NUMBERS`	لا توجد أرقام، حاول مرة أخرى لاحقًا
`NO_BALANCE`	رصيد منخفض

الحصول على حالة التفعيل

المعلمات

معامل	النوع	مطلوب	القيمة
`action`	String	نعم	`getStatus`
`api_key`	String	نعم	مفتاح API الخاص بك
`id`	Number	نعم	ID التفعيل

النتيجة

STATUS_WAIT_CODE - رسائل SMS قيد الانتظار
STATUS_WAIT_RETRY:$lastcode - في انتظار تحسين الرمز (حيث $lastcode - آخر رمز فاشل)
STATUS_WAIT_RESEND — في انتظار إعادة إرسال رسالة SMS (يجب على البرنامج الضغط على إعادة إرسال رسالة SMS وإجراء تغيير الحالة إلى 6)
STATUS_CANCEL — تم إلغاء التفعيل
STATUS_OK:$code — الرمز المستلم (حيث يكون $code هو رمز التفعيل)

الأخطاء المحتملة

خطأ	الوصف
`BAD_KEY`	مفتاح API غير صحيح
`NO_ACTIVATION`	لا يوجد تفعيل

الحصول على حالة التفعيل V2

المعلمات

معامل	النوع	مطلوب	القيمة
`action`	String	نعم	`getStatusV2`
`api_key`	String	نعم	مفتاح API الخاص بك
`id`	Number	نعم	ID التفعيل

النتيجة

{
  "verificationType": 0,
  "sms": {"dateTime":"0000-00-00 00:00:00","code":"code","text":"sms text"}
}

STATUS_CANCEL

STATUS_WAIT_CODE

الأخطاء المحتملة

خطأ	الوصف
`BAD_KEY`	مفتاح API غير صحيح
`NO_ACTIVATION`	لا يوجد تفعيل

تغيير حالة التفعيل

المعلمات

معامل	النوع	مطلوب	القيمة
`action`	String	نعم	`setStatus`
`api_key`	String	نعم	مفتاح API الخاص بك
`id`	Number	نعم	ID التفعيل
`status`	Number	نعم	حالة التفعيل

الحالات الممكنة

-1 — إلغاء التفعيل
1 — إعلام بأنه تم إرسال رسالة SMS (اختياري)
3 — طلب رمز آخر
6 — اكمل التفعيل (إذا كانت الحالة "تم استلام الكود" - يتم وضع علامة نجاح ويكتمل، إذا كانت الحالة "قيد التحضير" - يتم الحذف ووضع علامة خطأ، إذا كانت الحالة "في انتظار الإعادة" - يتم تحويل التفعيل إلى انتظار رسالة SMS).
8 — يُبلغ أن الرقم قد تم استخدامه ويلغي التفعيل.

النتيجة

ACCESS_READY - تم تأكيد جاهزية الرقم
ACCESS_RETRY_GET - في انتظار رسالة SMS جديدة
ACCESS_ACTIVATION - تم تفعيل الخدمة بنجاح
ACCESS_CANCEL - تم إلغاء التفعيل
EARLY_CANCEL_DENIED - غير مسموح بإلغاء الرقم خلال أول دقيقتين

الأخطاء المحتملة

خطأ	الوصف
`BAD_KEY`	مفتاح API غير صحيح
`NO_ACTIVATION`	ID التفعيل غير موجود
`BAD_STATUS`	حالة غير صحيحة

احصل على قائمة بجميع الدول

المعلمات

معامل	النوع	مطلوب	القيمة
`action`	String	نعم	`getCountries`
`api_key`	String	نعم	مفتاح API الخاص بك

النتيجة

[
  {"id":0,"name":"Россия","name_en":"Russia"},
  {"id":3,"name":"Китай","name_en":"China"}
]

الأخطاء المحتملة

خطأ	الوصف
`BAD_KEY`	مفتاح API غير صحيح

احصل على قائمة بجميع الخدمات

المعلمات

معامل	النوع	مطلوب	القيمة
`action`	String	نعم	`getServices`
`api_key`	String	نعم	مفتاح API الخاص بك

النتيجة

[
  {"id":"vk","name":"Вконтакте"},
  {"id":"wb","name":"WeChat"},
  {"id":"tg","name":"Telegram"}
]

الأخطاء المحتملة

خطأ	الوصف
`BAD_KEY`	مفتاح API غير صحيح
`BAD_ACTION`	إجراء غير صحيح