Miet-API

API ist das Protokoll für die Kommunikation zwischen deiner Software und unserem Telefonnummern-Verleihserver.

API-Protokoll Beschreibung

Alle Anfragen müssen an die https://api.sms-man.com/rent-api/ GET-Anfrage gehen. Alle Anfragen müssen den API-Schlüssel als Parameter enthalten token Alle Antworten sind im json-Format.

Kontostand anfordern

Parameter

Parameter	Typ	Erforderlich	Wert
`token`	String	Ja	Dein API-Schlüssel

Ergebnis

{
  "balance": "799.70"
}

Mögliche Fehler

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

Limits erhalten

Parameter

Parameter	Typ	Erforderlich	Wert
`token`	String	Ja	Dein API-Schlüssel
`country_id`	Integer	Ja
`type`	String	Ja	`hour` / `day` / `week` / `month`
`time`	String	Ja	Mietdauer

Ergebnis

{
  "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"}
  ]
}

Mögliche Fehler

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

Bestellung einer Telefonnummer zur Miete

Parameter

Parameter	Typ	Erforderlich	Wert
`token`	String	Ja	Dein API-Schlüssel
`country_id`	Integer	Ja
`type`	String	Ja	`hour` / `day` / `week` / `month`
`time`	String	Ja	Mietdauer

Ergebnis

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

Mögliche Fehler

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

Teilnummer zur Miete bestellen

Parameter

Parameter	Typ	Erforderlich	Wert
`token`	String	Ja	Dein API-Schlüssel
`country_id`	Integer	Ja
`application_id`	Integer	Ja
`type`	String	Ja	`hour` / `day` / `week` / `month`
`time`	String	Ja	Mietdauer

Ergebnis

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

Mögliche Fehler

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

Status ändern

Parameter

Parameter	Typ	Erforderlich	Wert
`token`	String	Ja	Dein API-Schlüssel
`request_id`	Integer	Ja	Anfrage-ID
`status`	String	Ja	`close` - die Miete beenden

Ergebnis

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

Mögliche Fehler

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

Empfang der letzten Textnachricht

Parameter

Parameter	Typ	Erforderlich	Wert
`token`	String	Ja	Dein API-Schlüssel
`request_id`	Integer	Ja	Anfrage-ID

Ergebnis

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

Mögliche Fehler

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

Empfange alle sms

Parameter

Parameter	Typ	Erforderlich	Wert
`token`	String	Ja	Dein API-Schlüssel
`request_id`	Integer	Ja	Anfrage-ID

Ergebnis

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

Mögliche Fehler

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

Eine Liste aller Telefonnummern anzeigen

Parameter

Parameter	Typ	Erforderlich	Wert
`token`	String	Ja	Your API KEY

Ergebnis

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

Mögliche Fehler

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