Zum Inhalt springen
Hilfe-Center
Support kontaktierenApp öffnen

Empfänger einer Kampagne auflisten

GET
/v1/campaigns/{id}/recipients
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.

id
required
string format: uuid

ID der Kampagne.

status
string
Allowed values: pending queued done skipped

Nur Empfänger in diesem Status.

limit
integer
>= 1 <= 100

Empfänger je Seite, 1 bis 100, Standard 25.

cursor
string
>= 1 characters <= 200 characters

next_cursor der vorigen Seite.

Eine Seite Empfänger.

Media typeapplication/json

Eine Seite Empfänger in Listenreihenfolge.

object
data
required

Die Einträge dieser Seite.

Array<object>

Ein Empfänger einer Kampagne.

object
position
required

Platz in der Liste, ab 1.

integer
to
required

Zielnummer in E.164.

string
variables
required

Werte für die Platzhalter des Assistenten.

object
key
additional properties
string
status
required

pending noch nicht angerufen, queued Anruf angelegt, done Anruf beendet, skipped nie angerufen.

string
Allowed values: pending queued done skipped
skip_reason
required
Any of:
string
Allowed values: plan_required access_not_approved billing_blocked assistant_not_found assistant_outbound_disabled from_number_missing from_number_not_allowed invalid_number country_not_allowed special_number own_number suppressed contact_blocked outside_call_hours daily_limit_reached number_called_today missing_variables
last_result
required
Any of:
string
Allowed values: answered no_answer busy voicemail failed
attempt_count
required

Bisherige Wählversuche für diesen Empfänger.

integer
call_id
required
Any of:
string format: uuid
next_cursor
required

Für die nächste Seite als cursor senden. null = keine weitere Seite.

string | null

Example

{
"data": [
{
"status": "pending",
"skip_reason": "plan_required",
"last_result": "answered"
}
]
}

Ungültige Anfrage.

Media typeapplication/json

Einheitliches Fehlerformat aller Antworten unter /v1.

object
error
required

Der Fehler.

object
code
required

Fester Code für Programme. Neue Codes können dazukommen, bestehende ändern sich nicht.

string
Allowed values: unauthorized insufficient_scope invalid_request not_found conflict rate_limited internal_error plan_required access_not_approved billing_blocked assistant_not_found assistant_outbound_disabled from_number_missing from_number_not_allowed invalid_number country_not_allowed special_number own_number suppressed contact_blocked outside_call_hours daily_limit_reached number_called_today missing_variables
message
required

Meldung für Menschen, auf Deutsch.

string
details

Zusatz je Code, z. B. fields bei invalid_request oder missing_variables bei missing_variables.

object
key
additional properties

Examples

Exampleinvalid_request
{
"error": {
"code": "invalid_request",
"message": "Die Anfrage ist ungültig."
}
}

API-Schlüssel fehlt oder ist ungültig.

Media typeapplication/json

Einheitliches Fehlerformat aller Antworten unter /v1.

object
error
required

Der Fehler.

object
code
required

Fester Code für Programme. Neue Codes können dazukommen, bestehende ändern sich nicht.

string
Allowed values: unauthorized insufficient_scope invalid_request not_found conflict rate_limited internal_error plan_required access_not_approved billing_blocked assistant_not_found assistant_outbound_disabled from_number_missing from_number_not_allowed invalid_number country_not_allowed special_number own_number suppressed contact_blocked outside_call_hours daily_limit_reached number_called_today missing_variables
message
required

Meldung für Menschen, auf Deutsch.

string
details

Zusatz je Code, z. B. fields bei invalid_request oder missing_variables bei missing_variables.

object
key
additional properties

Examples

Exampleunauthorized
{
"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.

Media typeapplication/json

Einheitliches Fehlerformat aller Antworten unter /v1.

object
error
required

Der Fehler.

object
code
required

Fester Code für Programme. Neue Codes können dazukommen, bestehende ändern sich nicht.

string
Allowed values: unauthorized insufficient_scope invalid_request not_found conflict rate_limited internal_error plan_required access_not_approved billing_blocked assistant_not_found assistant_outbound_disabled from_number_missing from_number_not_allowed invalid_number country_not_allowed special_number own_number suppressed contact_blocked outside_call_hours daily_limit_reached number_called_today missing_variables
message
required

Meldung für Menschen, auf Deutsch.

string
details

Zusatz je Code, z. B. fields bei invalid_request oder missing_variables bei missing_variables.

object
key
additional properties

Examples

{
"error": {
"code": "insufficient_scope",
"message": "Diesem API-Schlüssel fehlt die Berechtigung für diese Anfrage."
}
}

Nicht gefunden.

Media typeapplication/json

Einheitliches Fehlerformat aller Antworten unter /v1.

object
error
required

Der Fehler.

object
code
required

Fester Code für Programme. Neue Codes können dazukommen, bestehende ändern sich nicht.

string
Allowed values: unauthorized insufficient_scope invalid_request not_found conflict rate_limited internal_error plan_required access_not_approved billing_blocked assistant_not_found assistant_outbound_disabled from_number_missing from_number_not_allowed invalid_number country_not_allowed special_number own_number suppressed contact_blocked outside_call_hours daily_limit_reached number_called_today missing_variables
message
required

Meldung für Menschen, auf Deutsch.

string
details

Zusatz je Code, z. B. fields bei invalid_request oder missing_variables bei missing_variables.

object
key
additional properties

Examples

Examplenot_found
{
"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.

Media typeapplication/json

Einheitliches Fehlerformat aller Antworten unter /v1.

object
error
required

Der Fehler.

object
code
required

Fester Code für Programme. Neue Codes können dazukommen, bestehende ändern sich nicht.

string
Allowed values: unauthorized insufficient_scope invalid_request not_found conflict rate_limited internal_error plan_required access_not_approved billing_blocked assistant_not_found assistant_outbound_disabled from_number_missing from_number_not_allowed invalid_number country_not_allowed special_number own_number suppressed contact_blocked outside_call_hours daily_limit_reached number_called_today missing_variables
message
required

Meldung für Menschen, auf Deutsch.

string
details

Zusatz je Code, z. B. fields bei invalid_request oder missing_variables bei missing_variables.

object
key
additional properties

Examples

Examplerate_limited
{
"error": {
"code": "rate_limited",
"message": "Zu viele Anfragen. Bitte versuchen Sie es gleich noch einmal."
}
}

Interner Fehler.

Media typeapplication/json

Einheitliches Fehlerformat aller Antworten unter /v1.

object
error
required

Der Fehler.

object
code
required

Fester Code für Programme. Neue Codes können dazukommen, bestehende ändern sich nicht.

string
Allowed values: unauthorized insufficient_scope invalid_request not_found conflict rate_limited internal_error plan_required access_not_approved billing_blocked assistant_not_found assistant_outbound_disabled from_number_missing from_number_not_allowed invalid_number country_not_allowed special_number own_number suppressed contact_blocked outside_call_hours daily_limit_reached number_called_today missing_variables
message
required

Meldung für Menschen, auf Deutsch.

string
details

Zusatz je Code, z. B. fields bei invalid_request oder missing_variables bei missing_variables.

object
key
additional properties

Examples

Exampleinternal_error
{
"error": {
"code": "internal_error",
"message": "Interner Fehler. Bitte versuchen Sie es später noch einmal."
}
}