v1Ressourcen/Connections/getStatus eines Verbindungslinks abrufen

Status eines Verbindungslinks abrufen

Gibt zurück, wo ein Verbindungslink steht. Ein Link gilt als abgeschlossen, wenn der Kunde eine funktionierende Verbindung auf Markenebene für dieses Netzwerk hat, die nach dem Öffnen des Links gespeichert wurde.

get/api/v1/connections/connect-links/{id}
connections:read
Query-Parameter
idstringerforderlich
Die ID des Verbindungslinks aus der Antwort beim Erstellen.
Antwort
dataobjectoptional
idstringoptional
Die ID des Links. Damit prüfen Sie den Status oder stornieren den Link.
platformstringoptional
Das Netzwerk, das der Link verbindet.
clientIdstringoptional
Der Kunde, für den der Link gilt.
statusstring (pending | started | completed | abandoned | cancelled | expired)optional
Wo der Link steht: pending (noch nicht geöffnet), started (geöffnet, die Person hat noch nicht abgeschlossen), completed (das Konto ist verbunden), abandoned (geöffnet, aber nicht innerhalb einer Stunde abgeschlossen), cancelled oder expired (vor expiresAt nicht geöffnet).
expiresAtstringoptional
Wann der Link ungültig wird, wenn ihn niemand geöffnet hat.
startedAtstringoptional
Wann der Link geöffnet wurde, oder null, wenn noch nicht.
connectionIdstringoptional
Die Verbindung, die der Link erzeugt hat, sobald er abgeschlossen ist. Bis dahin null.
reconnectConnectionIdstringoptional
Die neu zu verbindende Verbindung, wenn der Link dafür erstellt wurde. Nur die Antwort beim Erstellen enthält sie; Statusabfragen liefern null.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/connections/connect-links/{id}
Ihr API-Schlüssel
id *
{}

Anleitungen, die diese Ressource verwenden