Erhalten Sie eine Liste mit Ihren Wünschen

POST https://emailverification.whoisxmlapi.com/api/bevService/request/list

Beispiel einer CURL-Anfrage

curl https://emailverification.whoisxmlapi.com/api/bevService/request/list -X POST -H "Content-Type: application/json"  -d '{"apiKey": "YOUR_API_KEY", "page": 1, "onlyIds": false, "perPage": 10, "sort": "desc", "format": "json"}'

Beispiel für einen POST-Anfragetext

{
    "apiKey": "YOUR_API_KEY",
    "page": 1,
    "format": "json",
    "onlyIds": false,
    "perPage": 10,
    "sort": "desc"
}

Eingabe-Parameter

apiKey

Erforderlich. Sie erhalten Ihren persönlichen API-Schlüssel auf der Seite Meine Produkte.

Seite

Optional. Ganze Zahl.

Wird zum Paginieren der Ergebnismengen in Verbindung mit 'perPage' verwendet.

Standardwert: 1.

onlyIds

Optional. Boolescher Wert.

Wenn der Wert „true“ ist, wird nur die Liste der IDs zurückgegeben.

Standardwert: true.

proSeite

Optional. Ganze Zahl.

Begrenzt jede Seite der Ergebnismenge auf diese Anzahl von Anfragen.

Min: 10; Max: 50.

Standardwert: 10

sortieren

Optional. Zeichenfolge.

Legen Sie die Reihenfolge der Anfragen in der Antwort fest.

Erlaubte Werte: "asc", "desc".

Standardwert: "desc".

Format

Optional. Zeichenfolge.

Wird verwendet, um das Antwortformat anzugeben.

Erlaubte Werte: "xml", "json", "csv".

Standardwert: "json".

Beispielhafte Ausgabe

{
    "response": {
        "current_page": 1,
        "data": [
            {
                "id": 596
            },
            {
                "id": 595
            },
            {
                "id": 544
            }
        ],
        "from": 1,
        "last_page": 1,
        "per_page": 10,
        "to": 3,
        "total": 3
    }
}

Code: 200 OK.
{
    "response": {
        "current_page": 1,
        "data": [
            {
                "id": 596,
                "api_version": 3,
                "date_start": "1528377253",
                "total_emails": 3,
                "invalid_emails": 0,
                "processed_emails": 3,
                "failed_emails": 0,
                "ready": 1
            },
            {
                "id": 595,
                "api_version": 3,
                "date_start": "1528377227",
                "total_emails": 20,
                "invalid_emails": 0,
                "processed_emails": 20,
                "failed_emails": 0,
                "ready": 1
            },
            {
                "id": 544,
                "api_version": 2,
                "date_start": "1528204702",
                "total_emails": 500,
                "invalid_emails": 0,
                "processed_emails": 500,
                "failed_emails": 0,
                "ready": 1
            }
        ],
        "from": 1,
        "last_page": 1,
        "per_page": 10,
        "to": 3,
        "total": 3
    }
}

Code: 200 OK.

Eingabe-Parameter

Antwort

Das Antwortobjekt.

Enthält das Feld 'Daten' mit einem Array der Daten der Benutzeranfragen bei Erfolg.

Die Felder 'von' und 'bis' stellen den ID-Bereich der Ergebnismenge der für die aktuelle Seite zurückgegebenen Anfragen dar.

'per_page' ist die Größe der Seiten und 'total' ist die Anzahl der Anfragen in der Ergebnismenge.

Die Angaben 'current_page' und 'last_page' entsprechen der Anzahl der Seiten in der Ergebnismenge.

Im Falle eines Fehlers enthält es dessen Beschreibung im Feld 'Fehler'. Wenn es mehrere Fehler gibt, werden deren Beschreibungen im Array 'Fehler' zurückgegeben.

Daten

Array.

Eine Liste der Info-Elemente Ihrer Anfragen (wenn 'onlyIds' true ist, hat jedes Element nur das Feld 'id' ).

data[k].id

String.

Anfrage-ID.

data[k].api_version

Ganzzahlig.

Für die Anfrage verwendete API-Version.

data[k].date_start

String.

String-Darstellung des Unix-Zeitstempels für den Beginn der Anfrage.

data[k].total_emails

Ganzzahlig.

Die Gesamtzahl der E-Mails in der Anfrage.

data[k].ungültige_E-Mails

Ganzzahlig.

Anzahl der ungültigen Emails.

data[k].verarbeitete_emails

Ganzzahlig.

Anzahl der bereits verarbeiteten E-Mail-Adressen.

data[k].failed_emails

Ganzzahlig.

Anzahl der E-Mails, die nicht verarbeitet werden konnten.

data[k].ready

Ganzzahlig.

1, wenn die Verarbeitung abgeschlossen ist, sonst 0.

von

Ganzzahlig.

Min. Anfrage-ID auf der aktuellen Seite des Datensatzes.

zu

Ganzzahlig.

Maximale Anfrage-ID auf der aktuellen Seite des Datensatzes.

pro_seite

Ganzzahlig.

Maximale Anzahl von Anfragen für jede Seite der Ergebnismenge.

gesamt

Ganzzahlig.

Die Gesamtzahl der Anfragen in der Ergebnismenge.

aktuelle_seite

Ganzzahlig.

Aktuelle Seitenzahl in der Ergebnismenge.

letzte_seite

Ganzzahlig.

Die Nummer der letzten Seite des Satzes.

Fehler

String.

Fehlerbeschreibung.

Fehler

Array.

Mehrere Fehlermeldungen.