Daten und Status mehrerer Nummern abrufen
GEThttps://{ourserver.com}/api/resellers/checkNumbers
Wie checkNumber, aber für mehrere Nummern. Die Antwort hat eine von zwei Formen:
- ohne
numbers— alle Ihre Nummern (einschließlich über Ausrüstung angeschlossener): ein Objekt mit Telefonnummern als Schlüsseln, plus"response": "1"; - mit
numbers— ein Objekt mit einem Schlüssel je angefragter Nummer (als Ziffern): die Daten der Nummer mit"response": "1"oder{"response": "0"}, wenn Sie keine solche Nummer haben. Es gibt keinresponseauf oberster Ebene. Mitwith_historyenthalten die Verlaufseinträge hier alle Felder des Vorgangs, einschließlich der empfangenen SMS (messages).
Die Anfrage bestätigt außerdem, dass Ihr Server läuft.
Parameter
query4
| Name | Typ | Beschreibung |
|---|---|---|
numbers[] | string[] | Zu prüfende Nummern mit Ländervorwahl (ein optionales führendes |
with_history | boolean | Fügt Ihre abgeschlossenen Vorgänge auf jeder Nummer zu |
as_text | boolean | Gibt |
test | string | Testmodus. Er kann auch im Anfragetext übergeben werden.
Eine Anfrage mit einem beliebigen nicht leeren Enumeration: test1test2 |
header1
| Name | Typ | Beschreibung |
|---|---|---|
Authorization* | string | Siehe Details hier |
Antworten
200Die Daten der Nummern, mit Telefonnummern als Schlüsseln
application/jsonschemaobject
numbersEnumeration:1Beispiel:1[additionalProperties]oneOf
Beispiele
allNumbersZeilen: 25
Ohne numbers: alle Ihre Nummern
{
"4605091080": {
"id": 110251,
"balance": 0,
"country_id": 46,
"errors": 0,
"number": "4605091080",
"port_id": "Port1",
"equipment_id": "2130706433",
"sum": 26,
"used_service": {
"telegram": "tg"
},
"banned_service": {},
"history": [],
"banned": false,
"reseller_id": 12345,
"rent": "no",
"status": 1,
"status_text": "work",
"clearable": true,
"created_at": "2024-06-11T14:33:26.000000Z"
},
"response": "1"
}requestedNumbersZeilen: 29
Mit numbers: eine Nummer gefunden, eine nicht
{
"15555555555": {
"id": 110252,
"balance": 0,
"country_id": 1,
"errors": 4,
"number": "15555555555",
"port_id": "Port2",
"equipment_id": "2130706433",
"sum": 0,
"used_service": {},
"banned_service": {
"whatsapp": "wa",
"telegram": "tg"
},
"history": [],
"banned": true,
"reseller_id": 12345,
"rent": null,
"status": 1,
"status_text": "work",
"clearable": false,
"created_at": "2024-06-01T09:00:00.000000Z",
"response": "1"
},
"15555555556": {
"response": "0"
}
}401Kein API-Schlüssel, oder der Schlüssel existiert nicht. Der Body ist der reine Text Unauthorized.
Eine Anfrage mit Accept: application/json erhält stattdessen HTTP 200 mit {"response":"ERROR_WRONG_KEY"}.
text/htmlUnauthorized.Beispiel:Unauthorized.403Verboten: Der API-Schlüssel ist gültig, aber die Anfrage wird abgelehnt. Fehlercodes:
ERROR_DISABLED — das Partnerkonto ist nicht aktiviert;
ERROR_BANNED — das Partnerkonto ist gesperrt;
ERROR_IP — die Anfrage kommt von einer IP-Adresse, die nicht auf der Positivliste des Kontos steht;
ERROR_RENT — rent wird angefordert, aber das Konto hat keinen Mietzugang (nur addNumber).
ERROR_DISABLED — das Partnerkonto ist nicht aktiviert;ERROR_BANNED — das Partnerkonto ist gesperrt;ERROR_IP — die Anfrage kommt von einer IP-Adresse, die nicht auf der Positivliste des Kontos steht;ERROR_RENT — rent wird angefordert, aber das Konto hat keinen Mietzugang (nur addNumber).application/jsonschemaobject
ERROR_DISABLEDERROR_BANNEDERROR_IPERROR_RENTBeispiele
Anfrage von einer IP-Adresse außerhalb der Positivliste
{
"response": "ERROR_IP",
"message": "ERROR_IP"
}