v1 rent

Liste der verfügbaren Dienste und Länder für Miete abrufen

POST{yourserver}/getServicesRent

Diese Anfrage wird alle 5 Minuten vom OnlineSIM-Server an Ihren Server gesendet, um die Anzahl der zur Miete verfügbaren Nummern abzufragen. Ihr Server sollte die Anzahlen im unten beschriebenen Format zurückgeben.

Ihr Partner-API-Schlüssel wird im Anfragetext übergeben. Die Unterstützung der Miete, die URL und die genauen Miet-Schlüssel hängen von der Integration ab.

Anforderungs-Body

Anfragetext vom OnlineSIM-Server

Content-Typeapplication/json
Schema
schemaobject
actionstringErforderlich
Name der Methode, in diesem Fall GET_SERVICESEnumeration:GET_SERVICESBeispiel:GET_SERVICES
keystringErforderlich
API-Schlüssel Ihres OnlineSIM-PartnerprofilsBeispiel:apikey

Beispiele

request

GET_SERVICES-Anfrage vom OnlineSIM-Server (für die Miete)

{
  "action": "GET_SERVICES",
  "key": "apikey"
}

Antworten

200Die Antwort Ihres Servers auf GET_SERVICES
Content-Typeapplication/json
Schema
schemaobject
countryListobject[]ErforderlichListe der Länder mit der Anzahl verfügbarer Nummern pro Betreiber und Dienst. Länder und Dienste, die OnlineSIM nicht kennt, werden ignoriert; negative Anzahlen werden als 0 gelesen.Beispiel:[ { "country": "russia", "operatorMap": { "any": { "vk": 10, "ok": 25, "wa": 52 } } } ]
statusstring
Status der AnfrageEnumeration:SUCCESSERRORBeispiel:SUCCESS

Beispiele

sharedEndpointZeilen: 28

Gemeinsame Antwort für Miete und Aktivierungen für einen Dienst

{
  "countryList": [
    {
      "country": "russia",
      "operatorMap": {
        "any": {
          "vk": 10,
          "ok": 25,
          "wa": 52,
          "rent": 19,
          "rent_noext": 7
        }
      }
    },
    {
      "country": "ukraine",
      "operatorMap": {
        "any": {
          "vk": 10,
          "ok": 50,
          "wa": 132,
          "rent": 21
        }
      }
    }
  ],
  "status": "SUCCESS"
}
rentPerPeriod

Antwort nur für die Miete mit Anzahlen pro Mietzeitraum

{
  "countryList": [
    {
      "country": "russia",
      "operatorMap": {
        "any": {
          "rent1": 19,
          "rent7": 12,
          "rent30": 5,
          "rent_noext1": 4
        }
      }
    }
  ],
  "status": "SUCCESS"
}

Codebeispiele

Beispiele werden generiert...