Empfänger einer Kampagne auflisten
const url = 'https://api.speakki.de/v1/campaigns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/recipients?status=pending';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://api.speakki.de/v1/campaigns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/recipients?status=pending' \ --header 'Authorization: Bearer <token>'Empfänger in Listenreihenfolge mit Stand, Ergebnis und dem zugehörigen Anruf.
Berechtigung: campaigns:read.
Authorizations
Abschnitt betitelt „Authorizations“Parameters
Abschnitt betitelt „Parameters“Path Parameters
Abschnitt betitelt „Path Parameters“ID der Kampagne.
Query Parameters
Abschnitt betitelt „Query Parameters“Nur Empfänger in diesem Status.
Empfänger je Seite, 1 bis 100, Standard 25.
next_cursor der vorigen Seite.
Responses
Abschnitt betitelt „Responses“Eine Seite Empfänger.
Eine Seite Empfänger in Listenreihenfolge.
object
Die Einträge dieser Seite.
Ein Empfänger einer Kampagne.
object
Platz in der Liste, ab 1.
Zielnummer in E.164.
Werte für die Platzhalter des Assistenten.
object
pending noch nicht angerufen, queued Anruf angelegt, done Anruf beendet, skipped nie angerufen.
Bisherige Wählversuche für diesen Empfänger.
Für die nächste Seite als cursor senden. null = keine weitere Seite.
Example
{ "data": [ { "status": "pending", "skip_reason": "plan_required", "last_result": "answered" } ]}Ungültige Anfrage.
Einheitliches Fehlerformat aller Antworten unter /v1.
object
Der Fehler.
object
Fester Code für Programme. Neue Codes können dazukommen, bestehende ändern sich nicht.
Meldung für Menschen, auf Deutsch.
Zusatz je Code, z. B. fields bei invalid_request oder missing_variables bei missing_variables.
object
Examples
{ "error": { "code": "invalid_request", "message": "Die Anfrage ist ungültig." }}API-Schlüssel fehlt oder ist ungültig.
Einheitliches Fehlerformat aller Antworten unter /v1.
object
Der Fehler.
object
Fester Code für Programme. Neue Codes können dazukommen, bestehende ändern sich nicht.
Meldung für Menschen, auf Deutsch.
Zusatz je Code, z. B. fields bei invalid_request oder missing_variables bei missing_variables.
object
Examples
{ "error": { "code": "unauthorized", "message": "Der API-Schlüssel fehlt oder ist ungültig. Senden Sie ihn als „Authorization: Bearer spk_live_…“." }}Nicht erlaubt: Tarif, Freischaltung oder Berechtigung des Schlüssels.
Einheitliches Fehlerformat aller Antworten unter /v1.
object
Der Fehler.
object
Fester Code für Programme. Neue Codes können dazukommen, bestehende ändern sich nicht.
Meldung für Menschen, auf Deutsch.
Zusatz je Code, z. B. fields bei invalid_request oder missing_variables bei missing_variables.
object
Examples
{ "error": { "code": "insufficient_scope", "message": "Diesem API-Schlüssel fehlt die Berechtigung für diese Anfrage." }}{ "error": { "code": "plan_required", "message": "Ausgehende Anrufe sind ab dem Tarif Professional enthalten." }}Nicht gefunden.
Einheitliches Fehlerformat aller Antworten unter /v1.
object
Der Fehler.
object
Fester Code für Programme. Neue Codes können dazukommen, bestehende ändern sich nicht.
Meldung für Menschen, auf Deutsch.
Zusatz je Code, z. B. fields bei invalid_request oder missing_variables bei missing_variables.
object
Examples
{ "error": { "code": "not_found", "message": "Nicht gefunden." }}Zu viele Anfragen. retry-after und x-ratelimit-reset nennen die Sekunden, bis wieder Anfragen möglich sind.
Einheitliches Fehlerformat aller Antworten unter /v1.
object
Der Fehler.
object
Fester Code für Programme. Neue Codes können dazukommen, bestehende ändern sich nicht.
Meldung für Menschen, auf Deutsch.
Zusatz je Code, z. B. fields bei invalid_request oder missing_variables bei missing_variables.
object
Examples
{ "error": { "code": "rate_limited", "message": "Zu viele Anfragen. Bitte versuchen Sie es gleich noch einmal." }}Interner Fehler.
Einheitliches Fehlerformat aller Antworten unter /v1.
object
Der Fehler.
object
Fester Code für Programme. Neue Codes können dazukommen, bestehende ändern sich nicht.
Meldung für Menschen, auf Deutsch.
Zusatz je Code, z. B. fields bei invalid_request oder missing_variables bei missing_variables.
object
Examples
{ "error": { "code": "internal_error", "message": "Interner Fehler. Bitte versuchen Sie es später noch einmal." }}