profile

Profil ändern (Webhook-URL und Standardwerte)

POSThttps://onlinesim.io/api/profile.php

Speichert die in profile übergebenen Felder und gibt das aktualisierte Konto zurück. Nicht übergebene Felder bleiben unverändert. Sowohl JSON als auch Formulardaten (profile[webhook_url]=…) funktionieren.

number_region wird vom Dienst nicht verwendet und ist immer null; ein übergebener Wert wird nicht gespeichert.

Sicherheit

Parameter

query1
NameTypBeschreibung
langstring

Sprache der Texte in der Antwort (Länder- und Dienstnamen, Statustexte): fr, de, ru, en oder zh. Jede Methode akzeptiert ihn; Methoden ohne solche Texte antworten in jeder Sprache gleich. Feldnamen, Fehlercodes und andere feste Werte bleiben auf Englisch. Ohne den Parameter: ru für getTariffs, getNumbersStats und getFreeList; sonst die Sprache des Profils bei Anfragen mit Schlüssel, Englisch bei Anfragen ohne. Ein nicht unterstützter Wert wird durch die Standardsprache ersetzt

Enumeration:frderuenzh

Anforderungs-Body

Erforderlich
Content-Typeapplication/json
Schema
schemaobject
profileobjectErforderlichZu ändernde Felder.

Antworten

200Gespeichertes Konto, Validierungsfehler oder ein Fehlercode:
  • ERROR_PARAMS — profile fehlt oder ist kein Objekt
  • Query Exception — die Datenbank hat die Änderung abgelehnt
Content-Typeapplication/json
Schema
schemaoneOf
Eins von
[0]object
[1]objectValidierungsfehler: Feld → Liste von Meldungen; ein falsches old_password ergibt {"old_password": "<Meldung>"}.
[2]object
[3]object

Beispiele

Validation error

webhook_url ist keine URL

{
  "response": {
    "webhook_url": [
      "The webhook url field must be a valid URL."
    ]
  }
}
ERROR_PARAMS

profile nicht übergeben

{
  "response": "ERROR_PARAMS"
}
429HTTP 429: mehr als 400 Anfragen pro Minute von einem Profil (von einer IP bei Anfragen ohne Schlüssel) oder mehr als 200 Anfragen pro Minute von einem Profil an getNum, getPrice, getState und setOperationOk zusammen
Content-Typeapplication/json
Schema
schemaobject
responsestringErforderlich
Fehlercode. Die Codes, die jede Methode liefern kann, stehen in der Einleitung; jede Methode führt ihre eigenen auf. Die Liste ist nicht geschlossen: behandeln Sie einen unbekannten Code als allgemeinen Fehler und protokollieren Sie ihn.

Beispiele

Rate limit

Anfragelimit überschritten

{
  "response": "TRY_AGAIN_LATER"
}
456HTTP 456: Der API-Schlüssel ist ungültig oder das OAuth-Token ist abgelaufen. Öffentliche Methoden antworten genauso, wenn ein ungültiger Schlüssel übergeben wird
Content-Typeapplication/json
Schema
schemaobject
responsestringErforderlich
Fehlercode. Die Codes, die jede Methode liefern kann, stehen in der Einleitung; jede Methode führt ihre eigenen auf. Die Liste ist nicht geschlossen: behandeln Sie einen unbekannten Code als allgemeinen Fehler und protokollieren Sie ihn.

Beispiele

Invalid key

Ungültiger API-Schlüssel oder abgelaufenes Token

{
  "response": "ERROR_WRONG_KEY"
}

Codebeispiele

Beispiele werden generiert...