post{yourserver}/getServices

POST /getServices

Liste der verfügbaren Dienste und Länder abrufen

Diese Anfrage wird vom Onlinesim-Server an Ihren Server jede Minute gesendet, um die aktuelle Anzahl der verfügbaren Nummern zu erhalten. Ihr Server muss die Anzahl der Nummern im unten beschriebenen Listenformat zurückgeben.

Für die Authentifizierung wird Ihr Partner-API-Schlüssel verwendet, der im Anfragetext übergeben wird.

Parameter

header1
NameTypBeschreibung
Authorization*string

Siehe Details hier

Anforderungs-Body

Anfragetext vom Onlinesim-Server

Content-Typeapplication/json
Schema
Bodyobject
actionstringErforderlich

Name der Methode, in diesem Fall GET_SERVICES

Enumeration:GET_SERVICESStandard:GET_SERVICES
keystringErforderlich

API-Schlüssel Ihres Onlinesim-Partnerprofils

Beispiele

Example payload of Onlinesim server GET_SERVICES request
{
  "action": "GET_SERVICES",
  "key": "apikey"
}

Antworten

200

"Die Antwort Ihres Servers auf die Anfrage GET_SERVICES muss im folgenden Format sein:"

Content-Typeapplication/json

Header

NameTypBeschreibung
Content-Typestring

Header Content type und Codierung

Schema
Responseobject
countryListobject[]Erforderlich

Liste der Länder mit den jeweiligen verfügbaren Nummernanzahlen pro Betreiber und Dienst

itemsobject
countrystringErforderlich

Ein Objekt, dessen Schlüssel Ländernamen gemäß der Länderliste sind

operatorMapobjectErforderlich

Ein Objekt, bei dem jeder Schlüssel ein Betreibername gemäß der Betreiberliste ist. Der Schlüssel any ist erforderlich und muss die Gesamtanzahl der Nummern über alle Betreiber für jeden Dienst enthalten

anyobjectErforderlich

Gesamtanzahl der Nummern für alle Betreiber für jeden Dienst. Für den Dienst "SMS-Empfang" sind die Schlüssel die Dienstnamen gemäß der Dienstliste; für den Dienst "Miete" ist der Schlüssel rent

[additionalProperties]integer

Anzahl der verfügbaren Nummern für diesen Dienst (oder rent)

≥ 0
[additionalProperties]object

Daten über die Anzahl der Nummern für einen bestimmten Betreiber (nicht any). Schlüssel sind Dienstnamen gemäß der Dienstliste, für den Dienst "Miete" – der Schlüssel ist rent

[additionalProperties]integer

Anzahl der verfügbaren Nummern für diesen Dienst bei diesem Betreiber

≥ 0
statusstringErforderlich

Status der Anfrageausführung (SUCCESS oder ERROR)

Enumeration:SUCCESSERROR

Beispiele

Response example from your server50 Zeilen
{
  "countryList": [
    {
      "country": "russia",
      "operatorMap": {
        "any": {
          "vk": 10,
          "ok": 25,
          "wa": 52
        },
        "beeline": {
          "vk": 10,
          "ok": 15,
          "wa": 20
        },
        "megafon": {
          "vk": 0,
          "ok": 10,
          "wa": 32
        }
      }
    },
    {
      "country": "ukraine",
      "operatorMap": {
        "any": {
          "vk": 10,
          "ok": 50,
          "wa": 132
        },
        "life": {
          "vk": 0,
          "ok": 10,
          "wa": 32
        },
        "vodafone": {
          "vk": 10,
          "ok": 10,
          "wa": 0
        },
        "kyivstar": {
          "vk": 0,
          "ok": 30,
          "wa": 100
        }
      }
    }
  ],
  "status": "SUCCESS"
}

Codebeispiele

Beispiele werden generiert...