Textanforderung

Text Request ist eine Geschäftstextingplattform, die entwickelt wurde, um die Kundenbindung zu entzünden. Wir haben eine Plug-and-Play-Messaging-Lösung für Ihre täglichen Kommunikationsprobleme erstellt, sodass Sie das Geräusch durchschneiden und jederzeit und überall mit Kunden in Verbindung treten können. Erfahren Sie mehr darüber, wie wir beschäftigten Führungskräften wie Ihnen helfen.

Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:

Dienstleistung	Class	Regions
Copilot Studio	Premium	Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:      - US Government (GCC)      - US Government (GCC High)      - China Cloud betrieben von 21Vianet      - US Department of Defense (DoD)
Logik-Apps	Norm	Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche:      – Azure Government-Regionen      - Azure China-Regionen      - US Department of Defense (DoD)
Power Apps	Premium	Alle Power Apps-Regionen mit Ausnahme der folgenden:      - US Government (GCC)      - US Government (GCC High)      - China Cloud betrieben von 21Vianet      - US Department of Defense (DoD)
Power Automate	Premium	Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:      - US Government (GCC)      - US Government (GCC High)      - China Cloud betrieben von 21Vianet      - US Department of Defense (DoD)

Kontakt
Name	Unterstützung der Textanforderungs-API
URL	https://www.textrequest.com/contact
Email	apidev@textrequest.com

Connectormetadaten
Herausgeber	Textanforderung
Webseite	https://www.textrequest.com/
Datenschutzrichtlinie	https://www.textrequest.com/privacy-policy/
Kategorien	Kommunikation; Vertrieb und CRM

Aranda Service Management Suite (ASMS)

Steigern Sie die Produktivität Ihres Unternehmens und transformieren Sie die Benutzerfreundlichkeit mit Aranda Service Management Suite, der mehrinstanzenfähigen Lösung, mit der Sie Geschäftsprozesse und -dienste verwalten, integrieren und automatisieren können. Erstellen, Suchen und Aktualisieren von Datensätzen, die in einem beliebigen Arbeitsbereich (Projekt) von ASMS gespeichert sind, einschließlich Vorfällen, Anforderungen und Änderungen, unter anderem.

Voraussetzungen

Bitte beachten Sie die folgenden Voraussetzungen, um fortzufahren:

• Ein Abonnement und eine Instanz von Aranda Service Management Suite (ASMS). Beginnen Sie hier: https://arandasoft.com/
• Ein aktives Microsoft Power Automate-Abonnement mit Premium-Connectorfunktionen.

Abrufen von Anmeldeinformationen

• Verwenden Sie zum Durchführen der Authentifizierung das Integrationstoken. Im folgenden Link finden Sie Informationen zum Abrufen des Integrationstokens.

Erste Schritte mit Ihrem Connector

1. Erfordert ein Abonnement von Aranda Service Management Suite (ASMS).

2. Abrufen des Integrationstokens

3. Rufen Sie die Instanz-URL der Aranda Service Management ASMS-API (ApiAsms) ab.

4. Herstellen einer Verbindung mit dem Aranda Service Management Suite-Connector.

5. Wählen Sie eine der folgenden Funktionen aus, die vom Connector angeboten werden:

6. Ausführliche Dokumentation zum Connector finden Sie unter https://docs.arandasoft.com/connectors

Sie können diesen Connector in den folgenden Fällen verwenden:

1. Erstellen, Suchen und Aktualisieren von Tickets unter anderem verfügbaren Aktionen.
2. Erhalten Sie die Ticketablaufverfolgung.
3. Laden Sie Anlagen im Zusammenhang mit einem Ticket herunter.
4. Suchen Sie nach Knowledge Base-Artikeln (KB) in Aranda Service Management Suite.
5. Laden Sie Anlagen aus Knowledge Base-Artikeln (KB) herunter.
6. Erstellen, Suchen und Aktualisieren von Konfigurationselementen (CIs).
7. Es ermöglicht Organisationen, ihre internen Supportanfragen zu lösen, den technischen Problemlösungsprozess zu verwalten und zu optimieren.
8. Ermöglicht die Nachverfolgung der Kommunikation zwischen Anforderern und Supportmitarbeitern.
9. Bieten Sie automatisierte Antworten auf Informierer über den Status ihres Tickets.

Erfolgreiche Antwort

Code	Name	Description
200	OKAY	Die Anforderung war erfolgreich.
204	Kein Inhalt	In der Anforderung wurden keine Daten gefunden.

Häufige Fehler und Abhilfemaßnahmen

Code	Name	Description	Lösung
400	Fehlerhafte Anfrage	CriteriaNeedsSomeArguments	Überprüfen Sie, ob die Suchparameter nicht leer sind.
400	Fehlerhafte Anfrage	InvalidAdditionalFieldId	Überprüfen Sie, ob die IDs der zusätzlichen Felder korrekt sind.
400	Fehlerhafte Anfrage	InvalidItemType	Der Falltyp ist falsch, ändern Sie die Falltyp-ID.
400	Fehlerhafte Anfrage	InvalidProjectId	Die Projekt-ID ist falsch, ändern Sie die Projekt-ID, der Sie den Fall zuordnen möchten.
400	Fehlerhafte Anfrage	InvalidStateId	Überprüfen des hinzugefügten Status beim Erstellen oder Aktualisieren eines Tickets
400	Fehlerhafte Anfrage	InvalidUploadType	Fehler beim Anfügen einer Datei, Anfordern von Unterstützung durch einen Systemadministrator
400	Fehlerhafte Anfrage	RequestNeedsSomeArguments	Überprüfen Sie die erforderlichen Felder des Tickets, und fügen Sie den entsprechenden Wert dieser im Connector hinzu.
400	Fehlerhafte Anfrage	SearchListIsRequired	Anfordern von Unterstützung durch einen Systemadministrator
400	Fehlerhafte Anfrage	Parametername: {Name parameter}	Überprüfen Sie, ob die im Fehler erwähnten Eigenschaften nicht null sind.
400	Fehlerhafte Anfrage	Ist null-Parametername: {Name parameter}	Überprüfen Sie, ob die im Fehler erwähnten Eigenschaften nicht null sind.
400	Fehlerhafte Anfrage	ItemTypeIsRequired	Falltyp hinzufügen
400	Fehlerhafte Anfrage	ModelIdIsEmpty	Fügen Sie den parameter "modelId" hinzu. Es ist erforderlich.
400	Fehlerhafte Anfrage	StateIdIsEmpty	Fügen Sie den parameter stateId hinzu. Es ist erforderlich.
400	Fehlerhafte Anfrage	ServiceIdIsEmpty	Fügen Sie den Parameter "serviceId" hinzu. Es ist erforderlich.
400	Fehlerhafte Anfrage	CategoryIdIsEmpty	Fügen Sie den categoryId-Parameter hinzu. Es ist erforderlich.
400	Fehlerhafte Anfrage	TypesListNeedsSomeArguments	Erfordert das Hinzufügen des Falltyps bei der Suche nach Tickets, Anfordern von Unterstützung von einem Systemadministrator
400	Fehlerhafte Anfrage	'{PARAMETER_NAME}' AdditionalFieldIsRequired	Das zusätzliche Feld "{PARAMETER_NAME}" ist obligatorisch.
400	Fehlerhafte Anfrage	ModelNotActive	Das dem Fall zugeordnete Modell ist nicht aktiv.
400	Fehlerhafte Anfrage	FailedToCloseTaskPendingCloseTasksPredecessors	Wenn Sie versuchen, den Fall zu schließen, und der übergeordnete Fall über ausstehende Aufgaben zum Schließen verfügt
400	Fehlerhafte Anfrage	DuplicatedObject	Der Ci ist bereits in der Datenbank vorhanden.
400	Fehlerhafte Anfrage	EmptyValue-Parametername: {PARAMETER_NAME}	Der Parameter "{PARAMETER_NAME}" ist erforderlich.
400	Fehlerhafte Anfrage	Name des EmptyEnumeration-Parameters: {PARAMETER_NAME}	Der Parameter "{PARAMETER_NAME}" ist eine Liste und ist erforderlich.
403	Verboten	DoNotHavePermissionForThisAction	Wenden Sie sich an Ihren Systemadministrator, um Berechtigungen zuzuweisen.

Code	Name	Description	Lösung
500	Interner Serverfehler		Anfordern von Unterstützung durch einen Systemadministrator
500	Interner Serverfehler	FailureExportExcel	Anfordern von Unterstützung durch einen Systemadministrator
500	Interner Serverfehler	FailureGetAdditionalFields	Anfordern von Unterstützung durch einen Systemadministrator
500	Interner Serverfehler	FailureGetCategoriesByService	Anfordern von Unterstützung durch einen Systemadministrator
500	Interner Serverfehler	FailureGetChangeFSC	Anfordern von Unterstützung durch einen Systemadministrator
500	Interner Serverfehler	FailureGetFields	Anfordern von Unterstützung durch einen Systemadministrator
500	Interner Serverfehler	FailureGetFieldsList	Anfordern von Unterstützung durch einen Systemadministrator
500	Interner Serverfehler	FailureGetFiles	Anfordern von Unterstützung durch einen Systemadministrator
500	Interner Serverfehler	FailureGetLookupValues	Anfordern von Unterstützung durch einen Systemadministrator
500	Interner Serverfehler	FailureGetMailTemplates	Anfordern von Unterstützung durch einen Systemadministrator
500	Interner Serverfehler	FailureGetModelByCategory	Anfordern von Unterstützung durch einen Systemadministrator
500	Interner Serverfehler	FailureGetOperators	Anfordern von Unterstützung durch einen Systemadministrator
500	Interner Serverfehler	FailureGetReassignmentReasReasons	Anfordern von Unterstützung durch einen Systemadministrator
500	Interner Serverfehler	FailureGetSimilarItems	Anfordern von Unterstützung durch einen Systemadministrator
500	Interner Serverfehler	FailureSearchQuickManagement	Anfordern von Unterstützung durch einen Systemadministrator

Häufig gestellte Fragen

1. Wie rufen Sie die IDs der Attribute ab, die für die Verwendung der verschiedenen Aktionen im Connector erforderlich sind (z. B. Projekt, Dienst, Kategorie, Gruppe, Spezialist)?

   Die IDs können auf viele Arten abgerufen werden:

   • Mit Aranda Query Manager können Sie einen Bericht erstellen, der die Tabelle Aranda Service Management Suite (ASMS) abfragt, in der sich die erforderlichen Daten befinden. Wenn Sie Anleitungen zu den Datenobjekten in der Lösung benötigen, besuchen Sie den folgenden Link https://docs.arandasoft.com/docs/database.html , und identifizieren Sie die Aranda-Datenbankversion, die Ihrer ASMS-Installation entspricht.
   • Wenn Sie eine LOKALE ASMS-Installation verwenden, können Sie die ASMS-Tabelle abfragen, in der sich die erforderlichen Daten über einen SQL-Client befinden.
   • Über aranda Support Center erstellen Sie eine Supportanfrage über die kontaktkanäle, die auf der folgenden Website Support angegeben sind.

2. Wie groß ist die maximale Größe von Dateien, die angefügt werden sollen, wenn sie die Aktion "Anlage hinzufügen" verwenden?

   Die maximale Größe hängt von der spezifischen Konfiguration Ihrer ASMS-Instanz/-installation ab. Bitten Sie Ihren ASMS-Administrator.

3. Was ist die Datenzugriffsebene, die vom Technikerkonto benötigt wird, deren Token in der Konfiguration der asMS-Verbindung verwendet wird, die vom Connector benötigt wird?

   Die Zugriffsebene entspricht dem Technikerkonto, das in ASMS regelmäßig verwendet wird. Anders ausgedrückt: Basierend auf den Rollen und Berechtigungen des entsprechenden Technikers in ASMS können die Daten mit dem Connector aufgerufen werden.

4. Sollte das Technikerkonto, dessen Token im Connector verwendet wird, benannt oder gleichzeitig sein?

   Da der Connector mehrmals pro Stunde auf die zugehörige ASMS-Instanz zugreifen kann, wird dringend empfohlen, dass das Konto ein benannter Typ ist.

5. Entspricht die Erstellung oder Änderung von Fällen, die den Connector verwenden, den gleichen Datenüberprüfungsregeln, die in der ASMS-Schnittstelle vorhanden sind?

   Ja, es folgt den gleichen Gültigkeitsprüfungsregeln. Wenn beispielsweise ein Fall für ein bestimmtes Projekt, einen Dienst und eine Kategorie erstellt wird, wenn systemeigene und zusätzliche Felder ausgefüllt werden müssen, sind diese Daten auch erforderlich, wenn der Fall über den Connector übermittelt wird.

6. Kann der Connector für ASMS-Instanzen in Cloud- und lokalen Umgebungen verwendet werden?

   Ja, es kann sowohl in Cloud- als auch in lokalen Installationen von ASMS verwendet werden. In lokalen Installationen müssen Sie die Konnektivität zwischen dem ASMS-Server und Ihrer Power Automate-Umgebung berücksichtigen.

7. Ich habe eine Power Automate-Lizenz, mit der ich nur Standardconnectors verwenden kann. Kann ich den ASMS-Connector verwenden?

   Es ist nicht möglich, der ASMS-Verbinder ist Premium-Typ.

8. Ich möchte Flüsse in Power Automate erstellen, die von Ereignissen in ASMS beginnen (z. B. wenn ein Fall erstellt wurde, wenn ein Fall einer bestimmten Gruppe zugewiesen ist). Ist es möglich, Trigger zu verwenden, die von Ereignissen beginnen, die in ASMS auftreten?

   Ja, es ist möglich. Die folgenden Schritte werden empfohlen:

   • Initialisieren Sie einen Trigger "Wenn eine HTTP-Anforderung empfangen wird" und erstellen Sie ein Anforderungstext-JSON-Schema, das die datenstruktur enthält, die von ASMS empfangen werden soll. Nachdem der Trigger erstellt wurde, erhalten Sie eine HTTP POST-URL (WebHook-URL), die in Ihrer ASMS-Instanz verwendet werden soll. Vergessen Sie nicht, den Authentifizierungsmechanismus für den Zugriff auf die WebHook-URL (z. B. Token) zu berücksichtigen.
   • Erstellen Sie eine Geschäftsregel in ASMS für die Gruppe von Bedingungen, die bei Erfüllung den Fluss in Power Automate initiieren sollten. Wählen Sie als Aktion innerhalb der Regel "Webhook aufrufen" aus, und geben Sie in der Aufrufziel-URL die zuvor abgerufene WebHook-URL, die zu sendenden Parameter und den Text der Anforderung ein (die dem Anforderungstext-JSON-Schema entsprechen müssen). Weitere Informationen zum Aufrufen eines Webhooks aus einer Regel in ASMS finden Sie unter dem folgenden Link: Webhook-Regel
   • Testen Sie die erstellte Regel, und überprüfen Sie, ob eine HTTP-Anforderung an die WebHook-URL gesendet wird, und initialisiert den Fluss in Power Automate.

9. Kann ich ASMS-REST-API-Endpunkte als Aktionen aus Flüssen in Power Automate aufrufen?

   Ja, es ist möglich. Verwenden Sie die "HTTP"-Aktion, und füllen Sie die erforderlichen Daten darin aus (URI, Methode, Headers, Body usw.).

Erstellen einer Verbindung

Der Connector unterstützt die folgenden Authentifizierungstypen:

Vorgabe	Parameter zum Erstellen einer Verbindung.	Alle Regionen	Nicht teilbar

Vorgabe

Anwendbar: Alle Regionen

Parameter zum Erstellen einer Verbindung.

Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.

Name	Typ	Description	Erforderlich
API-Schlüssel	securestring	Der API-Schlüssel für diese API	Richtig

Drosselungsgrenzwerte

Name	Aufrufe	Verlängerungszeitraum
API-Aufrufe pro Verbindung	100	60 Sekunden

Aktionen

Abrufen aller Dashboards in einem Konto	Ruft alle Dashboards in einem Konto ab.
Abrufen aller Kontakte, die dem angegebenen Filterkriterium entsprechen	Ruft alle Kontakte ab, die dem angegebenen Filterkriterium entsprechen. Nur das angegebene Dashboard wird durchsucht; es ist keine Kontoebenensuche für eine Nummer verfügbar.
Abrufen der Nachrichten einer Unterhaltung über die Telefonnummer eines Kontakts	Rufen Sie die Unterhaltung zwischen dem angegebenen Dashboard und der angegebenen Telefonnummer ab.
Abrufen einer Gruppe anhand der ID	Ruft die Gruppe mit der angegebenen ID ab.
Abrufen von Informationen zu diesem spezifischen Dashboard	Gibt den Namen und das Telefon des Dashboards zurück.
Aktualisieren des Namens eines bestimmten Dashboards	Aktualisiert ein Dashboard. Dadurch wird die Telefonnummer eines Dashboards nicht geändert. Wenn Sie eine neue Nummer mit den Kontakten eines anderen Dashboards erstellen möchten, müssen Sie ein neues Dashboard mit post erstellen und die Kontakte mit einem Massenexport/Import hinzufügen.
Aktualisiert eine Gruppe mit der angegebenen ID.	Aktualisiert den Namen einer Gruppe mithilfe der numerischen ID der Gruppe. Wenn die übergebene Gruppen-ID nicht vorhanden ist, schlägt der Aufruf fehl.
Archiv a Conversation	Archiviert eine Unterhaltung und entfernt sie aus den Ergebnissen aller Endpunkte zum Abrufen von Unterhaltungen. Eine Unterhaltung wird automatisch aufgehoben, wenn der Kunde eine Textnachricht an Ihre Textanforderungsnummer sendet, oder wenn Sie dem Kunden einen Text aus Ihrer Textanforderungsnummer senden. Archivierungsunterhaltungen sind eine gute Möglichkeit, unübersichtlich von Kunden zu entfernen, mit denen Sie in Zukunft nicht sprechen möchten. Beachten Sie, dass die Unterhaltung automatisch archiviert wird, wenn ein Kunde in "STOP" textet, um zu verhindern, dass Sie weitere SMS-Nachrichten senden.
Aufheben der Archivierung einer Unterhaltung	Hebt die Archivierung einer Unterhaltung auf. Sobald eine Unterhaltung nicht archiviert wurde, wird sie erneut in der Warteschlange angezeigt. sie wird auch in Unterhaltungen angezeigt, die vom Endpunkt "/conversations" zurückgegeben werden. Wenn eine Unterhaltung bereits nicht archiviert wurde, hat diese Methode keine Auswirkung.
Bricht die angegebene Zahlung ab	Bricht die angegebene Zahlung ab, wobei der Benutzer über eine Kündigung der Zahlung verfügt. Zahlungen können nicht bearbeitet werden, sodass das Stornieren und Ausgeben einer neuen Zahlung die beste Möglichkeit ist, eine Zahlung zu korrigieren.
Erstellen eines neuen Dashboards mit dem angegebenen Namen und der Telefonnummer	Erstellt ein neues Dashboard im Konto. Nachdem das Dashboard erstellt wurde, werden Administratoren per E-Mail über die Änderung benachrichtigt und können mit der Zuweisung von Benutzern beginnen. Dieser Endpunkt kann ein Dashboard für alle bereitgestellten Nummern erstellen. Sie können mithilfe von GET /dashboards/provisioning nach bereitgestellten Nummern in einer bestimmten Ortsvorwahl suchen. Wenn die Telefonnummer bereits verwendet wird, wird eine Ausnahme für ungültige Anforderungen ausgelöst.
Erstellen oder Aktualisieren eines Kontakts	Erstellt oder aktualisiert einen Kontakt (je nachdem, ob bereits ein Kontakt mit der angegebenen Telefonnummer vorhanden ist).
Erstellt eine neue Gruppe	Erstellt eine neue Gruppe mit dem angegebenen Namen.
Erstellt eine neue Zahlung	Erstellt eine neue Zahlung mit der bereitgestellten Nachricht an den angegebenen Kontakt.
Löscht das angegebene Dashboard.	Löscht das angegebene Dashboard.
Löscht den Kontakt mit der angegebenen Telefonnummer.	Löscht den Kontakt mit der angegebenen Telefonnummer.
Löscht die Gruppe mit der angegebenen ID.	Löscht die Gruppe mit der angegebenen ID. Dies ist auch dann erfolgreich, wenn es Kontakte gibt, die Mitglieder der Gruppe sind (die Kontakte werden nicht gelöscht).
Markieren einer Zahlung als bezahlt	Schließt eine Zahlung als "bezahlt". Verwenden Sie diesen Endpunkt, wenn die Zahlung über ein anderes Mittel als das Zahlungsanforderungsportal bezahlt wird. Dadurch wird die Zahlung geschlossen und ihr Zahlungsbetrag zu Ihren Statistiken hinzugefügt. Dieser Endpunkt ist nicht für Zahlungen erforderlich, die über das über Textanforderung gesendete Zahlungsportal bezahlt werden; dadurch wird automatisch eine Zahlung als bezahlt markiert.
Massenaktualisierung von Kontakten	Nur das angegebene Dashboard hat Kontakte hinzugefügt; Kontakte sind nach Dashboard organisiert, und es ist keine Kontoebenensuche nach einer Nummer verfügbar.
Ruft alle benutzerdefinierten Felder ab	Ruft alle benutzerdefinierten Felder für dieses Dashboard ab. Benutzerdefinierte Felder sind zwischen Dashboards eindeutig.
Ruft alle Gruppen ab.	Ruft alle Gruppen für das Konto des Benutzers ab.
Ruft alle Tags ab	Ruft alle Tags für dieses Dashboard ab. Tags sind zwischen Dashboards eindeutig.
Ruft alle Unterhaltungen für dieses Dashboard ab.	Ruft alle Unterhaltungen für dieses Dashboard ab und enthält Informationen zur letzten Nachricht für jede Unterhaltung.
Ruft alle Zahlungen ab	Ruft alle Zahlungen ab, einschließlich stornierter und bezahlter Zahlungen. Diese können mithilfe der Abfrageparameter gefiltert werden.
Ruft den Kontakt mit der angegebenen Telefonnummer ab.	Ruft den Kontakt mit der angegebenen Telefonnummer ab.
Ruft die Zahlung mit der angegebenen ID ab.	Ruft die Zahlung mit der angegebenen ID ab.
Senden einer Nachricht an den Kontakt mit der angegebenen Telefonnummer	Sendet eine Nachricht (starte eine neue Unterhaltung, wenn die angegebene Telefonnummer keinen Nachrichtenverlauf hat).
Senden eines Nachverfolgungstexts, der den Benutzer daran erinnert, die angegebene Zahlung zu bezahlen	Sendet eine Erinnerung an den Kontakt, um die angegebene Zahlung zu bezahlen. Der Inhalt der Nachricht wird automatisch generiert. Um Spam zu vermeiden, kann pro Zahlung nur eine Erinnerung gesendet werden.

Abrufen aller Dashboards in einem Konto

Vorgangs-ID:

GetDashboards

Ruft alle Dashboards in einem Konto ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Seitenzahl, die abgerufen werden soll	page		integer	Die Seite der abzurufenden Entitäten. Beim Abrufen von Werten gibt es eine maximale Größe pro Seite, die durch page_size definiert wird. Wenn die Seite größer als die letzte Seite ist, wird ein leeres Array zurückgegeben.
Anzahl der einzelnen Entitäten, die pro Seite abgerufen werden sollen	page_size		integer	Die Größe jeder seite, die abgerufen werden soll. Beim Abrufen von Werten ist dies eine maximale Größe pro Seite, wobei der Zugriff auf nachfolgende Seiten durch den Seitenparameter erfolgt.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Seite	meta.page	integer	Die Seite der Entitäten wird abgerufen. Die Anzahl der Entitäten auf dieser Seite wird durch page_size definiert.
page_size	meta.page_size	integer	Die Anzahl der Entitäten, die auf dieser Seite angezeigt werden.
total_items	meta.total_items	integer	Die Anzahl der in der Datenbank verfügbaren Entitäten, unabhängig von der Seitengröße oder -zahl. Um die anderen Seiten anzuzeigen, ändern Sie die Seitenzahl in der Anforderung.
items	items	array of object	Liste der Dashboardentitäten, die von der Textanforderung abgerufen werden.
id	items.id	integer	Die numerische ID des Dashboards.
name	items.name	string	Der Name des Dashboards.
phone	items.phone	string	Die textende Nummer, die diesem Dashboard zugeordnet ist.

Abrufen aller Kontakte, die dem angegebenen Filterkriterium entsprechen

Vorgangs-ID:

GetContacts

Ruft alle Kontakte ab, die dem angegebenen Filterkriterium entsprechen. Nur das angegebene Dashboard wird durchsucht; es ist keine Kontoebenensuche für eine Nummer verfügbar.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Telefonnummer des Kontakts, nach der gesucht werden soll	contact_phone_number		string	Telefonnummer zum Filtern von Kontakten nach.
"Last-message-time sent before" Suchzeitstempel in UTC-Zeit	last_message_timestamp_before_utc		date-time	Abgeschnittene Zeit für die Suche nach Kontakten nach der letzten gesendeten oder empfangenen Nachricht. Es werden keine Kontakte angezeigt, die nach diesem Zeitpunkt Nachrichten gesendet haben.
"Last-message-time sent after" Suchzeitstempel in UTC-Zeit	last_message_timestamp_after_utc		date-time	Abgeschnittene Zeit für die Suche nach Kontakten nach der letzten gesendeten oder empfangenen Nachricht. Es werden keine Kontakte angezeigt, deren letzte gesendete Nachricht vor diesem Zeitpunkt angezeigt wird.
"Erstellt vor" Suchzeitstempel	contact_created_before		date-time	Abschneidungszeit für die Suche nach Kontakten nach dem Zeitpunkt der Erstellung. Es werden keine Kontakte angezeigt, die nach diesem Zeitpunkt erstellt wurden.
Suchzeitstempel 'Erstellt nach'	contact_created_after		date-time	Abschneidungszeit für die Suche nach Kontakten nach dem Zeitpunkt der Erstellung. Es werden keine Kontakte angezeigt, die vor diesem Zeitpunkt erstellt wurden.
Gibt an, ob die Unterhaltung eines Kontakts aufgelöst wird.	is_resolved		boolean	Gibt an, ob nach Kontakten gesucht werden soll, deren Unterhaltungen aufgelöst wurden.
Gibt an, ob der Kontakt blockiert ist.	is_blocked		boolean	Gibt an, ob nach Kontakten gesucht werden soll, die blockiert wurden.
Gibt an, ob der Kontakt archiviert wird.	is_archived		boolean	Gibt an, ob nach Kontakten gesucht werden soll, die archiviert wurden.
Gibt an, ob der Kontakt unterdrückt wird.	is_suppressed		boolean	Gibt an, ob nach Kontakten gesucht werden soll, die unterdrückt wurden.
Gibt an, ob sich der Kontakt abgemeldet hat.	has_opted_out		boolean	Gibt an, ob sie nach Kontakten suchen, die sich für den Empfang von Text entschieden haben.
Suchzeitstempel "Letzte Nachricht vor"	last_message_sent_before		date-time	Abgeschnittene Zeit für die Suche nach Kontakten nach dem Zeitpunkt, an dem die letzte Nachricht an den Kunden gesendet wurde. Es werden keine Kontakte angezeigt, die nach diesem Zeitpunkt Nachrichten gesendet haben. Verwendet den Zeitstempel als Ortszeit. Um nach Zeitstempel in UTC-Zeit zu filtern, verwenden Sie last_message_sent_before_utc
Suchzeitstempel "Nach der letzten Nachricht gesendet"	last_message_sent_after		date-time	Abgeschnittene Zeit für die Suche nach Kontakten nach dem Zeitpunkt, an dem die letzte Nachricht an den Kunden gesendet wurde. Es werden keine Kontakte angezeigt, deren letzte gesendete Nachricht vor diesem Zeitpunkt angezeigt wird. Verwendet den Zeitstempel als Ortszeit. Um nach Zeitstempel in UTC-Zeit zu filtern, verwenden Sie last_message_sent_after_utc
Suchzeitstempel 'Letzte Nachricht-Empfangene vor' Suchzeitstempel	last_message_received_before		date-time	Abgeschnittene Zeit für die Suche nach Kontakten nach der letzten Nachricht, die vom Kunden empfangen wurde. Es werden keine Kontakte angezeigt, die nach diesem Zeitpunkt Nachrichten empfangen haben. Verwendet den Zeitstempel als Ortszeit. Um nach Zeitstempel in UTC-Zeit zu filtern, verwenden Sie last_message_sent_before_utc
Suchzeitstempel "Nach der letzten Nachricht empfangen"	last_message_received_after		date-time	Abgeschnittene Zeit für die Suche nach Kontakten nach der letzten Nachricht, die vom Kunden empfangen wurde. Es werden keine Kontakte angezeigt, deren letzte gesendete Nachricht vor diesem Zeitpunkt angezeigt wird. Verwendet den Zeitstempel als Ortszeit. Um nach Zeitstempel in UTC-Zeit zu filtern, verwenden Sie last_message_sent_before_utc
Kontakttags	tags		string	Durch Trennzeichen getrennte Liste von GUIDs, die auf Tags verweisen, nach der Kontakte gefiltert werden sollen.
Kontaktgruppen	groups		string	Durch Trennzeichen getrennte Liste mit ganzzahligen IDs, die auf Gruppen verweisen, nach der Kontakte gefiltert werden sollen.
ID des benutzerdefinierten Felds, nach dem gefiltert werden soll	custom_field_id_1		string	Guid, die auf ein benutzerdefiniertes Feld verweist, nach dem Kontakte gefiltert werden sollen.
Wert des benutzerdefinierten Felds, nach dem gefiltert werden soll	custom_field_value_1		string	Wert, der auf ein benutzerdefiniertes Feld verweist, nach dem Kontakte gefiltert werden sollen.
ID des zweiten benutzerdefinierten Felds, nach dem gefiltert werden soll	custom_field_id_2		string	Guid, die auf das zweite benutzerdefinierte Feld verweist, nach dem Kontakte gefiltert werden sollen.
Wert des zweiten benutzerdefinierten Felds, nach dem gefiltert werden soll	custom_field_value_2		string	Wert, der auf das zweite benutzerdefinierte Feld verweist, nach dem Kontakte gefiltert werden sollen.
ID des dritten benutzerdefinierten Felds, nach dem gefiltert werden soll	custom_field_id_3		string	Guid, die auf das dritte benutzerdefinierte Feld verweist, nach dem Kontakte gefiltert werden sollen.
Wert des dritten benutzerdefinierten Felds, nach dem gefiltert werden soll	custom_field_value_3		string	Wert, der auf das dritte benutzerdefinierte Feld verweist, nach dem Kontakte gefiltert werden sollen.
Seitenzahl, die abgerufen werden soll	page	True	integer	Die Seite der abzurufenden Entitäten. Beim Abrufen von Werten gibt es eine maximale Größe pro Seite, die durch page_size definiert wird. Wenn die Seite größer als die letzte Seite ist, wird ein leeres Array zurückgegeben.
Anzahl der einzelnen Entitäten, die pro Seite abgerufen werden sollen	page_size	True	integer	Die Größe jeder seite, die abgerufen werden soll. Beim Abrufen von Werten ist dies eine maximale Größe pro Seite, wobei der Zugriff auf nachfolgende Seiten durch den Seitenparameter erfolgt.
ID des Dashboards, an dem dieser Aufruf ausgeführt werden soll	dashboard_id	True	integer	Das Telefonnummerndashboard, an dem gearbeitet werden soll. Ein einzelnes Konto kann über mehrere Dashboards verfügen, die unterschiedliche Telefonleitungen für Kunden darstellen.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Seite	meta.page	integer	Die Seite der Entitäten wird abgerufen. Die Anzahl der Entitäten auf dieser Seite wird durch page_size definiert.
page_size	meta.page_size	integer	Die Anzahl der Entitäten, die auf dieser Seite angezeigt werden.
total_items	meta.total_items	integer	Die Anzahl der in der Datenbank verfügbaren Entitäten, unabhängig von der Seitengröße oder -zahl. Um die anderen Seiten anzuzeigen, ändern Sie die Seitenzahl in der Anforderung.
items	items	array of object	Liste der Kontaktentitäten, die von der Textanforderung abgerufen wurden.
phone_number	items.phone_number	string	Telefonnummer dieses Kontakts.
first_name	items.first_name	string	Vorname dieses Kontakts.
last_name	items.last_name	string	Nachname dieses Kontakts.
display_name	items.display_name	string	Vollständiger Name dieses Kontakts. Dies ist der Standardname, der in der Web-App beim Anzeigen von Kontakten angezeigt wird.
is_suppressed	items.is_suppressed	boolean	Gibt an, ob die Unterhaltung mit diesem Kontakt unterdrückt wird und daher beim Empfang nicht an den Anfang der Nachrichtenwarteschlange verschoben wird.
is_archived	items.is_archived	boolean	Gibt an, ob die Unterhaltung mit diesem Kontakt archiviert ist und daher beim Abfragen von Unterhaltungen (standardmäßig) nicht angezeigt wird.
is_blocked	items.is_blocked	boolean	Gibt an, ob die Unterhaltung mit diesem Kontakt blockiert und daher nicht empfangen oder gespeichert wird.
suppressed_reason	items.suppressed_reason	string	Ausdruck, der den Grund für die Unterdrückung des Kontakts beschreibt. Wenn is_suppressed falsch ist, ist dies null.
Anmerkung	items.note	string	Kurzer Ausdruck zur Beschreibung des Kontakts. Wird zur Vereinfachung verwendet. Dies wird niemals dem Kontakt angezeigt.
Gruppen	items.groups	array of integer	Array von ganzzahligen IDs, die auf Gruppen verweisen, zu der dieser Kontakt gehört.
contact_tags	items.contact_tags	array of string	Array von GUIDs, die auf Tags verweisen, die an diesen Kontakt angefügt sind.
custom_fields	items.custom_fields	array of object	Array von benutzerdefinierten Feld-IDs und Werten, die für diesen Kontakt definiert sind.
id	items.custom_fields.id	string	Guid, die auf ein benutzerdefiniertes Feld verweist.
value	items.custom_fields.value	string	Der Wert dieses Kontakts für dieses benutzerdefinierte Feld.
is_resolved	items.is_resolved	boolean	Gibt an, ob die Unterhaltung mit diesem Kontakt aufgelöst wird. Alle neuen Texte, die von diesem Kontakt empfangen werden, legen diesen False fest.
first_contact_utc	items.first_contact_utc	string	Zeitstempel des Zeitpunkts, zu dem die erste Nachricht an diesen Kontakt gesendet wurde.
opted_out_utc	items.opted_out_utc	string	Zeitstempel, zu dem sich dieser Kontakt für den Empfang von Nachrichten abgemeldet hat.
last_msg_sent_utc	items.last_msg_sent_utc	string	Zeitstempel des Zeitpunkts, zu dem die letzte Nachricht an diesen Kontakt gesendet wurde.
last_msg_received_utc	items.last_msg_received_utc	string	Zeitstempel des Zeitpunkts, zu dem die letzte Nachricht von diesem Kontakt empfangen wurde.
total_msgs_sent	items.total_msgs_sent	integer	Die Anzahl der an diesen Kontakt gesendeten Nachrichten.
total_msgs_received	items.total_msgs_received	integer	Die Anzahl der nachrichten, die von diesem Kontakt empfangen wurden.
response_count	items.response_count	integer	Die Gesamtzahl der Antwortnachrichten des Kontakts.
date_created_utc	items.date_created_utc	string	Zeitstempel des Zeitpunkts, zu dem der Kontakt erstellt wurde.
last_contact_date_utc	items.last_contact_date_utc	string	Zeitstempel des Zeitpunkts, zu dem die letzte Nachricht von diesem Kontakt gesendet oder empfangen wurde.
message_id	items.last_message.message_id	string	ID der Nachricht. Dieser Wert ist für jede Nachricht eindeutig.
body	items.last_message.body	string	Inhalt dieser Nachricht.
message_direction	items.last_message.message_direction	string	Singular-Zeichen, entweder R oder S, gibt an, ob diese Nachricht vom Kontakt empfangen oder an sie gesendet wurde.
response_by_username	items.last_message.response_by_username	string	Benutzername des Benutzers der Textanforderung, der zuletzt eine Nachricht an diesen Benutzer gesendet hat.
message_timestamp_utc	items.last_message.message_timestamp_utc	string	Zeitstempel des Zeitpunkts, zu dem die Nachricht von der Textanforderung gesendet oder empfangen wurde.
delivery_status	items.last_message.delivery_status	string	Aktueller Status dieser Nachricht. Dies kann "senden", "übermittelt", "Fehler" oder "Senden" sein.
delivery_error	items.last_message.delivery_error	string	Fehler, der dazu führte, dass diese Nachricht nicht zugestellt wurde. Wenn der delivery_status nicht "error" ist, ist dieser Wert null.
mms_media	items.last_message.mms_media	array of string	Liste der URLs, die auf die Anlagen dieser Nachricht verweisen. Alle URLs werden von Textanforderung generierte URLs sein.

Abrufen der Nachrichten einer Unterhaltung über die Telefonnummer eines Kontakts

Vorgangs-ID:

GetMessagesByContactPhone

Rufen Sie die Unterhaltung zwischen dem angegebenen Dashboard und der angegebenen Telefonnummer ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Seitenzahl, die abgerufen werden soll	page	True	integer	Die Seite der abzurufenden Entitäten. Beim Abrufen von Werten gibt es eine maximale Größe pro Seite, die durch page_size definiert wird. Wenn die Seite größer als die letzte Seite ist, wird ein leeres Array zurückgegeben.
Anzahl der einzelnen Entitäten, die pro Seite abgerufen werden sollen	page_size	True	integer	Die Größe jeder seite, die abgerufen werden soll. Beim Abrufen von Werten ist dies eine maximale Größe pro Seite, wobei der Zugriff auf nachfolgende Seiten durch den Seitenparameter erfolgt.
ID des Dashboards, an dem dieser Aufruf ausgeführt werden soll	dashboard_id	True	integer	Das Telefonnummerndashboard, an dem gearbeitet werden soll. Ein einzelnes Konto kann über mehrere Dashboards verfügen, die unterschiedliche Telefonleitungen für Kunden darstellen.
Telefonnummer des Kontakts, nach der gesucht werden soll	phone_number	True	string	Telefonnummer des Kontakts, für den Nachrichten abgerufen werden sollen.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Seite	meta.page	integer	Die Seite der Entitäten wird abgerufen. Die Anzahl der Entitäten auf dieser Seite wird durch page_size definiert.
page_size	meta.page_size	integer	Die Anzahl der Entitäten, die auf dieser Seite angezeigt werden.
total_items	meta.total_items	integer	Die Anzahl der in der Datenbank verfügbaren Entitäten, unabhängig von der Seitengröße oder -zahl. Um die anderen Seiten anzuzeigen, ändern Sie die Seitenzahl in der Anforderung.
items	items	array of object	Liste der Nachrichtenentitäten, die von der Textanforderung abgerufen werden.
message_id	items.message_id	string	ID der Nachricht. Dieser Wert ist für jede Nachricht eindeutig.
body	items.body	string	Inhalt dieser Nachricht.
message_direction	items.message_direction	string	Singular-Zeichen, entweder R oder S, gibt an, ob diese Nachricht vom Kontakt empfangen oder an sie gesendet wurde.
response_by_username	items.response_by_username	string	Benutzername des Benutzers der Textanforderung, der zuletzt eine Nachricht an diesen Benutzer gesendet hat.
message_timestamp_utc	items.message_timestamp_utc	string	Zeitstempel des Zeitpunkts, zu dem die Nachricht von der Textanforderung gesendet oder empfangen wurde.
delivery_status	items.delivery_status	string	Aktueller Status dieser Nachricht. Dies kann "senden", "übermittelt", "Fehler" oder "Senden" sein.
delivery_error	items.delivery_error	string	Fehler, der dazu führte, dass diese Nachricht nicht zugestellt wurde. Wenn der delivery_status nicht "error" ist, ist dieser Wert null.
mms_media	items.mms_media	array of string	Liste der URLs, die auf die Anlagen dieser Nachricht verweisen. Alle URLs werden von Textanforderung generierte URLs sein.

Abrufen einer Gruppe anhand der ID

Vorgangs-ID:

GetGroupById

Ruft die Gruppe mit der angegebenen ID ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID des Dashboards, an dem dieser Aufruf ausgeführt werden soll	dashboard_id	True	integer	Das Telefonnummerndashboard, an dem gearbeitet werden soll. Ein einzelnes Konto kann über mehrere Dashboards verfügen, die unterschiedliche Telefonleitungen für Kunden darstellen.
ID der Gruppe	group_id	True	integer	Die numerische ID der abzurufenden Gruppe.

Gibt zurück

Name	Pfad	Typ	Beschreibung
id	id	integer	Die numerische ID der Gruppe.
group_member_count	group_member_count	integer	Die Anzahl der Mitglieder der Gruppe.
is_keyword	is_keyword	boolean	Wheter diese Gruppe ist eine Schlüsselwortgruppe. Solche Gruppen werden automatisch generiert, wenn ein Benutzer ein Schlüsselwort einrichtet. Kontakte werden automatisch hinzugefügt, wenn sie sich registrieren.
name	name	string	Der Name dieser Gruppe.
Notizen	notes	string	Alle Notizen zu dieser Gruppe.
last_message_sent_utc	last_message_sent_utc	string	Zeitstempel des Zeitpunkts, zu dem die letzte Gruppennachricht für diese Gruppe gesendet wurde.

Abrufen von Informationen zu diesem spezifischen Dashboard

Vorgangs-ID:

GetDashboard

Gibt den Namen und das Telefon des Dashboards zurück.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID des Dashboards, an dem dieser Aufruf ausgeführt werden soll	dashboard_id	True	integer	Das Telefonnummerndashboard, an dem gearbeitet werden soll. Ein einzelnes Konto kann über mehrere Dashboards verfügen, die unterschiedliche Telefonleitungen für Kunden darstellen.

Gibt zurück

Name	Pfad	Typ	Beschreibung
id	id	integer	Die numerische ID des Dashboards.
name	name	string	Der Name des Dashboards.
phone	phone	string	Die textende Nummer, die diesem Dashboard zugeordnet ist.

Aktualisieren des Namens eines bestimmten Dashboards

Vorgangs-ID:

UpdateDashboardsName

Aktualisiert ein Dashboard. Dadurch wird die Telefonnummer eines Dashboards nicht geändert. Wenn Sie eine neue Nummer mit den Kontakten eines anderen Dashboards erstellen möchten, müssen Sie ein neues Dashboard mit post erstellen und die Kontakte mit einem Massenexport/Import hinzufügen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID des Dashboards, an dem dieser Aufruf ausgeführt werden soll	dashboard_id	True	integer	Das Telefonnummerndashboard, an dem gearbeitet werden soll. Ein einzelnes Konto kann über mehrere Dashboards verfügen, die unterschiedliche Telefonleitungen für Kunden darstellen.
Dashboardname	name		string	Der neue Name des Dashboards.

Gibt zurück

Name	Pfad	Typ	Beschreibung
id	id	integer	Die numerische ID des Dashboards.
name	name	string	Der Name des Dashboards.
phone	phone	string	Die textende Nummer, die diesem Dashboard zugeordnet ist.

Aktualisiert eine Gruppe mit der angegebenen ID.

Vorgangs-ID:

UpdateGroup

Aktualisiert den Namen einer Gruppe mithilfe der numerischen ID der Gruppe. Wenn die übergebene Gruppen-ID nicht vorhanden ist, schlägt der Aufruf fehl.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID des Dashboards, an dem dieser Aufruf ausgeführt werden soll	dashboard_id	True	integer	Das Telefonnummerndashboard, an dem gearbeitet werden soll. Ein einzelnes Konto kann über mehrere Dashboards verfügen, die unterschiedliche Telefonleitungen für Kunden darstellen.
ID der Gruppe	group_id	True	integer	Die numerische ID der zu aktualisierenden Gruppe.
Gruppenname	name		string	Der neue Name der Gruppe.
Gruppennotiz	notes		string	Kurzer Ausdruck, der die Gruppe beschreibt. Wird zur Vereinfachung verwendet.

Gibt zurück

Name	Pfad	Typ	Beschreibung
id	id	integer	Die numerische ID der Gruppe.
group_member_count	group_member_count	integer	Die Anzahl der Mitglieder der Gruppe.
is_keyword	is_keyword	boolean	Wheter diese Gruppe ist eine Schlüsselwortgruppe. Solche Gruppen werden automatisch generiert, wenn ein Benutzer ein Schlüsselwort einrichtet. Kontakte werden automatisch hinzugefügt, wenn sie sich registrieren.
name	name	string	Der Name dieser Gruppe.
Notizen	notes	string	Alle Notizen zu dieser Gruppe.
last_message_sent_utc	last_message_sent_utc	string	Zeitstempel des Zeitpunkts, zu dem die letzte Gruppennachricht für diese Gruppe gesendet wurde.

Archiv a Conversation

Vorgangs-ID:

ArchiveConversation

Archiviert eine Unterhaltung und entfernt sie aus den Ergebnissen aller Endpunkte zum Abrufen von Unterhaltungen. Eine Unterhaltung wird automatisch aufgehoben, wenn der Kunde eine Textnachricht an Ihre Textanforderungsnummer sendet, oder wenn Sie dem Kunden einen Text aus Ihrer Textanforderungsnummer senden. Archivierungsunterhaltungen sind eine gute Möglichkeit, unübersichtlich von Kunden zu entfernen, mit denen Sie in Zukunft nicht sprechen möchten. Beachten Sie, dass die Unterhaltung automatisch archiviert wird, wenn ein Kunde in "STOP" textet, um zu verhindern, dass Sie weitere SMS-Nachrichten senden.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID des Dashboards, an dem dieser Aufruf ausgeführt werden soll	dashboard_id	True	integer	Das Telefonnummerndashboard, an dem gearbeitet werden soll. Ein einzelnes Konto kann über mehrere Dashboards verfügen, die unterschiedliche Telefonleitungen für Kunden darstellen.
Telefonnummer der Unterhaltung	phone_number	True	string	Telefonnummer der zu archivierenden Unterhaltung.

Gibt zurück

response

string

Aufheben der Archivierung einer Unterhaltung

Vorgangs-ID:

UnarchiveConversation

Hebt die Archivierung einer Unterhaltung auf. Sobald eine Unterhaltung nicht archiviert wurde, wird sie erneut in der Warteschlange angezeigt. sie wird auch in Unterhaltungen angezeigt, die vom Endpunkt "/conversations" zurückgegeben werden. Wenn eine Unterhaltung bereits nicht archiviert wurde, hat diese Methode keine Auswirkung.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID des Dashboards, an dem dieser Aufruf ausgeführt werden soll	dashboard_id	True	integer	Das Telefonnummerndashboard, an dem gearbeitet werden soll. Ein einzelnes Konto kann über mehrere Dashboards verfügen, die unterschiedliche Telefonleitungen für Kunden darstellen.
Telefonnummer der Unterhaltung	phone_number	True	string	Telefonnummer der zu archivierenden Unterhaltung.

Gibt zurück

response

string

Bricht die angegebene Zahlung ab

Vorgangs-ID:

CancelPayment

Bricht die angegebene Zahlung ab, wobei der Benutzer über eine Kündigung der Zahlung verfügt. Zahlungen können nicht bearbeitet werden, sodass das Stornieren und Ausgeben einer neuen Zahlung die beste Möglichkeit ist, eine Zahlung zu korrigieren.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID des Dashboards, an dem dieser Aufruf ausgeführt werden soll	dashboard_id	True	integer	Das Telefonnummerndashboard, an dem gearbeitet werden soll. Ein einzelnes Konto kann über mehrere Dashboards verfügen, die unterschiedliche Telefonleitungen für Kunden darstellen.
ID der Zahlung	payment_id	True	integer	Die numerische ID der zu aktualisierenden Zahlung.

Gibt zurück

Name	Pfad	Typ	Beschreibung
payment_id	payment_id	integer	Die numerische ID der Zahlung.
request_date	request_date	string	Der Zeitstempel, zu dem die erste Nachricht dieser Zahlung in die Warteschlange gestellt wurde, die gesendet werden soll.
recipient	recipient	string	Der Name des Zahlungsempfängers. Dies kann null sein, wenn der Kontakt keinen Namen hat, der mit seiner Telefonnummer verknüpft ist.
Beschreibung	description	string	Die Beschreibung der Zahlung. Dies wird dem Kontakt nicht angezeigt. Es wird nur von internen Benutzern für kontextbezogene Zahlungen verwendet.
customer_phone	customer_phone	string	Die Telefonnummer des Kontakts, der diese Zahlung gesendet wird.
amount_requested	amount_requested	float	Der Betrag in Dollar, der von dieser Zahlung angefordert wird.
is_past_due	is_past_due	boolean	Gibt an, ob diese Zahlung über das Anforderungsdatum liegt.
reminder_was_sent	reminder_was_sent	boolean	Gibt an, ob für diese Zahlung bereits eine Texterinnerung gesendet wurde.
transaction_status	transaction_status	string	Der Status der Transaktion in authvia. Dieser Wert beginnt als Unbekannt.
textrequest_payment_status	textrequest_payment_status	string	Der Status der Transaktion in der Textanforderung. Dies stellt den Status dar, der auf der Seite "Zahlungen" in der Textanforderungs-App angezeigt wird. Sie beginnt als gesendet.
reference_number	reference_number	string	Die benutzerdefinierte ID, die beim Erstellen von Zahlungen definiert ist, die verwendet werden können, um Zahlungen schnell zu finden. Referenznummern sind nicht eindeutig; viele Zahlungen können denselben Bezug haben.

Erstellen eines neuen Dashboards mit dem angegebenen Namen und der Telefonnummer

Vorgangs-ID:

CreateDashboard

Erstellt ein neues Dashboard im Konto. Nachdem das Dashboard erstellt wurde, werden Administratoren per E-Mail über die Änderung benachrichtigt und können mit der Zuweisung von Benutzern beginnen. Dieser Endpunkt kann ein Dashboard für alle bereitgestellten Nummern erstellen. Sie können mithilfe von GET /dashboards/provisioning nach bereitgestellten Nummern in einer bestimmten Ortsvorwahl suchen. Wenn die Telefonnummer bereits verwendet wird, wird eine Ausnahme für ungültige Anforderungen ausgelöst.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
name	name		string	Der Name des Dashboards.
phone	phone		string	Die textende Nummer, die diesem Dashboard zugeordnet ist.

Gibt zurück

Name	Pfad	Typ	Beschreibung
id	id	integer	Die numerische ID des Dashboards.
name	name	string	Der Name des Dashboards.
phone	phone	string	Die textende Nummer, die diesem Dashboard zugeordnet ist.

Erstellen oder Aktualisieren eines Kontakts

Vorgangs-ID:

CreateContact

Erstellt oder aktualisiert einen Kontakt (je nachdem, ob bereits ein Kontakt mit der angegebenen Telefonnummer vorhanden ist).

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID des Dashboards, an dem dieser Aufruf ausgeführt werden soll	dashboard_id	True	integer	Das Telefonnummerndashboard, an dem gearbeitet werden soll. Ein einzelnes Konto kann über mehrere Dashboards verfügen, die unterschiedliche Telefonleitungen für Kunden darstellen.
Telefonnummer des Kontakts	phone_number	True	string	Telefonnummer des kontakts, der erstellt oder aktualisiert werden soll.
Vorname des Kontakts	first_name		string	Der neue Vorname des Kontakts.
Nachname des Kontakts	last_name		string	Der neue Nachname des Kontakts.
Vollständiger Name des Kontakts	display_name		string	Der neue vollständige Name des Kontakts. Dies ist der Standardname, der in der Web-App beim Anzeigen von Kontakten angezeigt wird.
Gibt an, ob Nachrichten von diesem Kontakt unterdrückt werden.	is_suppressed		boolean	Bestimmt, ob Unterhaltungen mit diesem Kontakt unterdrückt werden und daher beim Empfang nicht an den Anfang der Nachrichtenwarteschlange verschoben werden.
Gibt an, ob Nachrichten aus diesem Kontakt archiviert werden	is_archived		boolean	Bestimmt, ob Unterhaltungen mit diesem Kontakt archiviert werden und daher beim Abfragen von Unterhaltungen (standardmäßig) nicht angezeigt werden können.
Gibt an, ob Nachrichten von diesem Kontakt blockiert werden.	is_blocked		boolean	Bestimmt, ob Unterhaltungen mit diesem Kontakt blockiert und daher nicht empfangen oder gespeichert werden.
Grund für die Unterdrückung dieses Kontakts	suppressed_reason		string	Ausdruck, der den Grund für die Unterdrückung des Kontakts beschreibt.
Kontaktnotiz	note		string	Kurzer Ausdruck zur Beschreibung des Kontakts. Wird zur Vereinfachung verwendet. Dies wird niemals dem Kontakt angezeigt.
Kontaktgruppen	groups		array of integer	Array von ganzzahligen IDs, die auf Gruppen verweisen, zu der dieser Kontakt gehört.
Kontakttags	contact_tags		array of string	Array von GUIDs, die auf Tags verweisen, die an diesen Kontakt angefügt sind.
Id des benutzerdefinierten Felds	id		string	Guid, die auf ein benutzerdefiniertes Feld verweist.
Wert des benutzerdefinierten Felds	value		string	Der Wert dieses Kontakts für dieses benutzerdefinierte Feld.
Gibt an, ob die aktuelle Unterhaltung mit diesem Kontakt aufgelöst wurde.	is_resolved		boolean	Bestimmt, ob die aktuelle Unterhaltung mit diesem Kontakt aufgelöst wird. Alle neuen Texte, die von diesem Kontakt empfangen werden, legen diesen False fest.

Gibt zurück

Name	Pfad	Typ	Beschreibung
phone_number	phone_number	string	Telefonnummer dieses Kontakts.
first_name	first_name	string	Vorname dieses Kontakts.
last_name	last_name	string	Nachname dieses Kontakts.
display_name	display_name	string	Vollständiger Name dieses Kontakts. Dies ist der Standardname, der in der Web-App beim Anzeigen von Kontakten angezeigt wird.
is_suppressed	is_suppressed	boolean	Gibt an, ob die Unterhaltung mit diesem Kontakt unterdrückt wird und daher beim Empfang nicht an den Anfang der Nachrichtenwarteschlange verschoben wird.
is_archived	is_archived	boolean	Gibt an, ob die Unterhaltung mit diesem Kontakt archiviert ist und daher beim Abfragen von Unterhaltungen (standardmäßig) nicht angezeigt wird.
is_blocked	is_blocked	boolean	Gibt an, ob die Unterhaltung mit diesem Kontakt blockiert und daher nicht empfangen oder gespeichert wird.
suppressed_reason	suppressed_reason	string	Ausdruck, der den Grund für die Unterdrückung des Kontakts beschreibt. Wenn is_suppressed falsch ist, ist dies null.
Anmerkung	note	string	Kurzer Ausdruck zur Beschreibung des Kontakts. Wird zur Vereinfachung verwendet. Dies wird niemals dem Kontakt angezeigt.
Gruppen	groups	array of integer	Array von ganzzahligen IDs, die auf Gruppen verweisen, zu der dieser Kontakt gehört.
contact_tags	contact_tags	array of string	Array von GUIDs, die auf Tags verweisen, die an diesen Kontakt angefügt sind.
custom_fields	custom_fields	array of object	Array von benutzerdefinierten Feld-IDs und Werten, die für diesen Kontakt definiert sind.
id	custom_fields.id	string	Guid, die auf ein benutzerdefiniertes Feld verweist.
value	custom_fields.value	string	Der Wert dieses Kontakts für dieses benutzerdefinierte Feld.
is_resolved	is_resolved	boolean	Gibt an, ob die Unterhaltung mit diesem Kontakt aufgelöst wird. Alle neuen Texte, die von diesem Kontakt empfangen werden, legen diesen False fest.
first_contact_utc	first_contact_utc	string	Zeitstempel des Zeitpunkts, zu dem die erste Nachricht an diesen Kontakt gesendet wurde.
opted_out_utc	opted_out_utc	string	Zeitstempel, zu dem sich dieser Kontakt für den Empfang von Nachrichten abgemeldet hat.
last_msg_sent_utc	last_msg_sent_utc	string	Zeitstempel des Zeitpunkts, zu dem die letzte Nachricht an diesen Kontakt gesendet wurde.
last_msg_received_utc	last_msg_received_utc	string	Zeitstempel des Zeitpunkts, zu dem die letzte Nachricht von diesem Kontakt empfangen wurde.
total_msgs_sent	total_msgs_sent	integer	Die Anzahl der an diesen Kontakt gesendeten Nachrichten.
total_msgs_received	total_msgs_received	integer	Die Anzahl der nachrichten, die von diesem Kontakt empfangen wurden.
response_count	response_count	integer	Die Gesamtzahl der Antwortnachrichten des Kontakts.
date_created_utc	date_created_utc	string	Zeitstempel des Zeitpunkts, zu dem der Kontakt erstellt wurde.
last_contact_date_utc	last_contact_date_utc	string	Zeitstempel des Zeitpunkts, zu dem die letzte Nachricht von diesem Kontakt gesendet oder empfangen wurde.
message_id	last_message.message_id	string	ID der Nachricht. Dieser Wert ist für jede Nachricht eindeutig.
body	last_message.body	string	Inhalt dieser Nachricht.
message_direction	last_message.message_direction	string	Singular-Zeichen, entweder R oder S, gibt an, ob diese Nachricht vom Kontakt empfangen oder an sie gesendet wurde.
response_by_username	last_message.response_by_username	string	Benutzername des Benutzers der Textanforderung, der zuletzt eine Nachricht an diesen Benutzer gesendet hat.
message_timestamp_utc	last_message.message_timestamp_utc	string	Zeitstempel des Zeitpunkts, zu dem die Nachricht von der Textanforderung gesendet oder empfangen wurde.
delivery_status	last_message.delivery_status	string	Aktueller Status dieser Nachricht. Dies kann "senden", "übermittelt", "Fehler" oder "Senden" sein.
delivery_error	last_message.delivery_error	string	Fehler, der dazu führte, dass diese Nachricht nicht zugestellt wurde. Wenn der delivery_status nicht "error" ist, ist dieser Wert null.
mms_media	last_message.mms_media	array of string	Liste der URLs, die auf die Anlagen dieser Nachricht verweisen. Alle URLs werden von Textanforderung generierte URLs sein.

Erstellt eine neue Gruppe

Vorgangs-ID:

CreateGroup

Erstellt eine neue Gruppe mit dem angegebenen Namen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID des Dashboards, an dem dieser Aufruf ausgeführt werden soll	dashboard_id	True	integer	Das Telefonnummerndashboard, an dem gearbeitet werden soll. Ein einzelnes Konto kann über mehrere Dashboards verfügen, die unterschiedliche Telefonleitungen für Kunden darstellen.
Gruppenname	name		string	Der neue Name der Gruppe.
Gruppennotiz	notes		string	Kurzer Ausdruck, der die Gruppe beschreibt. Wird zur Vereinfachung verwendet.

Gibt zurück

Name	Pfad	Typ	Beschreibung
id	id	integer	Die numerische ID der Gruppe.
group_member_count	group_member_count	integer	Die Anzahl der Mitglieder der Gruppe.
is_keyword	is_keyword	boolean	Wheter diese Gruppe ist eine Schlüsselwortgruppe. Solche Gruppen werden automatisch generiert, wenn ein Benutzer ein Schlüsselwort einrichtet. Kontakte werden automatisch hinzugefügt, wenn sie sich registrieren.
name	name	string	Der Name dieser Gruppe.
Notizen	notes	string	Alle Notizen zu dieser Gruppe.
last_message_sent_utc	last_message_sent_utc	string	Zeitstempel des Zeitpunkts, zu dem die letzte Gruppennachricht für diese Gruppe gesendet wurde.

Erstellt eine neue Zahlung

Vorgangs-ID:

CreatePayment

Erstellt eine neue Zahlung mit der bereitgestellten Nachricht an den angegebenen Kontakt.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID des Dashboards, an dem dieser Aufruf ausgeführt werden soll	dashboard_id	True	integer	Das Telefonnummerndashboard, an dem gearbeitet werden soll. Ein einzelnes Konto kann über mehrere Dashboards verfügen, die unterschiedliche Telefonleitungen für Kunden darstellen.
Zahlungsbeschreibung	description		string	Beschreibung der Zahlung. Die Beschreibung wird dem Kontakt nicht angezeigt und wird nur von internen Benutzern für kontextbezogene Zahlungen verwendet.
Telefonnummer des Angerufenen	customer_phone		string	Telefonnummer des Kontakts, an den diese Zahlung gesendet wird.
In Dollar angeforderter Betrag	amount_requested		float	Der Betrag in Dollar, der von dieser Zahlung angefordert wird.
Textkörper der Zahlungsnachricht	message		string	Nachrichtentext, der zusammen mit dem Zahlungslink an Kontakt gesendet werden soll.
Referenzzeichenfolge der Zahlung	reference_number		string	Benutzerdefinierte ID, die beim Erstellen von Zahlungen definiert ist, die verwendet werden können, um Zahlungen schnell zu finden. Referenznummern sind nicht eindeutig; viele Zahlungen können denselben Bezug haben.

Gibt zurück

Name	Pfad	Typ	Beschreibung
payment_id	payment_id	integer	Die numerische ID der Zahlung.
request_date	request_date	string	Der Zeitstempel, zu dem die erste Nachricht dieser Zahlung in die Warteschlange gestellt wurde, die gesendet werden soll.
recipient	recipient	string	Der Name des Zahlungsempfängers. Dies kann null sein, wenn der Kontakt keinen Namen hat, der mit seiner Telefonnummer verknüpft ist.
Beschreibung	description	string	Die Beschreibung der Zahlung. Dies wird dem Kontakt nicht angezeigt. Es wird nur von internen Benutzern für kontextbezogene Zahlungen verwendet.
customer_phone	customer_phone	string	Die Telefonnummer des Kontakts, der diese Zahlung gesendet wird.
amount_requested	amount_requested	float	Der Betrag in Dollar, der von dieser Zahlung angefordert wird.
is_past_due	is_past_due	boolean	Gibt an, ob diese Zahlung über das Anforderungsdatum liegt.
reminder_was_sent	reminder_was_sent	boolean	Gibt an, ob für diese Zahlung bereits eine Texterinnerung gesendet wurde.
transaction_status	transaction_status	string	Der Status der Transaktion in authvia. Dieser Wert beginnt als Unbekannt.
textrequest_payment_status	textrequest_payment_status	string	Der Status der Transaktion in der Textanforderung. Dies stellt den Status dar, der auf der Seite "Zahlungen" in der Textanforderungs-App angezeigt wird. Sie beginnt als gesendet.
reference_number	reference_number	string	Die benutzerdefinierte ID, die beim Erstellen von Zahlungen definiert ist, die verwendet werden können, um Zahlungen schnell zu finden. Referenznummern sind nicht eindeutig; viele Zahlungen können denselben Bezug haben.

Löscht das angegebene Dashboard.

Vorgangs-ID:

DeleteDashboard

Löscht das angegebene Dashboard.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID des Dashboards, an dem dieser Aufruf ausgeführt werden soll	dashboard_id	True	integer	Das Telefonnummerndashboard, an dem gearbeitet werden soll. Ein einzelnes Konto kann über mehrere Dashboards verfügen, die unterschiedliche Telefonleitungen für Kunden darstellen.

Gibt zurück

response

string

Löscht den Kontakt mit der angegebenen Telefonnummer.

Vorgangs-ID:

DeleteContact

Löscht den Kontakt mit der angegebenen Telefonnummer.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID des Dashboards, an dem dieser Aufruf ausgeführt werden soll	dashboard_id	True	integer	Das Telefonnummerndashboard, an dem gearbeitet werden soll. Ein einzelnes Konto kann über mehrere Dashboards verfügen, die unterschiedliche Telefonleitungen für Kunden darstellen.
Telefonnummer des Kontakts	phone_number	True	string	Telefonnummer des zu löschenden Kontakts.

Gibt zurück

response

string

Löscht die Gruppe mit der angegebenen ID.

Vorgangs-ID:

DeleteGroup

Löscht die Gruppe mit der angegebenen ID. Dies ist auch dann erfolgreich, wenn es Kontakte gibt, die Mitglieder der Gruppe sind (die Kontakte werden nicht gelöscht).

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID des Dashboards, an dem dieser Aufruf ausgeführt werden soll	dashboard_id	True	integer	Das Telefonnummerndashboard, an dem gearbeitet werden soll. Ein einzelnes Konto kann über mehrere Dashboards verfügen, die unterschiedliche Telefonleitungen für Kunden darstellen.
ID der Gruppe	group_id	True	integer	Die numerische ID der zu löschenden Gruppe.

Gibt zurück

response

string

Markieren einer Zahlung als bezahlt

Vorgangs-ID:

MarkPaymentPaid

Schließt eine Zahlung als "bezahlt". Verwenden Sie diesen Endpunkt, wenn die Zahlung über ein anderes Mittel als das Zahlungsanforderungsportal bezahlt wird. Dadurch wird die Zahlung geschlossen und ihr Zahlungsbetrag zu Ihren Statistiken hinzugefügt. Dieser Endpunkt ist nicht für Zahlungen erforderlich, die über das über Textanforderung gesendete Zahlungsportal bezahlt werden; dadurch wird automatisch eine Zahlung als bezahlt markiert.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID des Dashboards, an dem dieser Aufruf ausgeführt werden soll	dashboard_id	True	integer	Das Telefonnummerndashboard, an dem gearbeitet werden soll. Ein einzelnes Konto kann über mehrere Dashboards verfügen, die unterschiedliche Telefonleitungen für Kunden darstellen.
ID der Zahlung	payment_id	True	integer	Die numerische ID der zu aktualisierenden Zahlung.

Gibt zurück

Name	Pfad	Typ	Beschreibung
payment_id	payment_id	integer	Die numerische ID der Zahlung.
request_date	request_date	string	Der Zeitstempel, zu dem die erste Nachricht dieser Zahlung in die Warteschlange gestellt wurde, die gesendet werden soll.
recipient	recipient	string	Der Name des Zahlungsempfängers. Dies kann null sein, wenn der Kontakt keinen Namen hat, der mit seiner Telefonnummer verknüpft ist.
Beschreibung	description	string	Die Beschreibung der Zahlung. Dies wird dem Kontakt nicht angezeigt. Es wird nur von internen Benutzern für kontextbezogene Zahlungen verwendet.
customer_phone	customer_phone	string	Die Telefonnummer des Kontakts, der diese Zahlung gesendet wird.
amount_requested	amount_requested	float	Der Betrag in Dollar, der von dieser Zahlung angefordert wird.
is_past_due	is_past_due	boolean	Gibt an, ob diese Zahlung über das Anforderungsdatum liegt.
reminder_was_sent	reminder_was_sent	boolean	Gibt an, ob für diese Zahlung bereits eine Texterinnerung gesendet wurde.
transaction_status	transaction_status	string	Der Status der Transaktion in authvia. Dieser Wert beginnt als Unbekannt.
textrequest_payment_status	textrequest_payment_status	string	Der Status der Transaktion in der Textanforderung. Dies stellt den Status dar, der auf der Seite "Zahlungen" in der Textanforderungs-App angezeigt wird. Sie beginnt als gesendet.
reference_number	reference_number	string	Die benutzerdefinierte ID, die beim Erstellen von Zahlungen definiert ist, die verwendet werden können, um Zahlungen schnell zu finden. Referenznummern sind nicht eindeutig; viele Zahlungen können denselben Bezug haben.

Massenaktualisierung von Kontakten

Vorgangs-ID:

BulkUpdateContacts

Nur das angegebene Dashboard hat Kontakte hinzugefügt; Kontakte sind nach Dashboard organisiert, und es ist keine Kontoebenensuche nach einer Nummer verfügbar.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID des Dashboards, an dem dieser Aufruf ausgeführt werden soll	dashboard_id	True	integer	Das Telefonnummerndashboard, an dem gearbeitet werden soll. Ein einzelnes Konto kann über mehrere Dashboards verfügen, die unterschiedliche Telefonleitungen für Kunden darstellen.
Telefonnummer des Kontakts	phone_number		string	Telefonnummer des kontakts, der erstellt oder aktualisiert werden soll.
Vorname des Kontakts	first_name		string	Der neue Vorname des Kontakts.
Nachname des Kontakts	last_name		string	Der neue Nachname des Kontakts.
Vollständiger Name des Kontakts	display_name		string	Der neue vollständige Name des Kontakts. Dies ist der Standardname, der in der Web-App beim Anzeigen von Kontakten angezeigt wird.
Gibt an, ob Nachrichten von diesem Kontakt unterdrückt werden.	is_suppressed		boolean	Bestimmt, ob Unterhaltungen mit diesem Kontakt unterdrückt werden und daher beim Empfang nicht an den Anfang der Nachrichtenwarteschlange verschoben werden.
Gibt an, ob Nachrichten aus diesem Kontakt archiviert werden	is_archived		boolean	Bestimmt, ob Unterhaltungen mit diesem Kontakt archiviert werden und daher beim Abfragen von Unterhaltungen (standardmäßig) nicht angezeigt werden können.
Gibt an, ob Nachrichten von diesem Kontakt blockiert werden.	is_blocked		boolean	Bestimmt, ob Unterhaltungen mit diesem Kontakt blockiert und daher nicht empfangen oder gespeichert werden.
Grund für die Unterdrückung dieses Kontakts	suppressed_reason		string	Ausdruck, der den Grund für die Unterdrückung des Kontakts beschreibt.
Kontaktnotiz	note		string	Kurzer Ausdruck zur Beschreibung des Kontakts. Wird zur Vereinfachung verwendet. Dies wird niemals dem Kontakt angezeigt.
Kontaktgruppen	groups		array of integer	Array von ganzzahligen IDs, die auf Gruppen verweisen, zu der dieser Kontakt gehört.
Kontakttags	contact_tags		array of string	Array von GUIDs, die auf Tags verweisen, die an diesen Kontakt angefügt sind.
Id des benutzerdefinierten Felds	id		string	Guid, die auf ein benutzerdefiniertes Feld verweist.
Wert des benutzerdefinierten Felds	value		string	Der Wert dieses Kontakts für dieses benutzerdefinierte Feld.
Gibt an, ob die aktuelle Unterhaltung mit diesem Kontakt aufgelöst wurde.	is_resolved		boolean	Bestimmt, ob die aktuelle Unterhaltung mit diesem Kontakt aufgelöst wird. Alle neuen Texte, die von diesem Kontakt empfangen werden, legen diesen False fest.

Gibt zurück

Name	Pfad	Typ	Beschreibung
		array of object
phone_number	phone_number	string	Telefonnummer dieses Kontakts.
first_name	first_name	string	Vorname dieses Kontakts.
last_name	last_name	string	Nachname dieses Kontakts.
display_name	display_name	string	Vollständiger Name dieses Kontakts. Dies ist der Standardname, der in der Web-App beim Anzeigen von Kontakten angezeigt wird.
is_suppressed	is_suppressed	boolean	Gibt an, ob die Unterhaltung mit diesem Kontakt unterdrückt wird und daher beim Empfang nicht an den Anfang der Nachrichtenwarteschlange verschoben wird.
is_archived	is_archived	boolean	Gibt an, ob die Unterhaltung mit diesem Kontakt archiviert ist und daher beim Abfragen von Unterhaltungen (standardmäßig) nicht angezeigt wird.
is_blocked	is_blocked	boolean	Gibt an, ob die Unterhaltung mit diesem Kontakt blockiert und daher nicht empfangen oder gespeichert wird.
suppressed_reason	suppressed_reason	string	Ausdruck, der den Grund für die Unterdrückung des Kontakts beschreibt. Wenn is_suppressed falsch ist, ist dies null.
Anmerkung	note	string	Kurzer Ausdruck zur Beschreibung des Kontakts. Wird zur Vereinfachung verwendet. Dies wird niemals dem Kontakt angezeigt.
Gruppen	groups	array of integer	Array von ganzzahligen IDs, die auf Gruppen verweisen, zu der dieser Kontakt gehört.
contact_tags	contact_tags	array of string	Array von GUIDs, die auf Tags verweisen, die an diesen Kontakt angefügt sind.
custom_fields	custom_fields	array of object	Array von benutzerdefinierten Feld-IDs und Werten, die für diesen Kontakt definiert sind.
id	custom_fields.id	string	Guid, die auf ein benutzerdefiniertes Feld verweist.
value	custom_fields.value	string	Der Wert dieses Kontakts für dieses benutzerdefinierte Feld.
is_resolved	is_resolved	boolean	Gibt an, ob die Unterhaltung mit diesem Kontakt aufgelöst wird. Alle neuen Texte, die von diesem Kontakt empfangen werden, legen diesen False fest.
first_contact_utc	first_contact_utc	string	Zeitstempel des Zeitpunkts, zu dem die erste Nachricht an diesen Kontakt gesendet wurde.
opted_out_utc	opted_out_utc	string	Zeitstempel, zu dem sich dieser Kontakt für den Empfang von Nachrichten abgemeldet hat.
last_msg_sent_utc	last_msg_sent_utc	string	Zeitstempel des Zeitpunkts, zu dem die letzte Nachricht an diesen Kontakt gesendet wurde.
last_msg_received_utc	last_msg_received_utc	string	Zeitstempel des Zeitpunkts, zu dem die letzte Nachricht von diesem Kontakt empfangen wurde.
total_msgs_sent	total_msgs_sent	integer	Die Anzahl der an diesen Kontakt gesendeten Nachrichten.
total_msgs_received	total_msgs_received	integer	Die Anzahl der nachrichten, die von diesem Kontakt empfangen wurden.
response_count	response_count	integer	Die Gesamtzahl der Antwortnachrichten des Kontakts.
date_created_utc	date_created_utc	string	Zeitstempel des Zeitpunkts, zu dem der Kontakt erstellt wurde.
last_contact_date_utc	last_contact_date_utc	string	Zeitstempel des Zeitpunkts, zu dem die letzte Nachricht von diesem Kontakt gesendet oder empfangen wurde.
message_id	last_message.message_id	string	ID der Nachricht. Dieser Wert ist für jede Nachricht eindeutig.
body	last_message.body	string	Inhalt dieser Nachricht.
message_direction	last_message.message_direction	string	Singular-Zeichen, entweder R oder S, gibt an, ob diese Nachricht vom Kontakt empfangen oder an sie gesendet wurde.
response_by_username	last_message.response_by_username	string	Benutzername des Benutzers der Textanforderung, der zuletzt eine Nachricht an diesen Benutzer gesendet hat.
message_timestamp_utc	last_message.message_timestamp_utc	string	Zeitstempel des Zeitpunkts, zu dem die Nachricht von der Textanforderung gesendet oder empfangen wurde.
delivery_status	last_message.delivery_status	string	Aktueller Status dieser Nachricht. Dies kann "senden", "übermittelt", "Fehler" oder "Senden" sein.
delivery_error	last_message.delivery_error	string	Fehler, der dazu führte, dass diese Nachricht nicht zugestellt wurde. Wenn der delivery_status nicht "error" ist, ist dieser Wert null.
mms_media	last_message.mms_media	array of string	Liste der URLs, die auf die Anlagen dieser Nachricht verweisen. Alle URLs werden von Textanforderung generierte URLs sein.

Ruft alle benutzerdefinierten Felder ab

Vorgangs-ID:

GetCustomFields

Ruft alle benutzerdefinierten Felder für dieses Dashboard ab. Benutzerdefinierte Felder sind zwischen Dashboards eindeutig.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID des Dashboards, an dem dieser Aufruf ausgeführt werden soll	dashboard_id	True	integer	Das Telefonnummerndashboard, an dem gearbeitet werden soll. Ein einzelnes Konto kann über mehrere Dashboards verfügen, die unterschiedliche Telefonleitungen für Kunden darstellen.

Gibt zurück

Name	Pfad	Typ	Beschreibung
		array of object
id	id	string	Die numerische ID des Felds.
name	name	string	Der Name des benutzerdefinierten Felds.

Ruft alle Gruppen ab.

Vorgangs-ID:

GetGroups

Ruft alle Gruppen für das Konto des Benutzers ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Seitenzahl, die abgerufen werden soll	page	True	integer	Die Seite der abzurufenden Entitäten. Beim Abrufen von Werten gibt es eine maximale Größe pro Seite, die durch page_size definiert wird. Wenn die Seite größer als die letzte Seite ist, wird ein leeres Array zurückgegeben.
Anzahl der einzelnen Entitäten, die pro Seite abgerufen werden sollen	page_size	True	integer	Die Größe jeder seite, die abgerufen werden soll. Beim Abrufen von Werten ist dies eine maximale Größe pro Seite, wobei der Zugriff auf nachfolgende Seiten durch den Seitenparameter erfolgt.
ID des Dashboards, an dem dieser Aufruf ausgeführt werden soll	dashboard_id	True	integer	Das Telefonnummerndashboard, an dem gearbeitet werden soll. Ein einzelnes Konto kann über mehrere Dashboards verfügen, die unterschiedliche Telefonleitungen für Kunden darstellen.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Seite	meta.page	integer	Die Seite der Entitäten wird abgerufen. Die Anzahl der Entitäten auf dieser Seite wird durch page_size definiert.
page_size	meta.page_size	integer	Die Anzahl der Entitäten, die auf dieser Seite angezeigt werden.
total_items	meta.total_items	integer	Die Anzahl der in der Datenbank verfügbaren Entitäten, unabhängig von der Seitengröße oder -zahl. Um die anderen Seiten anzuzeigen, ändern Sie die Seitenzahl in der Anforderung.
items	items	array of object	Liste der Gruppenentitäten, die von der Textanforderung abgerufen werden.
id	items.id	integer	Die numerische ID der Gruppe.
group_member_count	items.group_member_count	integer	Die Anzahl der Mitglieder der Gruppe.
is_keyword	items.is_keyword	boolean	Wheter diese Gruppe ist eine Schlüsselwortgruppe. Solche Gruppen werden automatisch generiert, wenn ein Benutzer ein Schlüsselwort einrichtet. Kontakte werden automatisch hinzugefügt, wenn sie sich registrieren.
name	items.name	string	Der Name dieser Gruppe.
Notizen	items.notes	string	Alle Notizen zu dieser Gruppe.
last_message_sent_utc	items.last_message_sent_utc	string	Der Zeitstempel, zu dem die letzte Gruppennachricht für diese Gruppe gesendet wurde.

Ruft alle Tags ab

Vorgangs-ID:

GetTags

Ruft alle Tags für dieses Dashboard ab. Tags sind zwischen Dashboards eindeutig.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID des Dashboards, an dem dieser Aufruf ausgeführt werden soll	dashboard_id	True	integer	Das Telefonnummerndashboard, an dem gearbeitet werden soll. Ein einzelnes Konto kann über mehrere Dashboards verfügen, die unterschiedliche Telefonleitungen für Kunden darstellen.
Seitenzahl, die abgerufen werden soll	page	True	integer	Die Seite der abzurufenden Entitäten. Beim Abrufen von Werten gibt es eine maximale Größe pro Seite, die durch page_size definiert wird. Wenn die Seite größer als die letzte Seite ist, wird ein leeres Array zurückgegeben.
Anzahl der einzelnen Entitäten, die pro Seite abgerufen werden sollen	page_size	True	integer	Die Größe jeder seite, die abgerufen werden soll. Beim Abrufen von Werten ist dies eine maximale Größe pro Seite, wobei der Zugriff auf nachfolgende Seiten durch den Seitenparameter erfolgt.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Seite	meta.page	integer	Die Seite der Entitäten wird abgerufen. Die Anzahl der Entitäten auf dieser Seite wird durch page_size definiert.
page_size	meta.page_size	integer	Die Anzahl der Entitäten, die auf dieser Seite angezeigt werden.
total_items	meta.total_items	integer	Die Anzahl der in der Datenbank verfügbaren Entitäten, unabhängig von der Seitengröße oder -zahl. Um die anderen Seiten anzuzeigen, ändern Sie die Seitenzahl in der Anforderung.
items	items	array of object	Liste der Tagentitäten, die von der Textanforderung abgerufen werden.
id	items.id	string	Die numerische ID des Tags.
tag_color	items.tag_color	string	Die Farbe des Tags. Dies sollte ein gültiger Hexadezimalfarbcode sein.
tag	items.tag	string	Der Name des Tags.

Ruft alle Unterhaltungen für dieses Dashboard ab.

Vorgangs-ID:

GetConversations

Ruft alle Unterhaltungen für dieses Dashboard ab und enthält Informationen zur letzten Nachricht für jede Unterhaltung.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Kontakttags	tags		string	Durch Trennzeichen getrennte Liste von GUIDs, die auf Tags verweisen, nach denen Unterhaltungen gefiltert werden sollen.
Gibt an, ob nur aufgelöste Unterhaltungen angezeigt werden sollen	show_unresolved_only		string	Gibt an, ob nur nach Kontakten gesucht werden soll, deren Unterhaltungen aufgelöst wurden. Wenn dies "false" ist, werden sowohl aufgelöste als auch nicht aufgelöste Unterhaltungen angezeigt.
Gibt an, ob archivierte Unterhaltungen einbezogen werden sollen.	include_archived		string	Gibt an, ob Unterhaltungen mit archivierten Kontakten einbezogen werden sollen.
Ausdruck, nach dem nach Telefonnummern und Kontaktnamen gefiltert werden soll	search		string	Suchbegriff zum Filtern von Unterhaltungen nach Telefonnummer oder Anzeigename. Wenn der Suchbegriff kleiner als ein vollständiger Name oder eine vollständige Telefonnummer ist, gibt die Suche alle Unterhaltungen zurück, die teilweise übereinstimmen.
Seitenzahl, die abgerufen werden soll	page		integer	Die Seite der abzurufenden Entitäten. Beim Abrufen von Werten gibt es eine maximale Größe pro Seite, die durch page_size definiert wird. Wenn die Seite größer als die letzte Seite ist, wird ein leeres Array zurückgegeben.
Anzahl der einzelnen Entitäten, die pro Seite abgerufen werden sollen	page_size		integer	Die Größe jeder seite, die abgerufen werden soll. Beim Abrufen von Werten ist dies eine maximale Größe pro Seite, wobei der Zugriff auf nachfolgende Seiten durch den Seitenparameter erfolgt.
ID des Dashboards, an dem dieser Aufruf ausgeführt werden soll	dashboard_id	True	integer	Das Telefonnummerndashboard, an dem gearbeitet werden soll. Ein einzelnes Konto kann über mehrere Dashboards verfügen, die unterschiedliche Telefonleitungen für Kunden darstellen.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Seite	meta.page	integer	Die Seite der Entitäten wird abgerufen. Die Anzahl der Entitäten auf dieser Seite wird durch page_size definiert.
page_size	meta.page_size	integer	Die Anzahl der Entitäten, die auf dieser Seite angezeigt werden.
total_items	meta.total_items	integer	Die Anzahl der in der Datenbank verfügbaren Entitäten, unabhängig von der Seitengröße oder -zahl. Um die anderen Seiten anzuzeigen, ändern Sie die Seitenzahl in der Anforderung.
items	items	array of object	Liste der Unterhaltungsentitäten, die von der Textanforderung abgerufen werden.
phone_number	items.phone_number	string	Die Telefonnummer des Kontakts.
message_id	items.last_message.message_id	string	ID der Nachricht. Dieser Wert ist für jede Nachricht eindeutig.
body	items.last_message.body	string	Inhalt dieser Nachricht.
message_direction	items.last_message.message_direction	string	Singular-Zeichen, entweder R oder S, gibt an, ob diese Nachricht vom Kontakt empfangen oder an sie gesendet wurde.
response_by_username	items.last_message.response_by_username	string	Benutzername des Benutzers der Textanforderung, der zuletzt eine Nachricht an diesen Benutzer gesendet hat.
message_timestamp_utc	items.last_message.message_timestamp_utc	string	Zeitstempel des Zeitpunkts, zu dem die Nachricht von der Textanforderung gesendet oder empfangen wurde.
delivery_status	items.last_message.delivery_status	string	Aktueller Status dieser Nachricht. Dies kann "senden", "übermittelt", "Fehler" oder "Senden" sein.
delivery_error	items.last_message.delivery_error	string	Fehler, der dazu führte, dass diese Nachricht nicht zugestellt wurde. Wenn der delivery_status nicht "error" ist, ist dieser Wert null.
mms_media	items.last_message.mms_media	array of string	Liste der URLs, die auf die Anlagen dieser Nachricht verweisen. Alle URLs werden von Textanforderung generierte URLs sein.

Ruft alle Zahlungen ab

Vorgangs-ID:

GetPayments

Ruft alle Zahlungen ab, einschließlich stornierter und bezahlter Zahlungen. Diese können mithilfe der Abfrageparameter gefiltert werden.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Referenzzeichenfolge der Zahlung	reference_number		string	Benutzerdefinierte ID, die beim Erstellen von Zahlungen definiert ist, die verwendet werden können, um Zahlungen schnell zu finden. Referenznummern sind nicht eindeutig; viele Zahlungen können denselben Bezug haben.
Telefonnummer für Zahlungen	phone_number		string	Telefonnummer des Kontakts, an den diese Zahlung gesendet wurde.
Sortieren nach	sort_type		string	Eigenschaft zum Sortieren von Zahlungen nach. Kann "amount", "contact", "date", "status" sein.
Sortierrichtung	sort_direction		string	Richtung zum Sortieren von Zahlungen in. Kann "desc" für den größten bis kleinsten oder "asc" für den kleinsten bis größten sein.
Seitenzahl, die abgerufen werden soll	page	True	integer	Die Seite der abzurufenden Entitäten. Beim Abrufen von Werten gibt es eine maximale Größe pro Seite, die durch page_size definiert wird. Wenn die Seite größer als die letzte Seite ist, wird ein leeres Array zurückgegeben.
Anzahl der einzelnen Entitäten, die pro Seite abgerufen werden sollen	page_size	True	integer	Die Größe jeder seite, die abgerufen werden soll. Beim Abrufen von Werten ist dies eine maximale Größe pro Seite, wobei der Zugriff auf nachfolgende Seiten durch den Seitenparameter erfolgt.
ID des Dashboards, an dem dieser Aufruf ausgeführt werden soll	dashboard_id	True	integer	Das Telefonnummerndashboard, an dem gearbeitet werden soll. Ein einzelnes Konto kann über mehrere Dashboards verfügen, die unterschiedliche Telefonleitungen für Kunden darstellen.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Seite	meta.page	integer	Die Seite der Entitäten wird abgerufen. Die Anzahl der Entitäten auf dieser Seite wird durch page_size definiert.
page_size	meta.page_size	integer	Die Anzahl der Entitäten, die auf dieser Seite angezeigt werden.
total_items	meta.total_items	integer	Die Anzahl der in der Datenbank verfügbaren Entitäten, unabhängig von der Seitengröße oder -zahl. Um die anderen Seiten anzuzeigen, ändern Sie die Seitenzahl in der Anforderung.
items	items	array of object	Liste der Zahlungsentitäten, die von der Textanforderung abgerufen wurden.
payment_id	items.payment_id	integer	Die numerische ID der Zahlung.
request_date	items.request_date	string	Der Zeitstempel, zu dem die erste Nachricht dieser Zahlung in die Warteschlange gestellt wurde, die gesendet werden soll.
recipient	items.recipient	string	Der Name des Zahlungsempfängers. Dies kann null sein, wenn der Kontakt keinen Namen hat, der mit seiner Telefonnummer verknüpft ist.
Beschreibung	items.description	string	Die Beschreibung der Zahlung. Dies wird dem Kontakt nicht angezeigt. Es wird nur von internen Benutzern für kontextbezogene Zahlungen verwendet.
customer_phone	items.customer_phone	string	Die Telefonnummer des Kontakts, der diese Zahlung gesendet wird.
amount_requested	items.amount_requested	float	Der Betrag in Dollar, der von dieser Zahlung angefordert wird.
is_past_due	items.is_past_due	boolean	Gibt an, ob diese Zahlung über das Anforderungsdatum liegt.
reminder_was_sent	items.reminder_was_sent	boolean	Gibt an, ob für diese Zahlung bereits eine Texterinnerung gesendet wurde.
transaction_status	items.transaction_status	string	Der Status der Transaktion in authvia. Dieser Wert beginnt als Unbekannt.
textrequest_payment_status	items.textrequest_payment_status	string	Der Status der Transaktion in der Textanforderung. Dies stellt den Status dar, der auf der Seite "Zahlungen" in der Textanforderungs-App angezeigt wird. Sie beginnt als gesendet.
reference_number	items.reference_number	string	Die benutzerdefinierte ID, die beim Erstellen von Zahlungen definiert ist, die verwendet werden können, um Zahlungen schnell zu finden. Referenznummern sind nicht eindeutig; viele Zahlungen können denselben Bezug haben.

Ruft den Kontakt mit der angegebenen Telefonnummer ab.

Vorgangs-ID:

GetContactByPhoneNumber

Ruft den Kontakt mit der angegebenen Telefonnummer ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID des Dashboards, an dem dieser Aufruf ausgeführt werden soll	dashboard_id	True	integer	Das Telefonnummerndashboard, an dem gearbeitet werden soll. Ein einzelnes Konto kann über mehrere Dashboards verfügen, die unterschiedliche Telefonleitungen für Kunden darstellen.
Telefonnummer des Kontakts	phone_number	True	string	Telefonnummer des kontakts, der abgerufen werden soll.

Gibt zurück

Name	Pfad	Typ	Beschreibung
phone_number	phone_number	string	Telefonnummer dieses Kontakts.
first_name	first_name	string	Vorname dieses Kontakts.
last_name	last_name	string	Nachname dieses Kontakts.
display_name	display_name	string	Vollständiger Name dieses Kontakts. Dies ist der Standardname, der in der Web-App beim Anzeigen von Kontakten angezeigt wird.
is_suppressed	is_suppressed	boolean	Gibt an, ob die Unterhaltung mit diesem Kontakt unterdrückt wird und daher beim Empfang nicht an den Anfang der Nachrichtenwarteschlange verschoben wird.
is_archived	is_archived	boolean	Gibt an, ob die Unterhaltung mit diesem Kontakt archiviert ist und daher beim Abfragen von Unterhaltungen (standardmäßig) nicht angezeigt wird.
is_blocked	is_blocked	boolean	Gibt an, ob die Unterhaltung mit diesem Kontakt blockiert und daher nicht empfangen oder gespeichert wird.
suppressed_reason	suppressed_reason	string	Ausdruck, der den Grund für die Unterdrückung des Kontakts beschreibt. Wenn is_suppressed falsch ist, ist dies null.
Anmerkung	note	string	Kurzer Ausdruck zur Beschreibung des Kontakts. Wird zur Vereinfachung verwendet. Dies wird niemals dem Kontakt angezeigt.
Gruppen	groups	array of integer	Array von ganzzahligen IDs, die auf Gruppen verweisen, zu der dieser Kontakt gehört.
contact_tags	contact_tags	array of string	Array von GUIDs, die auf Tags verweisen, die an diesen Kontakt angefügt sind.
custom_fields	custom_fields	array of object	Array von benutzerdefinierten Feld-IDs und Werten, die für diesen Kontakt definiert sind.
id	custom_fields.id	string	Guid, die auf ein benutzerdefiniertes Feld verweist.
value	custom_fields.value	string	Der Wert dieses Kontakts für dieses benutzerdefinierte Feld.
is_resolved	is_resolved	boolean	Gibt an, ob die Unterhaltung mit diesem Kontakt aufgelöst wird. Alle neuen Texte, die von diesem Kontakt empfangen werden, legen diesen False fest.
first_contact_utc	first_contact_utc	string	Zeitstempel des Zeitpunkts, zu dem die erste Nachricht an diesen Kontakt gesendet wurde.
opted_out_utc	opted_out_utc	string	Zeitstempel, zu dem sich dieser Kontakt für den Empfang von Nachrichten abgemeldet hat.
last_msg_sent_utc	last_msg_sent_utc	string	Zeitstempel des Zeitpunkts, zu dem die letzte Nachricht an diesen Kontakt gesendet wurde.
last_msg_received_utc	last_msg_received_utc	string	Zeitstempel des Zeitpunkts, zu dem die letzte Nachricht von diesem Kontakt empfangen wurde.
total_msgs_sent	total_msgs_sent	integer	Die Anzahl der an diesen Kontakt gesendeten Nachrichten.
total_msgs_received	total_msgs_received	integer	Die Anzahl der nachrichten, die von diesem Kontakt empfangen wurden.
response_count	response_count	integer	Die Gesamtzahl der Antwortnachrichten des Kontakts.
date_created_utc	date_created_utc	string	Der Zeitstempel der Erstellung des ths-Kontakts.
last_contact_date_utc	last_contact_date_utc	string	Der Zeitstempel, zu dem die letzte Nachricht von diesem Kontakt gesendet oder empfangen wurde.
message_id	last_message.message_id	string	ID der Nachricht. Dieser Wert ist für jede Nachricht eindeutig.
body	last_message.body	string	Inhalt dieser Nachricht.
message_direction	last_message.message_direction	string	Singular-Zeichen, entweder R oder S, gibt an, ob diese Nachricht vom Kontakt empfangen oder an sie gesendet wurde.
response_by_username	last_message.response_by_username	string	Benutzername des Benutzers der Textanforderung, der zuletzt eine Nachricht an diesen Benutzer gesendet hat.
message_timestamp_utc	last_message.message_timestamp_utc	string	Zeitstempel des Zeitpunkts, zu dem die Nachricht von der Textanforderung gesendet oder empfangen wurde.
delivery_status	last_message.delivery_status	string	Aktueller Status dieser Nachricht. Dies kann "senden", "übermittelt", "Fehler" oder "Senden" sein.
delivery_error	last_message.delivery_error	string	Fehler, der dazu führte, dass diese Nachricht nicht zugestellt wurde. Wenn der delivery_status nicht "error" ist, ist dieser Wert null.
mms_media	last_message.mms_media	array of string	Liste der URLs, die auf die Anlagen dieser Nachricht verweisen. Alle URLs werden von Textanforderung generierte URLs sein.

Ruft die Zahlung mit der angegebenen ID ab.

Vorgangs-ID:

GetPayment

Ruft die Zahlung mit der angegebenen ID ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID des Dashboards, an dem dieser Aufruf ausgeführt werden soll	dashboard_id	True	integer	Das Telefonnummerndashboard, an dem gearbeitet werden soll. Ein einzelnes Konto kann über mehrere Dashboards verfügen, die unterschiedliche Telefonleitungen für Kunden darstellen.
ID der Zahlung	payment_id	True	integer	Die numerische ID der zu erhaltenden Zahlung.

Gibt zurück

Name	Pfad	Typ	Beschreibung
payment_id	payment_id	integer	Die numerische ID der Zahlung.
request_date	request_date	string	Der Zeitstempel, zu dem die erste Nachricht dieser Zahlung in die Warteschlange gestellt wurde, die gesendet werden soll.
recipient	recipient	string	Der Name des Zahlungsempfängers. Dies kann null sein, wenn der Kontakt keinen Namen hat, der mit seiner Telefonnummer verknüpft ist.
Beschreibung	description	string	Die Beschreibung der Zahlung. Dies wird dem Kontakt nicht angezeigt. Es wird nur von internen Benutzern für kontextbezogene Zahlungen verwendet.
customer_phone	customer_phone	string	Die Telefonnummer des Kontakts, der diese Zahlung gesendet wird.
amount_requested	amount_requested	float	Der Betrag in Dollar, der von dieser Zahlung angefordert wird.
is_past_due	is_past_due	boolean	Gibt an, ob diese Zahlung über das Anforderungsdatum liegt.
reminder_was_sent	reminder_was_sent	boolean	Gibt an, ob für diese Zahlung bereits eine Texterinnerung gesendet wurde.
transaction_status	transaction_status	string	Der Status der Transaktion in authvia. Dieser Wert beginnt als Unbekannt.
textrequest_payment_status	textrequest_payment_status	string	Der Status der Transaktion in der Textanforderung. Dies stellt den Status dar, der auf der Seite "Zahlungen" in der Textanforderungs-App angezeigt wird. Sie beginnt als gesendet.
reference_number	reference_number	string	Die benutzerdefinierte ID, die beim Erstellen von Zahlungen definiert ist, die verwendet werden können, um Zahlungen schnell zu finden. Referenznummern sind nicht eindeutig; viele Zahlungen können denselben Bezug haben.

Senden einer Nachricht an den Kontakt mit der angegebenen Telefonnummer

Vorgangs-ID:

SendMessageByPhoneNumber

Sendet eine Nachricht (starte eine neue Unterhaltung, wenn die angegebene Telefonnummer keinen Nachrichtenverlauf hat).

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID des Dashboards, an dem dieser Aufruf ausgeführt werden soll	dashboard_id	True	integer	Das Telefonnummerndashboard, an dem gearbeitet werden soll. Ein einzelnes Konto kann über mehrere Dashboards verfügen, die unterschiedliche Telefonleitungen für Kunden darstellen.
Telefonnummer an Nachricht	phone_number	True	string	Telefonnummer des Kontakts, an den eine Nachricht gesendet werden soll.
Nachrichtentext	body		string	Inhalt der zu sendenden Nachricht.
Name des Absenders	sender_name		string	Der Name des Absenders der Nachricht. Dies wird in der TextRequest-Web-App und der API beim Abrufen dieser Nachricht angezeigt.
Rückruf-URL für den Status der Nachricht	status_callback		string	Url für die Web-App, die mit einem POST-Befehl erreicht werden soll, wenn der Status dieser Nachricht von "Nicht gesendet" (oder "Fehler") gesendet wird.
Rückruf-URL für Standortanforderungen, wenn diese Nachricht eine enthält	location_callback		string	Url des Speicherortrückrufs, um mit einem POST-Befehl zu treffen, wenn der Benutzer auf den Standort des Absenders zugreift und genehmigt. Um den Link einzuschließen, fügen Sie dem Nachrichtentext [Standortanforderung] hinzu. Dieser Rückruf ist für Standortanforderungen nicht erforderlich, kann aber für APIs nützlich sein.
MMS-Medienanlagen für diese Nachricht	mms_media		array of string	Array von MMS-Medienanlagen für diese Nachricht. Anlagen müssen URLs sein, die vom Post/mms-Endpunkt abgerufen werden (nicht in diesem Connector enthalten). Externe Anlagenlinks werden nicht akzeptiert.

Gibt zurück

Name	Pfad	Typ	Beschreibung
message_id	message_id	string	ID der Nachricht. Dieser Wert ist für jede Nachricht eindeutig.
body	body	string	Inhalt dieser Nachricht.
message_direction	message_direction	string	Singular-Zeichen, entweder R oder S, gibt an, ob diese Nachricht vom Kontakt empfangen oder an sie gesendet wurde.
response_by_username	response_by_username	string	Benutzername des Benutzers der Textanforderung, der zuletzt eine Nachricht an diesen Benutzer gesendet hat.
message_timestamp_utc	message_timestamp_utc	string	Zeitstempel des Zeitpunkts, zu dem die Nachricht von der Textanforderung gesendet oder empfangen wurde.
delivery_status	delivery_status	string	Aktueller Status dieser Nachricht. Dies kann "senden", "übermittelt", "Fehler" oder "Senden" sein.
delivery_error	delivery_error	string	Fehler, der dazu führte, dass diese Nachricht nicht zugestellt wurde. Wenn der delivery_status nicht "error" ist, ist dieser Wert null.
mms_media	mms_media	array of string	Liste der URLs, die auf die Anlagen dieser Nachricht verweisen. Alle URLs werden von Textanforderung generierte URLs sein.

Senden eines Nachverfolgungstexts, der den Benutzer daran erinnert, die angegebene Zahlung zu bezahlen

Vorgangs-ID:

SendPaymentReminder

Sendet eine Erinnerung an den Kontakt, um die angegebene Zahlung zu bezahlen. Der Inhalt der Nachricht wird automatisch generiert. Um Spam zu vermeiden, kann pro Zahlung nur eine Erinnerung gesendet werden.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID des Dashboards, an dem dieser Aufruf ausgeführt werden soll	dashboard_id	True	integer	Das Telefonnummerndashboard, an dem gearbeitet werden soll. Ein einzelnes Konto kann über mehrere Dashboards verfügen, die unterschiedliche Telefonleitungen für Kunden darstellen.
ID der Zahlung	payment_id	True	integer	Die numerische ID der zu aktualisierenden Zahlung.

Gibt zurück

Name	Pfad	Typ	Beschreibung
payment_id	payment_id	integer	Die numerische ID der Zahlung.
request_date	request_date	string	Der Zeitstempel, zu dem die erste Nachricht dieser Zahlung in die Warteschlange gestellt wurde, die gesendet werden soll.
recipient	recipient	string	Der Name des Zahlungsempfängers. Dies kann null sein, wenn der Kontakt keinen Namen hat, der mit seiner Telefonnummer verknüpft ist.
Beschreibung	description	string	Die Beschreibung der Zahlung. Dies wird dem Kontakt nicht angezeigt. Es wird nur von internen Benutzern für kontextbezogene Zahlungen verwendet.
customer_phone	customer_phone	string	Die Telefonnummer des Kontakts, der diese Zahlung gesendet wird.
amount_requested	amount_requested	float	Der Betrag in Dollar, der von dieser Zahlung angefordert wird.
is_past_due	is_past_due	boolean	Gibt an, ob diese Zahlung über das Anforderungsdatum liegt.
reminder_was_sent	reminder_was_sent	boolean	Gibt an, ob für diese Zahlung bereits eine Texterinnerung gesendet wurde.
transaction_status	transaction_status	string	Der Status der Transaktion in authvia. Dieser Wert beginnt als Unbekannt.
textrequest_payment_status	textrequest_payment_status	string	Der Status der Transaktion in der Textanforderung. Dies stellt den Status dar, der auf der Seite "Zahlungen" in der Textanforderungs-App angezeigt wird. Sie beginnt als gesendet.
reference_number	reference_number	string	Die benutzerdefinierte ID, die beim Erstellen von Zahlungen definiert ist, die verwendet werden können, um Zahlungen schnell zu finden. Referenznummern sind nicht eindeutig; viele Zahlungen können denselben Bezug haben.

Auslöser

Löst aus, wenn ein Text gesendet oder empfangen wird

Löst aus, wenn ein Text gesendet oder empfangen wird

Löst aus, wenn ein Text gesendet oder empfangen wird

Vorgangs-ID:

TextingWebhook

Löst aus, wenn ein Text gesendet oder empfangen wird

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Dashboard, von dem der Auslöser ereignisse lauscht	dashboard_id	True	string	ID des Dashboards, dem Trigger hinzugefügt werden soll
Ereignis	event	True	string	Ereignis

Gibt zurück

Name	Pfad	Typ	Beschreibung
Eindeutige Id der Nachricht	messageUniqueIdentifier	string	messageUniqueIdentifier
Konto-ID	account.id	integer	id
Unterhaltungs-ID	yourPhoneNumber.id	integer	id
Dashboardname	yourPhoneNumber.description	string	Beschreibung
Dashboardtelefonnummer	yourPhoneNumber.phoneNumber	string	Telefonnummer
Dashboard-ID	conversation.id	integer	id
date	conversation.date	string	date
Telefonnummer des Kontakts	conversation.consumerPhoneNumber	string	consumerPhoneNumber
messageDirection	conversation.messageDirection	string	messageDirection
message	conversation.message	string	message
numSegments	conversation.numSegments	integer	numSegments
status	conversation.status	string	status
Unterhaltung, die von	conversation.claimedBy	string	anspruchsgefordert Von
Anzeigename des Kontakts	conversation.consumerFriendlyName	string	consumerFriendlyName

Definitionen

Schnur

Dies ist der grundlegende Datentyp "string".