किराया 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!"}
}