API الإيجار

API هي البروتوكول الخاص بالتواصل بين برنامجك وخادم تأجير الأرقام الخاص بنا.

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

يجب أن تذهب جميع الطلبات إلى https://api.sms-man.com/rent-api/ كطلب GET. يجب أن تتضمن جميع الطلبات مفتاح API كمعامل token. جميع الإجابات تكون بصيغة json.

طلب الرصيد

المعلمات

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

النتيجة

{
  "balance": "799.70"
}

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

{
  "success": false,
  "error_code": "wrong_token",
  "error_msg": {"token":"Wrong token!"}
}

احصل على الحدود

المعلمات

معامل	النوع	مطلوب	القيمة
`token`	String	نعم	مفتاح API الخاص بك
`country_id`	Integer	نعم
`type`	String	نعم	`hour` / `day` / `week` / `month`
`time`	String	نعم	مدة الإيجار

النتيجة

{
  "type": "hour",
  "time": "4",
  "limits": [
    {"country_id":"1","count":"127","cost":"151.68"},
    {"country_id":"2","count":"49","cost":"113.56"},
    {"country_id":"4","count":"0","cost":"151.68"}
  ]
}

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

{
  "success": false,
  "error_code": "wrong_token",
  "error_msg": {"token":"Wrong token!"}
}

طلب رقم للإيجار

المعلمات

معامل	النوع	مطلوب	القيمة
`token`	String	نعم	مفتاح API الخاص بك
`country_id`	Integer	نعم
`type`	String	نعم	`hour` / `day` / `week` / `month`
`time`	String	نعم	مدة الإيجار

النتيجة

{
  "request_id": 1,
  "country_id": 1,
  "number": "79002415539"
}

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

{
  "success": false,
  "error_code": "wrong_token",
  "error_msg": {"token":"Wrong token!"}
}

طلب رقم جزئي للإيجار

المعلمات

معامل	النوع	مطلوب	القيمة
`token`	String	نعم	مفتاح API الخاص بك
`country_id`	Integer	نعم
`application_id`	Integer	نعم
`type`	String	نعم	`hour` / `day` / `week` / `month`
`time`	String	نعم	مدة الإيجار

النتيجة

{
  "request_id": 1,
  "country_id": 1,
  "application_id": 1,
  "number": "79002415539"
}

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

{
  "success": false,
  "error_code": "wrong_token",
  "error_msg": {"token":"Wrong token!"}
}

تغيير الحالة

المعلمات

معامل	النوع	مطلوب	القيمة
`token`	String	نعم	مفتاح API الخاص بك
`request_id`	Integer	نعم	ID الطلب
`status`	String	نعم	`close` - إنهاء الإيجار

النتيجة

{
  "request_id": 1,
  "success": true
}

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

{
  "success": false,
  "error_code": "wrong_token",
  "error_msg": {"token":"Wrong token!"}
}

استلم الرسالة النصية الأخيرة

المعلمات

معامل	النوع	مطلوب	القيمة
`token`	String	نعم	مفتاح API الخاص بك
`request_id`	Integer	نعم	ID الطلب

النتيجة

{
  "request_id": "10",
  "country_id": 1,
  "number": "79633002801",
  "sms": {"message":"message","code":"code","time":"2020-12-12 14:50:31"}
}

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

{
  "success": false,
  "error_code": "wrong_token",
  "error_msg": {"token":"Wrong token!"}
}

استلم جميع رسائل SMS

المعلمات

معامل	النوع	مطلوب	القيمة
`token`	String	نعم	مفتاح API الخاص بك
`request_id`	Integer	نعم	ID الطلب

النتيجة

{
  "request_id": "10",
  "country_id": 1,
  "number": "79633002801",
  "sms": [
    {"message":"message","code":"code","time":"2020-12-12 14:50:31"}
  ]
}

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

{
  "success": false,
  "error_code": "wrong_token",
  "error_msg": {"token":"Wrong token!"}
}

احصل على قائمة بجميع الأرقام

المعلمات

معامل	النوع	مطلوب	القيمة
`token`	String	نعم	Your API KEY

النتيجة

[
  {"id":1,"country_id":1,"number":"79002415539","status":"cancel"}
]

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

{
  "success": false,
  "error_code": "wrong_token",
  "error_msg": {"token":"Wrong token!"}
}