Żądanie tekstowe

Żądanie tekstowe to platforma do obsługi tekstu biznesowego utworzona w celu zainicjowania zaangażowania klientów. Utworzyliśmy rozwiązanie do obsługi komunikatów typu plug-and-play na potrzeby codziennych problemów z komunikacją, dzięki czemu możesz przeciąć hałas i połączyć się z klientami w dowolnym miejscu i czasie. Dowiedz się więcej o tym, jak pomagamy zajętym liderom biznesowym.

Ten łącznik jest dostępny w następujących produktach i regionach:

Usługa	Class	Regions
Copilot Studio	Premium	Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD)
Logic Apps	Standard	Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: — Regiony platformy Azure Government — Regiony platformy Azure (Chiny) - Departament Obrony USA (DoD)
Power Apps	Premium	Wszystkie regiony usługi Power Apps z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD)
Power Automate	Premium	Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD)

Kontakt
Name	Obsługa interfejsu API żądań tekstowych
adres URL	https://www.textrequest.com/contact
Email	apidev@textrequest.com

Metadane łącznika
Publisher	Żądanie tekstowe
Witryna internetowa	https://www.textrequest.com/
Zasady ochrony prywatności	https://www.textrequest.com/privacy-policy/
Kategorie	Komunikacja; Sprzedaż i CRM

Pakiet Aranda Service Management Suite (ASMS)

Zwiększ produktywność firmy i przekształć środowisko użytkowników dzięki pakietowi Aranda Service Management Suite, rozwiązaniu wielodostępnemu, które umożliwia zarządzanie, integrowanie i automatyzowanie procesów biznesowych i usług. Twórz, wyszukuj i aktualizuj rekordy przechowywane w dowolnym obszarze roboczym (projekcie) usługi ASMS, w tym zdarzenia, wymagania i zmiany.

Pre-requisites

Pamiętaj o następujących wymaganiach wstępnych, aby kontynuować:

Subskrypcja i wystąpienie pakietu Aranda Service Management Suite (ASMS). Zacznij tutaj: https://arandasoft.com/
Aktywna subskrypcja usługi Microsoft Power Automate z funkcjami łącznika Premium.

Uzyskiwanie poświadczeń

Aby przeprowadzić uwierzytelnianie, użyj tokenu integracji. W poniższym linku znajdziesz informacje na temat uzyskiwania tokenu integracji

Wprowadzenie do łącznika

Wymaga subskrypcji pakietu Aranda Service Management Suite (ASMS).
Uzyskiwanie tokenu integracji
Pobierz adres URL wystąpienia interfejsu API ASMS zarządzania usługami Aranda (ApiAsms).
Ustanów połączenie z łącznikiem Aranda Service Management Suite.
Wybierz jedną z następujących funkcji oferowanych przez łącznik:
Aby uzyskać szczegółową dokumentację dotyczącą łącznika, zapoznaj się z artykułem https://docs.arandasoft.com/connectors

Tego łącznika można używać w następujących przypadkach:

Tworzenie, wyszukiwanie i aktualizowanie biletów, między innymi dostępnych akcji.
Uzyskaj możliwość śledzenia biletu.
Pobierz załączniki związane z biletem.
Wyszukaj artykuły z bazy wiedzy (KB) w pakiecie Aranda Service Management Suite.
Pobierz załączniki z artykułów bazy wiedzy (KB).
Tworzenie, wyszukiwanie i aktualizowanie elementów konfiguracji (CI).
Dzięki niej organizacje mogą rozwiązywać wewnętrzne żądania pomocy technicznej, zarządzać i usprawniać proces rozwiązywania problemów technicznych.
Umożliwia śledzenie komunikacji między osoby żądające i agentami pomocy technicznej.
Zaoferuj automatyczne odpowiedzi, aby poinformować osoby żądających o stanie biletu.

Odpowiedź pomyślna

Code	Name	Description
200	OK	Żądanie zakończyło się pomyślnie
204	Brak treści	W żądaniu nie znaleziono żadnych danych

Typowe błędy i środki zaradcze

Code	Name	Description	Rozwiązanie
400	NieprawidłoweŻądanie	KryteriaNeedsSomeArguments	Sprawdź, czy parametry wyszukiwania nie są puste
400	NieprawidłoweŻądanie	InvalidAdditionalFieldId	Sprawdź, czy identyfikatory dodatkowych pól są poprawne
400	NieprawidłoweŻądanie	InvalidItemType	Typ sprawy jest niepoprawny, zmień identyfikator typu sprawy
400	NieprawidłoweŻądanie	Nieprawidłowy identyfikator projektu	Identyfikator projektu jest niepoprawny, zmień identyfikator projektu, do którego skojarzysz przypadek
400	NieprawidłoweŻądanie	InvalidStateId	Sprawdzanie stanu dodanego podczas tworzenia lub aktualizowania biletu
400	NieprawidłoweŻądanie	InvalidUploadType	Wystąpił błąd podczas dołączania pliku. Zażądaj pomocy od administratora systemu
400	NieprawidłoweŻądanie	RequestNeedsSomeArguments	Sprawdź wymagane pola biletu i dodaj odpowiednią wartość w łączniku
400	NieprawidłoweŻądanie	SearchListIsRequired	Zażądaj pomocy od administratora systemu
400	NieprawidłoweŻądanie	Nazwa parametru: {Nazwa parametru}	Sprawdź, czy właściwości wymienione w błędzie nie mają wartości null
400	NieprawidłoweŻądanie	Jest nazwą parametru null: {Name parameter}	Sprawdź, czy właściwości wymienione w błędzie nie mają wartości null
400	NieprawidłoweŻądanie	ItemTypeIsRequired	Dodaj typ wielkości liter
400	NieprawidłoweŻądanie	ModelIdIsEmpty	Dodaj parametr modelId. Jest to wymagane.
400	NieprawidłoweŻądanie	StateIdIsEmpty	Dodaj parametr stateId. Jest to wymagane.
400	NieprawidłoweŻądanie	ServiceIdIsEmpty	Dodaj parametr serviceId. Jest to wymagane.
400	NieprawidłoweŻądanie	CategoryIdIsEmpty	Dodaj parametr categoryId. Jest to wymagane.
400	NieprawidłoweŻądanie	TypesListNeedsSomeArguments	Wymaga dodania typu przypadku podczas wyszukiwania biletów, zażądaj pomocy od administratora systemu
400	NieprawidłoweŻądanie	Dodatkowe Pola "{PARAMETER_NAME}"Wymagane	Dodatkowe pole "{PARAMETER_NAME}" jest obowiązkowe
400	NieprawidłoweŻądanie	ModelNotActive	Model skojarzony z przypadkiem nie jest aktywny
400	NieprawidłoweŻądanie	FailedToCloseTaskPendingCloseTasksPredecessors	Jeśli spróbujesz zamknąć sprawę, a przypadek nadrzędny ma oczekujące zadania do zamknięcia
400	NieprawidłoweŻądanie	Zduplikowany obiekt	Ciągła integracja już istnieje w bazie danych
400	NieprawidłoweŻądanie	Nazwa parametru EmptyValue: {PARAMETER_NAME}	Wymagany jest parametr {PARAMETER_NAME}
400	NieprawidłoweŻądanie	EmptyEnumeration Nazwa parametru: {PARAMETER_NAME}	Parametr {PARAMETER_NAME} jest listą i jest wymagany
403	Zakazany	DoNotHavePermissionForThisAction	Skontaktuj się z administratorem systemu, aby przypisać uprawnienia

Code	Name	Description	Rozwiązanie
500	Błąd Wewnętrzny Serwera		Zażądaj pomocy od administratora systemu
500	Błąd Wewnętrzny Serwera	FailureExportExcel	Zażądaj pomocy od administratora systemu
500	Błąd Wewnętrzny Serwera	FailureGetAdditionalFields	Zażądaj pomocy od administratora systemu
500	Błąd Wewnętrzny Serwera	FailureGetCategoriesByService	Zażądaj pomocy od administratora systemu
500	Błąd Wewnętrzny Serwera	FailureGetChangeFSC	Zażądaj pomocy od administratora systemu
500	Błąd Wewnętrzny Serwera	FailureGetFields	Zażądaj pomocy od administratora systemu
500	Błąd Wewnętrzny Serwera	FailureGetFieldsList	Zażądaj pomocy od administratora systemu
500	Błąd Wewnętrzny Serwera	FailureGetFiles	Zażądaj pomocy od administratora systemu
500	Błąd Wewnętrzny Serwera	FailureGetLookupValues	Zażądaj pomocy od administratora systemu
500	Błąd Wewnętrzny Serwera	FailureGetMailTemplates	Zażądaj pomocy od administratora systemu
500	Błąd Wewnętrzny Serwera	FailureGetModelByCategory	Zażądaj pomocy od administratora systemu
500	Błąd Wewnętrzny Serwera	FailureGetOperators	Zażądaj pomocy od administratora systemu
500	Błąd Wewnętrzny Serwera	FailureGetReassignmentReasons	Zażądaj pomocy od administratora systemu
500	Błąd Wewnętrzny Serwera	FailureGetSimilarItems	Zażądaj pomocy od administratora systemu
500	Błąd Wewnętrzny Serwera	FailureSearchQuickManagement	Zażądaj pomocy od administratora systemu

Często zadawane pytania

Jak pobrać identyfikatory atrybutów wymaganych do korzystania z różnych akcji w łączniku (np. projekt, usługa, kategoria, grupa, specjalista)?

Identyfikatory można pobrać na wiele sposobów:
- Za pomocą programu Aranda Query Manager można utworzyć raport, który wysyła zapytania do tabeli Aranda Service Management Suite (ASMS), w której znajdują się wymagane dane. Jeśli potrzebujesz wskazówek dotyczących obiektów danych w rozwiązaniu, odwiedź poniższy link https://docs.arandasoft.com/docs/database.html i zidentyfikuj wersję bazy danych Aranda odpowiadającą instalacji usługi ASMS.
- Jeśli używasz instalacji lokalnej usługi ASMS, możesz wykonać zapytanie dotyczące tabeli ASMS, w której znajdują się wymagane dane za pośrednictwem klienta SQL.
- Za pośrednictwem Centrum pomocy technicznej usługi Aranda utwórz wniosek o pomoc techniczną za pośrednictwem kanałów kontaktowych wskazanych w poniższej witrynie internetowej Pomocy technicznej.
Jaki jest maksymalny rozmiar plików do dołączenia w przypadku korzystania z akcji "Dodaj załącznik"?

Maksymalny rozmiar zależy od określonej konfiguracji wystąpienia/instalacji usługi ASMS. Poproś administratora usługi ASMS.
Jaki jest poziom dostępu do danych wymagany przez konto technika, którego token jest używany w konfiguracji połączenia USŁUGI ASMS wymaganego przez łącznik?

Poziom dostępu jest taki sam jak konto technika używane w usłudze ASMS w regularnych odstępach czasu. Innymi słowy, na podstawie ról i uprawnień odpowiedniego technika w usłudze ASMS, dostęp do danych można uzyskać za pomocą łącznika.
Czy konto technika, którego token będzie używany w łączniku ma nazwę lub współbieżne?

Ponieważ łącznik może uzyskać dostęp do powiązanego wystąpienia usługi ASMS wiele razy na godzinę, zdecydowanie zaleca się, aby konto było typem nazwanym.
Czy tworzenie lub modyfikowanie przypadków przy użyciu łącznika jest zgodne z tymi samymi regułami sprawdzania poprawności danych w interfejsie usługi ASMS?

Tak, jest to zgodne z tymi samymi regułami walidacji. Na przykład podczas tworzenia przypadku dla określonego projektu, usługi i kategorii, jeśli należy wypełnić pola natywne i dodatkowe, te dane są również wymagane podczas przesyłania sprawy za pośrednictwem łącznika.
Czy łącznik może być używany dla wystąpień usługi ASMS w środowiskach chmurowych i lokalnych?

Tak, można go używać zarówno w instalacjach chmurowych, jak i lokalnych usługi ASMS. W instalacjach lokalnych należy wziąć pod uwagę łączność między serwerem ASMS i środowiskiem usługi Power Automate.
Mam licencję usługi Power Automate, która umożliwia korzystanie tylko z łączników w warstwie Standardowa. Czy mogę użyć łącznika usługi ASMS?

Nie jest możliwe, łącznik ASMS jest typem Premium.
Chcę utworzyć przepływy w usłudze Power Automate, które zaczynają się od zdarzeń w usłudze ASMS (np. w przypadku utworzenia przypadku, gdy przypadek zostanie przypisany do określonej grupy). Czy można użyć wyzwalaczy rozpoczynających się od zdarzeń występujących w usłudze ASMS?

Tak, możliwe jest. Zalecane są następujące kroki:
- Zainicjuj wyzwalacz "Po odebraniu żądania HTTP" i utwórz schemat JSON treści żądania zawierający strukturę danych, która ma zostać odebrana z usługi ASMS. Po utworzeniu wyzwalacza otrzymasz adres URL HTTP POST (adres URL elementu webhook) do użycia w wystąpieniu usługi ASMS. Nie zapomnij rozważyć mechanizmu uwierzytelniania w celu uzyskania dostępu do adresu URL elementu webhook (np. tokenu).
- Utwórz regułę biznesową w usłudze ASMS dla zestawu warunków, które po spełnieniu powinny zainicjować przepływ w usłudze Power Automate. Jako akcję w regule wybierz pozycję "Wywołaj element webhook" i w docelowym adresie URL wywołania wprowadź wcześniej uzyskany adres URL elementu WebHook, parametry do wysłania i treść żądania (które muszą być zgodne ze schematem JSON treści żądania). Aby uzyskać więcej informacji na temat wywoływania elementu webhook z reguły w usłudze ASMS, odwiedź następujący link: Reguła elementu webhook
- Przetestuj utworzoną regułę i sprawdź, czy żądanie HTTP jest wysyłane do adresu URL elementu webhook i inicjuje przepływ w usłudze Power Automate.
Czy można wywoływać punkty końcowe interfejsu API REST usługi ASMS jako akcje z przepływów w usłudze Power Automate?

Tak, możliwe jest. Użyj akcji "HTTP" i wypełnij wymagane dane (między innymi identyfikator URI, metoda, nagłówki, treść).

Tworzenie połączenia

Łącznik obsługuje następujące typy uwierzytelniania:


Wartość domyślna	Parametry tworzenia połączenia.	Wszystkie regiony	Nie można udostępniać

Domyślny

Dotyczy: wszystkie regiony

Parametry tworzenia połączenia.

Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.

Name	Typ	Description	Wymagane
Klucz interfejsu API	securestring	Klucz interfejsu API dla tego interfejsu API	Prawda

Limity ograniczania

Nazwa	Wywołania	Okres odnowienia
Wywołania interfejsu API na połączenie	100	60 sekund

Akcje

Aktualizowanie nazwy określonego pulpitu nawigacyjnego	Aktualizuje pulpit nawigacyjny. Nie zmienia to numeru telefonu pulpitu nawigacyjnego. Jeśli chcesz utworzyć nowy numer z kontaktami innego pulpitu nawigacyjnego, musisz utworzyć nowy pulpit nawigacyjny przy użyciu wpisu POST i dodać kontakty z eksportem/importowaniem zbiorczym.
Aktualizuje grupę o danym identyfikatorze	Aktualizuje nazwę grupy przy użyciu identyfikatora liczbowego grupy. Jeśli przekazany identyfikator grupy nie istnieje, wywołanie zakończy się niepowodzeniem.
Anuluje określoną płatność	Anuluje określoną płatność, sms-ując użytkownika, że płatność została anulowana. Nie można edytować płatności, dlatego anulowanie i wystawienie nowej płatności jest najlepszym sposobem skorygowania płatności.
Archiwizowanie konwersacji	Archiwizuje konwersację, usuwając ją z wyników wszystkich punktów końcowych pobierania konwersacji. Konwersacja będzie automatycznie niearchiwowana, jeśli klient wyśle tekst do numeru żądania tekstowego lub wyśle klientowi tekst z numeru żądania tekstowego. Archiwizowanie konwersacji jest dobrym sposobem na usunięcie bałaganu od klientów, z których nie planujesz rozmawiać w przyszłości. Należy pamiętać, że jeśli tekst klienta w elemecie "STOP", aby uniemożliwić im wysyłanie kolejnych wiadomości SMS, konwersacja jest automatycznie archiwizowana.
Niearchiwne konwersacje	Niearchiwnie konwersację. Gdy konwersacja nie zostanie zarchiwiona, zostanie ponownie wyświetlona w kolejce. pojawi się również w konwersacjach zwróconych przez punkt końcowy /conversation. Jeśli konwersacja jest już niearchiwna, ta metoda nie ma wpływu.
Oznaczanie płatności jako płatnej	Zamyka płatność jako "płatną". Użyj tego punktu końcowego, jeśli płatność jest opłacana za pośrednictwem środków innych niż portal żądania płatności. Spowoduje to zamknięcie płatności i dodanie jej kwoty płatności do statystyk. Ten punkt końcowy nie jest wymagany do płatności płatnych za pośrednictwem portalu płatności wysyłanego za pośrednictwem żądania tekstowego; spowoduje to automatyczne oznaczenie płatności jako płatnej.
Pobiera kontakt z określonym numerem telefonu	Pobiera kontakt z określonym numerem telefonu
Pobiera płatność przy użyciu określonego identyfikatora	Pobiera płatność przy użyciu określonego identyfikatora.
Pobiera wszystkie grupy	Pobiera wszystkie grupy dla konta użytkownika.
Pobiera wszystkie konwersacje dla tego pulpitu nawigacyjnego	Pobiera wszystkie konwersacje dla tego pulpitu nawigacyjnego i zawiera informacje o ostatniej wiadomości dla każdej konwersacji.
Pobiera wszystkie pola niestandardowe	Pobiera wszystkie pola niestandardowe dla tego pulpitu nawigacyjnego. Pola niestandardowe są unikatowe między pulpitami nawigacyjnymi.
Pobiera wszystkie płatności	Pobiera wszystkie płatności, w tym anulowane i płatne płatności. Można je filtrować przy użyciu parametrów zapytania.
Pobiera wszystkie tagi	Pobiera wszystkie tagi dla tego pulpitu nawigacyjnego. Tagi są unikatowe między pulpitami nawigacyjnymi.
Pobieranie grupy według jego identyfikatora	Pobiera grupę z określonym identyfikatorem.
Pobieranie wiadomości konwersacji według numeru telefonu kontaktu	Pobierz konwersację między określonym pulpitem nawigacyjnym a numerem telefonu.
Pobieranie wszystkich pulpitów nawigacyjnych na koncie	Pobiera wszystkie pulpity nawigacyjne na koncie.
Pobierz wszystkie kontakty zgodne z określonym kryterium filtrowania	Pobiera wszystkie kontakty zgodne z określonym kryterium filtrowania. Przeszukiwane będą tylko określone pulpity nawigacyjne; nie ma dostępnego wyszukiwania na poziomie konta.
Tworzenie lub aktualizowanie kontaktu	Tworzy lub aktualizuje kontakt (w zależności od tego, czy już istnieje z podanym numerem telefonu).
Tworzenie nowego pulpitu nawigacyjnego z podaną nazwą i numerem telefonu	Tworzy nowy pulpit nawigacyjny na koncie. Po utworzeniu pulpitu nawigacyjnego administratorzy otrzymają wiadomość e-mail na temat zmiany i mogą rozpocząć przypisywanie użytkowników. Ten punkt końcowy może utworzyć pulpit nawigacyjny dla wszystkich aprowizowanych numerów. Możesz wyszukać aprowizowane numery w określonym kodzie obszaru przy użyciu polecenia GET /dashboards/provisioning. Jeśli numer telefonu jest już używany, zostanie zgłoszony wyjątek Nieprawidłowe żądanie.
Tworzy nową grupę	Tworzy nową grupę o podanej nazwie.
Tworzy nową płatność	Tworzy nową płatność z podaną wiadomością do podanego kontaktu.
Usuwa grupę z określonym identyfikatorem	Usuwa grupę z określonym identyfikatorem. Powiedzie się to nawet wtedy, gdy istnieją kontakty należące do grupy (kontakty nie zostaną usunięte).
Usuwa kontakt z określonym numerem telefonu	Usuwa kontakt z określonym numerem telefonu
Usuwa określony pulpit nawigacyjny	Usuwa określony pulpit nawigacyjny.
Uzyskiwanie informacji na temat tego konkretnego pulpitu nawigacyjnego	Zwraca nazwę i telefon pulpitu nawigacyjnego.
Wyślij tekst z monitem przypominającym użytkownikowi, aby zapłacił określoną płatność	Wysyła przypomnienie do kontaktu w celu zapłaty określonej płatności. Zawartość komunikatu jest generowana automatycznie. Aby uniknąć spamu, można wysłać tylko jedno przypomnienie na płatność
Wyślij wiadomość do kontaktu z podanym numerem telefonu	Wysyła wiadomość (rozpoczynanie nowej konwersacji, jeśli podany numer telefonu nie ma historii wiadomości).
Zbiorcze aktualizowanie kontaktów	Tylko określony pulpit nawigacyjny będzie miał dodane kontakty; kontakty są zorganizowane według pulpitu nawigacyjnego i nie ma wyszukiwania na poziomie konta dla dostępnej liczby.

Aktualizowanie nazwy określonego pulpitu nawigacyjnego

Identyfikator operacji:: UpdateDashboardsName

Aktualizuje pulpit nawigacyjny. Nie zmienia to numeru telefonu pulpitu nawigacyjnego. Jeśli chcesz utworzyć nowy numer z kontaktami innego pulpitu nawigacyjnego, musisz utworzyć nowy pulpit nawigacyjny przy użyciu wpisu POST i dodać kontakty z eksportem/importowaniem zbiorczym.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator pulpitu nawigacyjnego do wykonania tego wywołania	dashboard_id	True	integer	Pulpit nawigacyjny numeru telefonu do pracy. Jedno konto może mieć kilka pulpitów nawigacyjnych reprezentujących różne linie telefoniczne dla klientów.
Nazwa pulpitu nawigacyjnego	name		string	Nowa nazwa pulpitu nawigacyjnego.

Zwraca

Nazwa	Ścieżka	Typ	Opis
id	id	integer	Numeryczny identyfikator pulpitu nawigacyjnego.
nazwa	name	string	Nazwa pulpitu nawigacyjnego.
phone	phone	string	Numer tekstowy skojarzony z tym pulpitem nawigacyjnym.

Aktualizuje grupę o danym identyfikatorze

Identyfikator operacji:: UpdateGroup

Aktualizuje nazwę grupy przy użyciu identyfikatora liczbowego grupy. Jeśli przekazany identyfikator grupy nie istnieje, wywołanie zakończy się niepowodzeniem.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator pulpitu nawigacyjnego do wykonania tego wywołania	dashboard_id	True	integer	Pulpit nawigacyjny numeru telefonu do pracy. Jedno konto może mieć kilka pulpitów nawigacyjnych reprezentujących różne linie telefoniczne dla klientów.
Identyfikator grupy	group_id	True	integer	Identyfikator liczbowy grupy do zaktualizowania.
Nazwa grupy	name		string	Nowa nazwa grupy.
Uwaga grupy	notes		string	Krótka fraza opisująca grupę. Używane dla wygody.

Zwraca

Nazwa	Ścieżka	Typ	Opis
id	id	integer	Numeryczny identyfikator grupy.
group_member_count	group_member_count	integer	Liczba członków grupy.
is_keyword	is_keyword	boolean	Wheter ta grupa jest grupą słów kluczowych. Takie grupy są generowane automatycznie, gdy użytkownik konfiguruje słowo kluczowe. Kontakty są automatycznie dodawane podczas rejestrowania.
nazwa	name	string	Nazwa tej grupy.
Notatki	notes	string	Wszelkie uwagi dotyczące tej grupy.
last_message_sent_utc	last_message_sent_utc	string	Znacznik czasu wysłania ostatniej wiadomości grupy dla tej grupy.

Anuluje określoną płatność

Identyfikator operacji:: CancelPayment

Anuluje określoną płatność, sms-ując użytkownika, że płatność została anulowana. Nie można edytować płatności, dlatego anulowanie i wystawienie nowej płatności jest najlepszym sposobem skorygowania płatności.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator pulpitu nawigacyjnego do wykonania tego wywołania	dashboard_id	True	integer	Pulpit nawigacyjny numeru telefonu do pracy. Jedno konto może mieć kilka pulpitów nawigacyjnych reprezentujących różne linie telefoniczne dla klientów.
Identyfikator płatności	payment_id	True	integer	Numeryczny identyfikator płatności do zaktualizowania.

Zwraca

Nazwa	Ścieżka	Typ	Opis
payment_id	payment_id	integer	Numeryczny identyfikator płatności.
request_date	request_date	string	Sygnatura czasowa wysłania początkowego komunikatu płatności.
adresat	recipient	string	Nazwa odbiorcy płatności. Może to mieć wartość null, jeśli kontakt nie ma nazwy skojarzonej z ich numerem telefonu.
opis	description	string	Opis płatności. Nie jest to widoczne dla kontaktu. Jest on używany tylko przez użytkowników wewnętrznych w kontekście płatności.
customer_phone	customer_phone	string	Numer telefonu kontaktu, który jest wysyłany do tej płatności.
amount_requested	amount_requested	float	Kwota w dolarach żądana przez tę płatność.
is_past_due	is_past_due	boolean	Czy ta płatność jest wcześniejsza niż data żądania.
reminder_was_sent	reminder_was_sent	boolean	Czy przypomnienie tekstowe zostało już wysłane do tej płatności.
transaction_status	transaction_status	string	Stan transakcji w authvia. Ta wartość jest uruchamiana jako Nieznany.
textrequest_payment_status	textrequest_payment_status	string	Stan transakcji w żądaniu tekstowym. Oznacza to, że stan wyświetlany na stronie płatności w aplikacji Żądanie tekstowe. Rozpoczyna się ono w postaci wysłanej.
reference_number	reference_number	string	Identyfikator zdefiniowany przez użytkownika zdefiniowany podczas tworzenia płatności, których można użyć do szybkiego znajdowania płatności. Numery referencyjne nie są unikatowe; wiele płatności może mieć to samo odwołanie.

Archiwizowanie konwersacji

Identyfikator operacji:: ArchiveConversation

Archiwizuje konwersację, usuwając ją z wyników wszystkich punktów końcowych pobierania konwersacji. Konwersacja będzie automatycznie niearchiwowana, jeśli klient wyśle tekst do numeru żądania tekstowego lub wyśle klientowi tekst z numeru żądania tekstowego. Archiwizowanie konwersacji jest dobrym sposobem na usunięcie bałaganu od klientów, z których nie planujesz rozmawiać w przyszłości. Należy pamiętać, że jeśli tekst klienta w elemecie "STOP", aby uniemożliwić im wysyłanie kolejnych wiadomości SMS, konwersacja jest automatycznie archiwizowana.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator pulpitu nawigacyjnego do wykonania tego wywołania	dashboard_id	True	integer	Pulpit nawigacyjny numeru telefonu do pracy. Jedno konto może mieć kilka pulpitów nawigacyjnych reprezentujących różne linie telefoniczne dla klientów.
Numer rozmowy telefonicznej	phone_number	True	string	Numer telefonu konwersacji do archiwizacji.

Zwraca

response: string

Niearchiwne konwersacje

Identyfikator operacji:: UnarchiveConversation

Niearchiwnie konwersację. Gdy konwersacja nie zostanie zarchiwiona, zostanie ponownie wyświetlona w kolejce. pojawi się również w konwersacjach zwróconych przez punkt końcowy /conversation. Jeśli konwersacja jest już niearchiwna, ta metoda nie ma wpływu.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator pulpitu nawigacyjnego do wykonania tego wywołania	dashboard_id	True	integer	Pulpit nawigacyjny numeru telefonu do pracy. Jedno konto może mieć kilka pulpitów nawigacyjnych reprezentujących różne linie telefoniczne dla klientów.
Numer rozmowy telefonicznej	phone_number	True	string	Numer telefonu konwersacji do archiwizacji.

Zwraca

response: string

Oznaczanie płatności jako płatnej

Identyfikator operacji:: MarkPaymentPaid

Zamyka płatność jako "płatną". Użyj tego punktu końcowego, jeśli płatność jest opłacana za pośrednictwem środków innych niż portal żądania płatności. Spowoduje to zamknięcie płatności i dodanie jej kwoty płatności do statystyk. Ten punkt końcowy nie jest wymagany do płatności płatnych za pośrednictwem portalu płatności wysyłanego za pośrednictwem żądania tekstowego; spowoduje to automatyczne oznaczenie płatności jako płatnej.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator pulpitu nawigacyjnego do wykonania tego wywołania	dashboard_id	True	integer	Pulpit nawigacyjny numeru telefonu do pracy. Jedno konto może mieć kilka pulpitów nawigacyjnych reprezentujących różne linie telefoniczne dla klientów.
Identyfikator płatności	payment_id	True	integer	Numeryczny identyfikator płatności do zaktualizowania.

Zwraca

Nazwa	Ścieżka	Typ	Opis
payment_id	payment_id	integer	Numeryczny identyfikator płatności.
request_date	request_date	string	Sygnatura czasowa wysłania początkowego komunikatu płatności.
adresat	recipient	string	Nazwa odbiorcy płatności. Może to mieć wartość null, jeśli kontakt nie ma nazwy skojarzonej z ich numerem telefonu.
opis	description	string	Opis płatności. Nie jest to widoczne dla kontaktu. Jest on używany tylko przez użytkowników wewnętrznych w kontekście płatności.
customer_phone	customer_phone	string	Numer telefonu kontaktu, który jest wysyłany do tej płatności.
amount_requested	amount_requested	float	Kwota w dolarach żądana przez tę płatność.
is_past_due	is_past_due	boolean	Czy ta płatność jest wcześniejsza niż data żądania.
reminder_was_sent	reminder_was_sent	boolean	Czy przypomnienie tekstowe zostało już wysłane do tej płatności.
transaction_status	transaction_status	string	Stan transakcji w authvia. Ta wartość jest uruchamiana jako Nieznany.
textrequest_payment_status	textrequest_payment_status	string	Stan transakcji w żądaniu tekstowym. Oznacza to, że stan wyświetlany na stronie płatności w aplikacji Żądanie tekstowe. Rozpoczyna się ono w postaci wysłanej.
reference_number	reference_number	string	Identyfikator zdefiniowany przez użytkownika zdefiniowany podczas tworzenia płatności, których można użyć do szybkiego znajdowania płatności. Numery referencyjne nie są unikatowe; wiele płatności może mieć to samo odwołanie.

Pobiera kontakt z określonym numerem telefonu

Identyfikator operacji:: GetContactByPhoneNumber

Pobiera kontakt z określonym numerem telefonu

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator pulpitu nawigacyjnego do wykonania tego wywołania	dashboard_id	True	integer	Pulpit nawigacyjny numeru telefonu do pracy. Jedno konto może mieć kilka pulpitów nawigacyjnych reprezentujących różne linie telefoniczne dla klientów.
Numer telefonu kontaktu	phone_number	True	string	Numer telefonu kontaktu do pobrania.

Zwraca

Nazwa	Ścieżka	Typ	Opis
numer telefonu	phone_number	string	Numer telefonu tego kontaktu.
first_name	first_name	string	Imię tego kontaktu.
last_name	last_name	string	Nazwisko tego kontaktu.
display_name	display_name	string	Pełna nazwa tego kontaktu. Jest to domyślna nazwa wyświetlana w aplikacji internetowej podczas wyświetlania kontaktów.
is_suppressed	is_suppressed	boolean	Czy konwersacja z tym kontaktem jest pomijana, a zatem nie jest wypychana do góry kolejki komunikatów po odebraniu.
is_archived	is_archived	boolean	Czy konwersacja z tym kontaktem jest zarchiwizowana i dlatego nie można jej zobaczyć podczas wykonywania zapytań dotyczących konwersacji (domyślnie).
is_blocked	is_blocked	boolean	Niezależnie od tego, czy rozmowa z tym kontaktem jest zablokowana, a zatem nie jest odbierana lub przechowywana.
suppressed_reason	suppressed_reason	string	Fraza opisująca przyczynę pomijania kontaktu. Jeśli is_suppressed ma wartość false, będzie to wartość null.
nuta	note	string	Krótka fraza opisująca kontakt. Używane dla wygody. Nigdy nie jest to pokazywane kontaktowi.
groups	groups	array of integer	Tablica identyfikatorów liczb całkowitych odwołujące się do grup, do których należy ten kontakt.
contact_tags	contact_tags	array of string	Tablica identyfikatorów GUID odwołujące się do tagów dołączonych do tego kontaktu.
custom_fields	custom_fields	array of object	Tablica niestandardowych identyfikatorów pól i wartości zdefiniowanych dla tego kontaktu.
id	custom_fields.id	string	Identyfikator GUID odwołujące się do pola niestandardowego.
value	custom_fields.value	string	Wartość tego kontaktu dla tego pola niestandardowego.
is_resolved	is_resolved	boolean	Czy rozmowa z tym kontaktem została rozwiązana. Wszelkie nowe teksty otrzymane przez ten kontakt ustawią ten fałsz.
first_contact_utc	first_contact_utc	string	Znacznik czasu wysłania pierwszej wiadomości do tego kontaktu.
opted_out_utc	opted_out_utc	string	Znacznik czasu, kiedy ten kontakt zrezygnował z odbierania wiadomości.
last_msg_sent_utc	last_msg_sent_utc	string	Sygnatura czasowa ostatniego wysłania wiadomości do tego kontaktu.
last_msg_received_utc	last_msg_received_utc	string	Znacznik czasu odebrania ostatniej wiadomości od tego kontaktu.
total_msgs_sent	total_msgs_sent	integer	Łączna liczba wiadomości wysłanych do tego kontaktu.
total_msgs_received	total_msgs_received	integer	Liczba wszystkich wiadomości odebranych z tego kontaktu.
response_count	response_count	integer	Całkowita liczba komunikatów odpowiedzi z kontaktu.
date_created_utc	date_created_utc	string	Sygnatura czasowa utworzenia kontaktu.
last_contact_date_utc	last_contact_date_utc	string	Sygnatura czasowa ostatniego wysłania lub odebrania wiadomości od tego kontaktu.
message_id	last_message.message_id	string	Identyfikator wiadomości. Ta wartość jest unikatowa dla każdego komunikatu.
body	last_message.body	string	Zawartość tej wiadomości.
message_direction	last_message.message_direction	string	Znak pojedynczy, R lub S, oznaczający, czy ta wiadomość została odebrana od kontaktu, czy wysłana do nich odpowiednio.
response_by_username	last_message.response_by_username	string	Nazwa użytkownika żądania tekstowego, który ostatnio wysłał wiadomość do tego użytkownika.
message_timestamp_utc	last_message.message_timestamp_utc	string	Sygnatura czasowa wysłania lub odebrania wiadomości przez żądanie tekstowe.
delivery_status	last_message.delivery_status	string	Bieżący stan tej wiadomości. Może to być "wysyłanie", "dostarczone", "błąd" lub "wyślij".
delivery_error	last_message.delivery_error	string	Błąd, który spowodował, że ten komunikat nie został dostarczony. Jeśli delivery_status nie jest "błąd", ta wartość będzie równa null.
mms_media	last_message.mms_media	array of string	Lista adresów URL wskazujących załączniki tej wiadomości. Wszystkie adresy URL będą adresami URL wygenerowanymi przez tekst.

Pobiera płatność przy użyciu określonego identyfikatora

Identyfikator operacji:: GetPayment

Pobiera płatność przy użyciu określonego identyfikatora.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator pulpitu nawigacyjnego do wykonania tego wywołania	dashboard_id	True	integer	Pulpit nawigacyjny numeru telefonu do pracy. Jedno konto może mieć kilka pulpitów nawigacyjnych reprezentujących różne linie telefoniczne dla klientów.
Identyfikator płatności	payment_id	True	integer	Numeryczny identyfikator płatności do pobrania.

Zwraca

Nazwa	Ścieżka	Typ	Opis
payment_id	payment_id	integer	Numeryczny identyfikator płatności.
request_date	request_date	string	Sygnatura czasowa wysłania początkowego komunikatu płatności.
adresat	recipient	string	Nazwa odbiorcy płatności. Może to mieć wartość null, jeśli kontakt nie ma nazwy skojarzonej z ich numerem telefonu.
opis	description	string	Opis płatności. Nie jest to widoczne dla kontaktu. Jest on używany tylko przez użytkowników wewnętrznych w kontekście płatności.
customer_phone	customer_phone	string	Numer telefonu kontaktu, który jest wysyłany do tej płatności.
amount_requested	amount_requested	float	Kwota w dolarach żądana przez tę płatność.
is_past_due	is_past_due	boolean	Czy ta płatność jest wcześniejsza niż data żądania.
reminder_was_sent	reminder_was_sent	boolean	Czy przypomnienie tekstowe zostało już wysłane do tej płatności.
transaction_status	transaction_status	string	Stan transakcji w authvia. Ta wartość jest uruchamiana jako Nieznany.
textrequest_payment_status	textrequest_payment_status	string	Stan transakcji w żądaniu tekstowym. Oznacza to, że stan wyświetlany na stronie płatności w aplikacji Żądanie tekstowe. Rozpoczyna się ono w postaci wysłanej.
reference_number	reference_number	string	Identyfikator zdefiniowany przez użytkownika zdefiniowany podczas tworzenia płatności, których można użyć do szybkiego znajdowania płatności. Numery referencyjne nie są unikatowe; wiele płatności może mieć to samo odwołanie.

Pobiera wszystkie grupy

Identyfikator operacji:: GetGroups

Pobiera wszystkie grupy dla konta użytkownika.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Strona numeru do pobrania	page	True	integer	Strona jednostek do pobrania. Podczas pobierania wartości istnieje maksymalny rozmiar strony zdefiniowany przez page_size. Jeśli strona jest większa niż ostatnia strona, zostanie zwrócona pusta tablica.
Ilość każdej jednostki do pobrania na stronę	page_size	True	integer	Rozmiar każdej strony do pobrania. Podczas pobierania wartości jest to maksymalny rozmiar na stronę z dostępem do kolejnych stron wykonanych przez parametr strony.
Identyfikator pulpitu nawigacyjnego do wykonania tego wywołania	dashboard_id	True	integer	Pulpit nawigacyjny numeru telefonu do pracy. Jedno konto może mieć kilka pulpitów nawigacyjnych reprezentujących różne linie telefoniczne dla klientów.

Zwraca

Nazwa	Ścieżka	Typ	Opis
page	meta.page	integer	Strona jednostek, które zostały uzyskane. Ilość jednostek na tej stronie jest definiowana przez page_size.
page_size	meta.page_size	integer	Liczba jednostek, które zostały uzyskane na tej stronie.
total_items	meta.total_items	integer	Liczba jednostek dostępnych w bazie danych, niezależnie od rozmiaru strony lub liczby. Aby wyświetlić inne strony, zmień numer strony w żądaniu.
items	items	array of object	Lista jednostek grupy uzyskanych z żądania tekstowego.
id	items.id	integer	Numeryczny identyfikator grupy.
group_member_count	items.group_member_count	integer	Liczba członków grupy.
is_keyword	items.is_keyword	boolean	Wheter ta grupa jest grupą słów kluczowych. Takie grupy są generowane automatycznie, gdy użytkownik konfiguruje słowo kluczowe. Kontakty są automatycznie dodawane podczas rejestrowania.
nazwa	items.name	string	Nazwa tej grupy.
Notatki	items.notes	string	Wszelkie uwagi dotyczące tej grupy.
last_message_sent_utc	items.last_message_sent_utc	string	Znacznik czasu wysłania ostatniej wiadomości grupy dla tej grupy.

Pobiera wszystkie konwersacje dla tego pulpitu nawigacyjnego

Identyfikator operacji:: GetConversations

Pobiera wszystkie konwersacje dla tego pulpitu nawigacyjnego i zawiera informacje o ostatniej wiadomości dla każdej konwersacji.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Tagi kontaktu	tags		string	Rozdzielona przecinkami lista identyfikatorów GUID odwołujące się do tagów w celu filtrowania konwersacji według.
Czy pokazywać tylko rozwiązane konwersacje	show_unresolved_only		string	Czy wyszukiwać tylko kontakty, których konwersacje zostały rozwiązane. Jeśli jest to fałsz, zostaną wyświetlone zarówno rozwiązane, jak i nierozwiązane konwersacje.
Czy dołączyć zarchiwizowane konwersacje	include_archived		string	Czy dołączyć konwersacje z kontaktami, które zostały zarchiwizowane.
Termin do filtrowania według numerów telefonów i nazwy kontaktu	search		string	Wyszukaj termin filtrowania konwersacji według numeru telefonu lub nazwy wyświetlanej. Jeśli termin wyszukiwania jest mniejszy niż pełna nazwa lub numer telefonu, wyszukiwanie zwróci wszystkie konwersacje, które częściowo pasują do niego.
Strona numeru do pobrania	page		integer	Strona jednostek do pobrania. Podczas pobierania wartości istnieje maksymalny rozmiar strony zdefiniowany przez page_size. Jeśli strona jest większa niż ostatnia strona, zostanie zwrócona pusta tablica.
Ilość każdej jednostki do pobrania na stronę	page_size		integer	Rozmiar każdej strony do pobrania. Podczas pobierania wartości jest to maksymalny rozmiar na stronę z dostępem do kolejnych stron wykonanych przez parametr strony.
Identyfikator pulpitu nawigacyjnego do wykonania tego wywołania	dashboard_id	True	integer	Pulpit nawigacyjny numeru telefonu do pracy. Jedno konto może mieć kilka pulpitów nawigacyjnych reprezentujących różne linie telefoniczne dla klientów.

Zwraca

Nazwa	Ścieżka	Typ	Opis
page	meta.page	integer	Strona jednostek, które zostały uzyskane. Ilość jednostek na tej stronie jest definiowana przez page_size.
page_size	meta.page_size	integer	Liczba jednostek, które zostały uzyskane na tej stronie.
total_items	meta.total_items	integer	Liczba jednostek dostępnych w bazie danych, niezależnie od rozmiaru strony lub liczby. Aby wyświetlić inne strony, zmień numer strony w żądaniu.
items	items	array of object	Lista jednostek konwersacji uzyskanych z żądania tekstowego.
numer telefonu	items.phone_number	string	Numer telefonu kontaktu.
message_id	items.last_message.message_id	string	Identyfikator wiadomości. Ta wartość jest unikatowa dla każdego komunikatu.
body	items.last_message.body	string	Zawartość tej wiadomości.
message_direction	items.last_message.message_direction	string	Znak pojedynczy, R lub S, oznaczający, czy ta wiadomość została odebrana od kontaktu, czy wysłana do nich odpowiednio.
response_by_username	items.last_message.response_by_username	string	Nazwa użytkownika żądania tekstowego, który ostatnio wysłał wiadomość do tego użytkownika.
message_timestamp_utc	items.last_message.message_timestamp_utc	string	Sygnatura czasowa wysłania lub odebrania wiadomości przez żądanie tekstowe.
delivery_status	items.last_message.delivery_status	string	Bieżący stan tej wiadomości. Może to być "wysyłanie", "dostarczone", "błąd" lub "wyślij".
delivery_error	items.last_message.delivery_error	string	Błąd, który spowodował, że ten komunikat nie został dostarczony. Jeśli delivery_status nie jest "błąd", ta wartość będzie równa null.
mms_media	items.last_message.mms_media	array of string	Lista adresów URL wskazujących załączniki tej wiadomości. Wszystkie adresy URL będą adresami URL wygenerowanymi przez tekst.

Pobiera wszystkie pola niestandardowe

Identyfikator operacji:: GetCustomFields

Pobiera wszystkie pola niestandardowe dla tego pulpitu nawigacyjnego. Pola niestandardowe są unikatowe między pulpitami nawigacyjnymi.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator pulpitu nawigacyjnego do wykonania tego wywołania	dashboard_id	True	integer	Pulpit nawigacyjny numeru telefonu do pracy. Jedno konto może mieć kilka pulpitów nawigacyjnych reprezentujących różne linie telefoniczne dla klientów.

Zwraca

Nazwa	Ścieżka	Typ	Opis
		array of object
id	id	string	Identyfikator liczbowy pola.
nazwa	name	string	Nazwa pola niestandardowego.

Pobiera wszystkie płatności

Identyfikator operacji:: GetPayments

Pobiera wszystkie płatności, w tym anulowane i płatne płatności. Można je filtrować przy użyciu parametrów zapytania.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Ciąg referencyjny płatności	reference_number		string	Zdefiniowany przez użytkownika identyfikator zdefiniowany podczas tworzenia płatności, których można użyć do szybkiego znajdowania płatności. Numery referencyjne nie są unikatowe; wiele płatności może mieć to samo odwołanie.
Numer telefonu płatniczego	phone_number		string	Numer telefonu kontaktu, do którego wysłano tę płatność.
Sortuj według	sort_type		string	Właściwość do sortowania płatności według. Może to być "amount", "contact", "date", "status".
Kierunek sortowania	sort_direction		string	Kierunek sortowania płatności. Może być "desc" dla największych do najmniejszych lub "asc" dla najmniejszych do największych.
Strona numeru do pobrania	page	True	integer	Strona jednostek do pobrania. Podczas pobierania wartości istnieje maksymalny rozmiar strony zdefiniowany przez page_size. Jeśli strona jest większa niż ostatnia strona, zostanie zwrócona pusta tablica.
Ilość każdej jednostki do pobrania na stronę	page_size	True	integer	Rozmiar każdej strony do pobrania. Podczas pobierania wartości jest to maksymalny rozmiar na stronę z dostępem do kolejnych stron wykonanych przez parametr strony.
Identyfikator pulpitu nawigacyjnego do wykonania tego wywołania	dashboard_id	True	integer	Pulpit nawigacyjny numeru telefonu do pracy. Jedno konto może mieć kilka pulpitów nawigacyjnych reprezentujących różne linie telefoniczne dla klientów.

Zwraca

Nazwa	Ścieżka	Typ	Opis
page	meta.page	integer	Strona jednostek, które zostały uzyskane. Ilość jednostek na tej stronie jest definiowana przez page_size.
page_size	meta.page_size	integer	Liczba jednostek, które zostały uzyskane na tej stronie.
total_items	meta.total_items	integer	Liczba jednostek dostępnych w bazie danych, niezależnie od rozmiaru strony lub liczby. Aby wyświetlić inne strony, zmień numer strony w żądaniu.
items	items	array of object	Lista jednostek płatności uzyskanych z żądania tekstowego.
payment_id	items.payment_id	integer	Numeryczny identyfikator płatności.
request_date	items.request_date	string	Sygnatura czasowa wysłania początkowego komunikatu płatności.
adresat	items.recipient	string	Nazwa odbiorcy płatności. Może to mieć wartość null, jeśli kontakt nie ma nazwy skojarzonej z ich numerem telefonu.
opis	items.description	string	Opis płatności. Nie jest to widoczne dla kontaktu. Jest on używany tylko przez użytkowników wewnętrznych w kontekście płatności.
customer_phone	items.customer_phone	string	Numer telefonu kontaktu, który jest wysyłany do tej płatności.
amount_requested	items.amount_requested	float	Kwota w dolarach żądana przez tę płatność.
is_past_due	items.is_past_due	boolean	Czy ta płatność jest wcześniejsza niż data żądania.
reminder_was_sent	items.reminder_was_sent	boolean	Czy przypomnienie tekstowe zostało już wysłane do tej płatności.
transaction_status	items.transaction_status	string	Stan transakcji w authvia. Ta wartość jest uruchamiana jako Nieznany.
textrequest_payment_status	items.textrequest_payment_status	string	Stan transakcji w żądaniu tekstowym. Oznacza to, że stan wyświetlany na stronie płatności w aplikacji Żądanie tekstowe. Rozpoczyna się ono w postaci wysłanej.
reference_number	items.reference_number	string	Identyfikator zdefiniowany przez użytkownika zdefiniowany podczas tworzenia płatności, których można użyć do szybkiego znajdowania płatności. Numery referencyjne nie są unikatowe; wiele płatności może mieć to samo odwołanie.

Pobiera wszystkie tagi

Identyfikator operacji:: GetTags

Pobiera wszystkie tagi dla tego pulpitu nawigacyjnego. Tagi są unikatowe między pulpitami nawigacyjnymi.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator pulpitu nawigacyjnego do wykonania tego wywołania	dashboard_id	True	integer	Pulpit nawigacyjny numeru telefonu do pracy. Jedno konto może mieć kilka pulpitów nawigacyjnych reprezentujących różne linie telefoniczne dla klientów.
Strona numeru do pobrania	page	True	integer	Strona jednostek do pobrania. Podczas pobierania wartości istnieje maksymalny rozmiar strony zdefiniowany przez page_size. Jeśli strona jest większa niż ostatnia strona, zostanie zwrócona pusta tablica.
Ilość każdej jednostki do pobrania na stronę	page_size	True	integer	Rozmiar każdej strony do pobrania. Podczas pobierania wartości jest to maksymalny rozmiar na stronę z dostępem do kolejnych stron wykonanych przez parametr strony.

Zwraca

Nazwa	Ścieżka	Typ	Opis
page	meta.page	integer	Strona jednostek, które zostały uzyskane. Ilość jednostek na tej stronie jest definiowana przez page_size.
page_size	meta.page_size	integer	Liczba jednostek, które zostały uzyskane na tej stronie.
total_items	meta.total_items	integer	Liczba jednostek dostępnych w bazie danych, niezależnie od rozmiaru strony lub liczby. Aby wyświetlić inne strony, zmień numer strony w żądaniu.
items	items	array of object	Lista jednostek tagów uzyskanych z żądania tekstowego.
id	items.id	string	Identyfikator liczbowy tagu.
tag_color	items.tag_color	string	Kolor tagu. Powinien to być prawidłowy kod koloru szesnastkowego.
oznaczyć	items.tag	string	Nazwa znacznika.

Pobieranie grupy według jego identyfikatora

Identyfikator operacji:: GetGroupById

Pobiera grupę z określonym identyfikatorem.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator pulpitu nawigacyjnego do wykonania tego wywołania	dashboard_id	True	integer	Pulpit nawigacyjny numeru telefonu do pracy. Jedno konto może mieć kilka pulpitów nawigacyjnych reprezentujących różne linie telefoniczne dla klientów.
Identyfikator grupy	group_id	True	integer	Identyfikator liczbowy grupy do pobrania.

Zwraca

Nazwa	Ścieżka	Typ	Opis
id	id	integer	Numeryczny identyfikator grupy.
group_member_count	group_member_count	integer	Liczba członków grupy.
is_keyword	is_keyword	boolean	Wheter ta grupa jest grupą słów kluczowych. Takie grupy są generowane automatycznie, gdy użytkownik konfiguruje słowo kluczowe. Kontakty są automatycznie dodawane podczas rejestrowania.
nazwa	name	string	Nazwa tej grupy.
Notatki	notes	string	Wszelkie uwagi dotyczące tej grupy.
last_message_sent_utc	last_message_sent_utc	string	Znacznik czasu wysłania ostatniej wiadomości grupy dla tej grupy.

Pobieranie wiadomości konwersacji według numeru telefonu kontaktu

Identyfikator operacji:: GetMessagesByContactPhone

Pobierz konwersację między określonym pulpitem nawigacyjnym a numerem telefonu.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Strona numeru do pobrania	page	True	integer	Strona jednostek do pobrania. Podczas pobierania wartości istnieje maksymalny rozmiar strony zdefiniowany przez page_size. Jeśli strona jest większa niż ostatnia strona, zostanie zwrócona pusta tablica.
Ilość każdej jednostki do pobrania na stronę	page_size	True	integer	Rozmiar każdej strony do pobrania. Podczas pobierania wartości jest to maksymalny rozmiar na stronę z dostępem do kolejnych stron wykonanych przez parametr strony.
Identyfikator pulpitu nawigacyjnego do wykonania tego wywołania	dashboard_id	True	integer	Pulpit nawigacyjny numeru telefonu do pracy. Jedno konto może mieć kilka pulpitów nawigacyjnych reprezentujących różne linie telefoniczne dla klientów.
Numer telefonu kontaktu do wyszukiwania według	phone_number	True	string	Numer telefonu kontaktu w celu uzyskania wiadomości.

Zwraca

Nazwa	Ścieżka	Typ	Opis
page	meta.page	integer	Strona jednostek, które zostały uzyskane. Ilość jednostek na tej stronie jest definiowana przez page_size.
page_size	meta.page_size	integer	Liczba jednostek, które zostały uzyskane na tej stronie.
total_items	meta.total_items	integer	Liczba jednostek dostępnych w bazie danych, niezależnie od rozmiaru strony lub liczby. Aby wyświetlić inne strony, zmień numer strony w żądaniu.
items	items	array of object	Lista jednostek wiadomości uzyskanych z żądania tekstowego.
message_id	items.message_id	string	Identyfikator wiadomości. Ta wartość jest unikatowa dla każdego komunikatu.
body	items.body	string	Zawartość tej wiadomości.
message_direction	items.message_direction	string	Znak pojedynczy, R lub S, oznaczający, czy ta wiadomość została odebrana od kontaktu, czy wysłana do nich odpowiednio.
response_by_username	items.response_by_username	string	Nazwa użytkownika żądania tekstowego, który ostatnio wysłał wiadomość do tego użytkownika.
message_timestamp_utc	items.message_timestamp_utc	string	Sygnatura czasowa wysłania lub odebrania wiadomości przez żądanie tekstowe.
delivery_status	items.delivery_status	string	Bieżący stan tej wiadomości. Może to być "wysyłanie", "dostarczone", "błąd" lub "wyślij".
delivery_error	items.delivery_error	string	Błąd, który spowodował, że ten komunikat nie został dostarczony. Jeśli delivery_status nie jest "błąd", ta wartość będzie równa null.
mms_media	items.mms_media	array of string	Lista adresów URL wskazujących załączniki tej wiadomości. Wszystkie adresy URL będą adresami URL wygenerowanymi przez tekst.

Pobieranie wszystkich pulpitów nawigacyjnych na koncie

Identyfikator operacji:: GetDashboards

Pobiera wszystkie pulpity nawigacyjne na koncie.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Strona numeru do pobrania	page		integer	Strona jednostek do pobrania. Podczas pobierania wartości istnieje maksymalny rozmiar strony zdefiniowany przez page_size. Jeśli strona jest większa niż ostatnia strona, zostanie zwrócona pusta tablica.
Ilość każdej jednostki do pobrania na stronę	page_size		integer	Rozmiar każdej strony do pobrania. Podczas pobierania wartości jest to maksymalny rozmiar na stronę z dostępem do kolejnych stron wykonanych przez parametr strony.

Zwraca

Nazwa	Ścieżka	Typ	Opis
page	meta.page	integer	Strona jednostek, które zostały uzyskane. Ilość jednostek na tej stronie jest definiowana przez page_size.
page_size	meta.page_size	integer	Liczba jednostek, które zostały uzyskane na tej stronie.
total_items	meta.total_items	integer	Liczba jednostek dostępnych w bazie danych, niezależnie od rozmiaru strony lub liczby. Aby wyświetlić inne strony, zmień numer strony w żądaniu.
items	items	array of object	Lista jednostek pulpitu nawigacyjnego uzyskanych z żądania tekstowego.
id	items.id	integer	Numeryczny identyfikator pulpitu nawigacyjnego.
nazwa	items.name	string	Nazwa pulpitu nawigacyjnego.
phone	items.phone	string	Numer tekstowy skojarzony z tym pulpitem nawigacyjnym.

Pobierz wszystkie kontakty zgodne z określonym kryterium filtrowania

Identyfikator operacji:: GetContacts

Pobiera wszystkie kontakty zgodne z określonym kryterium filtrowania. Przeszukiwane będą tylko określone pulpity nawigacyjne; nie ma dostępnego wyszukiwania na poziomie konta.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Numer telefonu kontaktu do wyszukiwania według	contact_phone_number		string	Numer telefonu do filtrowania kontaktów według.
Znacznik czasu wyszukiwania "Czas ostatniego wysłania wiadomości przed" w czasie UTC	last_message_timestamp_before_utc		date-time	Czas odcięcia wyszukiwania kontaktów przez ostatnią wiadomość wysłaną lub odebraną. Nie będą wyświetlane kontakty, które wysłały wiadomości po tym czasie.
Znacznik czasu wyszukiwania "Czas ostatniego wysłania wiadomości po" w czasie UTC	last_message_timestamp_after_utc		date-time	Czas odcięcia wyszukiwania kontaktów przez ostatnią wiadomość wysłaną lub odebraną. Nie będą wyświetlane kontakty, których ostatnia wysłana wiadomość jest wcześniejsza.
Znacznik czasu wyszukiwania "Utworzono przed"	contact_created_before		date-time	Czas odcięcia wyszukiwania kontaktów według czasu ich utworzenia. Nie będą wyświetlane żadne kontakty utworzone po tym czasie.
Znacznik czasu wyszukiwania "Utworzono po"	contact_created_after		date-time	Czas odcięcia wyszukiwania kontaktów według czasu ich utworzenia. Nie będą wyświetlane żadne kontakty utworzone przed tym czasem.
Czy konwersacja kontaktu jest rozwiązywana	is_resolved		boolean	Czy wyszukiwać kontakty, których konwersacje zostały rozwiązane.
Czy kontakt jest zablokowany	is_blocked		boolean	Czy wyszukiwać kontakty, które zostały zablokowane.
Czy kontakt jest zarchiwizowany	is_archived		boolean	Czy wyszukiwać kontakty, które zostały zarchiwizowane.
Czy kontakt jest pomijany	is_suppressed		boolean	Czy wyszukiwać kontakty, które zostały pominięte.
Czy kontakt zrezygnował	has_opted_out		boolean	Czy szukać kontaktów, którzy zrezygnowali z otrzymywania tekstów.
Znacznik czasu wyszukiwania "Czas ostatniego wysłania wiadomości przed"	last_message_sent_before		date-time	Czas odcięcia wyszukiwania kontaktów według czasu wysłania ostatniej wiadomości do klienta. Nie będą wyświetlane kontakty, które wysłały wiadomości po tym czasie. Używa znacznika czasu jako czasu lokalnego. Aby filtrować według sygnatury czasowej w czasie UTC, użyj last_message_sent_before_utc
Znacznik czasu wyszukiwania "Czas ostatniego wysłania wiadomości po"	last_message_sent_after		date-time	Czas odcięcia wyszukiwania kontaktów według czasu wysłania ostatniej wiadomości do klienta. Nie będą wyświetlane kontakty, których ostatnia wysłana wiadomość jest wcześniejsza. Używa znacznika czasu jako czasu lokalnego. Aby filtrować według sygnatury czasowej w czasie UTC, użyj last_message_sent_after_utc
Znacznik czasu wyszukiwania "Czas ostatniego odebrania wiadomości przed"	last_message_received_before		date-time	Czas odcięcia wyszukiwania kontaktów przez ostatnią wiadomość odebraną od klienta. Nie będą wyświetlane kontakty, które odebrały wiadomości po tym czasie. Używa znacznika czasu jako czasu lokalnego. Aby filtrować według sygnatury czasowej w czasie UTC, użyj last_message_sent_before_utc
Znacznik czasu wyszukiwania "Czas ostatniego odebrania komunikatu po"	last_message_received_after		date-time	Czas odcięcia wyszukiwania kontaktów przez ostatnią wiadomość odebraną od klienta. Nie będą wyświetlane kontakty, których ostatnia wysłana wiadomość jest wcześniejsza. Używa znacznika czasu jako czasu lokalnego. Aby filtrować według sygnatury czasowej w czasie UTC, użyj last_message_sent_before_utc
Tagi kontaktu	tags		string	Rozdzielona przecinkami lista identyfikatorów GUID odwołujące się do tagów do filtrowania kontaktów według.
Grupy kontaktów	groups		string	Rozdzielona przecinkami lista identyfikatorów liczb całkowitych odwołujące się do grup do filtrowania kontaktów według.
Identyfikator pola niestandardowego do filtrowania według	custom_field_id_1		string	Identyfikator GUID odwołując się do pola niestandardowego w celu filtrowania kontaktów według.
Wartość pola niestandardowego do filtrowania według	custom_field_value_1		string	Wartość odwołująca się do pola niestandardowego do filtrowania kontaktów według.
Identyfikator drugiego pola niestandardowego do filtrowania według	custom_field_id_2		string	Identyfikator GUID odwołujące się do drugiego pola niestandardowego do filtrowania kontaktów według.
Wartość drugiego pola niestandardowego do filtrowania według	custom_field_value_2		string	Wartość odwołująca się do drugiego pola niestandardowego do filtrowania kontaktów według.
Identyfikator trzeciego pola niestandardowego do filtrowania według	custom_field_id_3		string	Identyfikator GUID odwołujące się do trzeciego pola niestandardowego do filtrowania kontaktów według.
Wartość trzeciego pola niestandardowego do filtrowania według	custom_field_value_3		string	Wartość odwołująca się do trzeciego pola niestandardowego do filtrowania kontaktów według.
Strona numeru do pobrania	page	True	integer	Strona jednostek do pobrania. Podczas pobierania wartości istnieje maksymalny rozmiar strony zdefiniowany przez page_size. Jeśli strona jest większa niż ostatnia strona, zostanie zwrócona pusta tablica.
Ilość każdej jednostki do pobrania na stronę	page_size	True	integer	Rozmiar każdej strony do pobrania. Podczas pobierania wartości jest to maksymalny rozmiar na stronę z dostępem do kolejnych stron wykonanych przez parametr strony.
Identyfikator pulpitu nawigacyjnego do wykonania tego wywołania	dashboard_id	True	integer	Pulpit nawigacyjny numeru telefonu do pracy. Jedno konto może mieć kilka pulpitów nawigacyjnych reprezentujących różne linie telefoniczne dla klientów.

Zwraca

Nazwa	Ścieżka	Typ	Opis
page	meta.page	integer	Strona jednostek, które zostały uzyskane. Ilość jednostek na tej stronie jest definiowana przez page_size.
page_size	meta.page_size	integer	Liczba jednostek, które zostały uzyskane na tej stronie.
total_items	meta.total_items	integer	Liczba jednostek dostępnych w bazie danych, niezależnie od rozmiaru strony lub liczby. Aby wyświetlić inne strony, zmień numer strony w żądaniu.
items	items	array of object	Lista jednostek kontaktu uzyskanych z żądania tekstowego.
numer telefonu	items.phone_number	string	Numer telefonu tego kontaktu.
first_name	items.first_name	string	Imię tego kontaktu.
last_name	items.last_name	string	Nazwisko tego kontaktu.
display_name	items.display_name	string	Pełna nazwa tego kontaktu. Jest to domyślna nazwa wyświetlana w aplikacji internetowej podczas wyświetlania kontaktów.
is_suppressed	items.is_suppressed	boolean	Czy konwersacja z tym kontaktem jest pomijana, a zatem nie jest wypychana do góry kolejki komunikatów po odebraniu.
is_archived	items.is_archived	boolean	Czy konwersacja z tym kontaktem jest zarchiwizowana i dlatego nie można jej zobaczyć podczas wykonywania zapytań dotyczących konwersacji (domyślnie).
is_blocked	items.is_blocked	boolean	Niezależnie od tego, czy rozmowa z tym kontaktem jest zablokowana, a zatem nie jest odbierana lub przechowywana.
suppressed_reason	items.suppressed_reason	string	Fraza opisująca przyczynę pomijania kontaktu. Jeśli is_suppressed ma wartość false, będzie to wartość null.
nuta	items.note	string	Krótka fraza opisująca kontakt. Używane dla wygody. Nigdy nie jest to pokazywane kontaktowi.
groups	items.groups	array of integer	Tablica identyfikatorów liczb całkowitych odwołujące się do grup, do których należy ten kontakt.
contact_tags	items.contact_tags	array of string	Tablica identyfikatorów GUID odwołujące się do tagów dołączonych do tego kontaktu.
custom_fields	items.custom_fields	array of object	Tablica niestandardowych identyfikatorów pól i wartości zdefiniowanych dla tego kontaktu.
id	items.custom_fields.id	string	Identyfikator GUID odwołujące się do pola niestandardowego.
value	items.custom_fields.value	string	Wartość tego kontaktu dla tego pola niestandardowego.
is_resolved	items.is_resolved	boolean	Czy rozmowa z tym kontaktem została rozwiązana. Wszelkie nowe teksty otrzymane przez ten kontakt ustawią ten fałsz.
first_contact_utc	items.first_contact_utc	string	Znacznik czasu wysłania pierwszej wiadomości do tego kontaktu.
opted_out_utc	items.opted_out_utc	string	Znacznik czasu, kiedy ten kontakt zrezygnował z odbierania wiadomości.
last_msg_sent_utc	items.last_msg_sent_utc	string	Sygnatura czasowa ostatniego wysłania wiadomości do tego kontaktu.
last_msg_received_utc	items.last_msg_received_utc	string	Znacznik czasu odebrania ostatniej wiadomości od tego kontaktu.
total_msgs_sent	items.total_msgs_sent	integer	Łączna liczba wiadomości wysłanych do tego kontaktu.
total_msgs_received	items.total_msgs_received	integer	Liczba wszystkich wiadomości odebranych z tego kontaktu.
response_count	items.response_count	integer	Łączna liczba komunikatów odpowiedzi od kontaktu.
date_created_utc	items.date_created_utc	string	Sygnatura czasowa utworzenia kontaktu.
last_contact_date_utc	items.last_contact_date_utc	string	Sygnatura czasowa ostatniego wysłania lub odebrania wiadomości od tego kontaktu.
message_id	items.last_message.message_id	string	Identyfikator wiadomości. Ta wartość jest unikatowa dla każdego komunikatu.
body	items.last_message.body	string	Zawartość tej wiadomości.
message_direction	items.last_message.message_direction	string	Znak pojedynczy, R lub S, oznaczający, czy ta wiadomość została odebrana od kontaktu, czy wysłana do nich odpowiednio.
response_by_username	items.last_message.response_by_username	string	Nazwa użytkownika żądania tekstowego, który ostatnio wysłał wiadomość do tego użytkownika.
message_timestamp_utc	items.last_message.message_timestamp_utc	string	Sygnatura czasowa wysłania lub odebrania wiadomości przez żądanie tekstowe.
delivery_status	items.last_message.delivery_status	string	Bieżący stan tej wiadomości. Może to być "wysyłanie", "dostarczone", "błąd" lub "wyślij".
delivery_error	items.last_message.delivery_error	string	Błąd, który spowodował, że ten komunikat nie został dostarczony. Jeśli delivery_status nie jest "błąd", ta wartość będzie równa null.
mms_media	items.last_message.mms_media	array of string	Lista adresów URL wskazujących załączniki tej wiadomości. Wszystkie adresy URL będą adresami URL wygenerowanymi przez tekst.

Tworzenie lub aktualizowanie kontaktu

Identyfikator operacji:: CreateContact

Tworzy lub aktualizuje kontakt (w zależności od tego, czy już istnieje z podanym numerem telefonu).

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator pulpitu nawigacyjnego do wykonania tego wywołania	dashboard_id	True	integer	Pulpit nawigacyjny numeru telefonu do pracy. Jedno konto może mieć kilka pulpitów nawigacyjnych reprezentujących różne linie telefoniczne dla klientów.
Numer telefonu kontaktu	phone_number	True	string	Numer telefonu kontaktu w celu utworzenia lub zaktualizowania.
Imię kontaktu	first_name		string	Nowe imię kontaktu.
Nazwisko kontaktu	last_name		string	Nowe nazwisko kontaktu.
Imię i nazwisko kontaktu	display_name		string	Nowa pełna nazwa kontaktu. Jest to domyślna nazwa wyświetlana w aplikacji internetowej podczas wyświetlania kontaktów.
Czy wiadomości z tego kontaktu są pomijane	is_suppressed		boolean	Określa, czy rozmowy z tym kontaktem są pomijane i dlatego nie są wypychane do góry kolejki komunikatów po odebraniu.
Czy wiadomości z tego kontaktu są archiwizowane	is_archived		boolean	Określa, czy konwersacje z tym kontaktem są archiwizowane i dlatego nie można ich zobaczyć podczas wykonywania zapytań dotyczących konwersacji (domyślnie).
Czy wiadomości z tego kontaktu są zablokowane	is_blocked		boolean	Określa, czy rozmowy z tym kontaktem są blokowane, a zatem nie są odbierane lub przechowywane.
Przyczyna pomijania tego kontaktu	suppressed_reason		string	Fraza opisująca przyczynę pomijania kontaktu.
Notatka kontaktowa	note		string	Krótka fraza opisująca kontakt. Używane dla wygody. Nigdy nie jest to pokazywane kontaktowi.
Grupy kontaktów	groups		array of integer	Tablica identyfikatorów liczb całkowitych odwołujące się do grup, do których będzie należeć ten kontakt.
Tagi kontaktu	contact_tags		array of string	Tablica identyfikatorów GUID odwołujące się do tagów dołączonych do tego kontaktu.
Identyfikator pola niestandardowego	id		string	Identyfikator GUID odwołujące się do pola niestandardowego.
Wartość pola niestandardowego	value		string	Wartość tego kontaktu dla tego pola niestandardowego.
Czy bieżąca rozmowa z tym kontaktem została rozwiązana	is_resolved		boolean	Określa, czy bieżąca rozmowa z tym kontaktem została rozwiązana. Wszelkie nowe teksty otrzymane przez ten kontakt ustawią ten fałsz.

Zwraca

Nazwa	Ścieżka	Typ	Opis
numer telefonu	phone_number	string	Numer telefonu tego kontaktu.
first_name	first_name	string	Imię tego kontaktu.
last_name	last_name	string	Nazwisko tego kontaktu.
display_name	display_name	string	Pełna nazwa tego kontaktu. Jest to domyślna nazwa wyświetlana w aplikacji internetowej podczas wyświetlania kontaktów.
is_suppressed	is_suppressed	boolean	Czy konwersacja z tym kontaktem jest pomijana, a zatem nie jest wypychana do góry kolejki komunikatów po odebraniu.
is_archived	is_archived	boolean	Czy konwersacja z tym kontaktem jest zarchiwizowana i dlatego nie można jej zobaczyć podczas wykonywania zapytań dotyczących konwersacji (domyślnie).
is_blocked	is_blocked	boolean	Niezależnie od tego, czy rozmowa z tym kontaktem jest zablokowana, a zatem nie jest odbierana lub przechowywana.
suppressed_reason	suppressed_reason	string	Fraza opisująca przyczynę pomijania kontaktu. Jeśli is_suppressed ma wartość false, będzie to wartość null.
nuta	note	string	Krótka fraza opisująca kontakt. Używane dla wygody. Nigdy nie jest to pokazywane kontaktowi.
groups	groups	array of integer	Tablica identyfikatorów liczb całkowitych odwołujące się do grup, do których należy ten kontakt.
contact_tags	contact_tags	array of string	Tablica identyfikatorów GUID odwołujące się do tagów dołączonych do tego kontaktu.
custom_fields	custom_fields	array of object	Tablica niestandardowych identyfikatorów pól i wartości zdefiniowanych dla tego kontaktu.
id	custom_fields.id	string	Identyfikator GUID odwołujące się do pola niestandardowego.
value	custom_fields.value	string	Wartość tego kontaktu dla tego pola niestandardowego.
is_resolved	is_resolved	boolean	Czy rozmowa z tym kontaktem została rozwiązana. Wszelkie nowe teksty otrzymane przez ten kontakt ustawią ten fałsz.
first_contact_utc	first_contact_utc	string	Znacznik czasu wysłania pierwszej wiadomości do tego kontaktu.
opted_out_utc	opted_out_utc	string	Znacznik czasu, kiedy ten kontakt zrezygnował z odbierania wiadomości.
last_msg_sent_utc	last_msg_sent_utc	string	Sygnatura czasowa ostatniego wysłania wiadomości do tego kontaktu.
last_msg_received_utc	last_msg_received_utc	string	Znacznik czasu odebrania ostatniej wiadomości od tego kontaktu.
total_msgs_sent	total_msgs_sent	integer	Łączna liczba wiadomości wysłanych do tego kontaktu.
total_msgs_received	total_msgs_received	integer	Liczba wszystkich wiadomości odebranych z tego kontaktu.
response_count	response_count	integer	Łączna liczba komunikatów odpowiedzi od kontaktu.
date_created_utc	date_created_utc	string	Sygnatura czasowa utworzenia kontaktu.
last_contact_date_utc	last_contact_date_utc	string	Sygnatura czasowa ostatniego wysłania lub odebrania wiadomości od tego kontaktu.
message_id	last_message.message_id	string	Identyfikator wiadomości. Ta wartość jest unikatowa dla każdego komunikatu.
body	last_message.body	string	Zawartość tej wiadomości.
message_direction	last_message.message_direction	string	Znak pojedynczy, R lub S, oznaczający, czy ta wiadomość została odebrana od kontaktu, czy wysłana do nich odpowiednio.
response_by_username	last_message.response_by_username	string	Nazwa użytkownika żądania tekstowego, który ostatnio wysłał wiadomość do tego użytkownika.
message_timestamp_utc	last_message.message_timestamp_utc	string	Sygnatura czasowa wysłania lub odebrania wiadomości przez żądanie tekstowe.
delivery_status	last_message.delivery_status	string	Bieżący stan tej wiadomości. Może to być "wysyłanie", "dostarczone", "błąd" lub "wyślij".
delivery_error	last_message.delivery_error	string	Błąd, który spowodował, że ten komunikat nie został dostarczony. Jeśli delivery_status nie jest "błąd", ta wartość będzie równa null.
mms_media	last_message.mms_media	array of string	Lista adresów URL wskazujących załączniki tej wiadomości. Wszystkie adresy URL będą adresami URL wygenerowanymi przez tekst.

Tworzenie nowego pulpitu nawigacyjnego z podaną nazwą i numerem telefonu

Identyfikator operacji:: CreateDashboard

Tworzy nowy pulpit nawigacyjny na koncie. Po utworzeniu pulpitu nawigacyjnego administratorzy otrzymają wiadomość e-mail na temat zmiany i mogą rozpocząć przypisywanie użytkowników. Ten punkt końcowy może utworzyć pulpit nawigacyjny dla wszystkich aprowizowanych numerów. Możesz wyszukać aprowizowane numery w określonym kodzie obszaru przy użyciu polecenia GET /dashboards/provisioning. Jeśli numer telefonu jest już używany, zostanie zgłoszony wyjątek Nieprawidłowe żądanie.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
nazwa	name		string	Nazwa pulpitu nawigacyjnego.
phone	phone		string	Numer tekstowy skojarzony z tym pulpitem nawigacyjnym.

Zwraca

Nazwa	Ścieżka	Typ	Opis
id	id	integer	Numeryczny identyfikator pulpitu nawigacyjnego.
nazwa	name	string	Nazwa pulpitu nawigacyjnego.
phone	phone	string	Numer tekstowy skojarzony z tym pulpitem nawigacyjnym.

Tworzy nową grupę

Identyfikator operacji:: CreateGroup

Tworzy nową grupę o podanej nazwie.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator pulpitu nawigacyjnego do wykonania tego wywołania	dashboard_id	True	integer	Pulpit nawigacyjny numeru telefonu do pracy. Jedno konto może mieć kilka pulpitów nawigacyjnych reprezentujących różne linie telefoniczne dla klientów.
Nazwa grupy	name		string	Nowa nazwa grupy.
Uwaga grupy	notes		string	Krótka fraza opisująca grupę. Używane dla wygody.

Zwraca

Nazwa	Ścieżka	Typ	Opis
id	id	integer	Numeryczny identyfikator grupy.
group_member_count	group_member_count	integer	Liczba członków grupy.
is_keyword	is_keyword	boolean	Wheter ta grupa jest grupą słów kluczowych. Takie grupy są generowane automatycznie, gdy użytkownik konfiguruje słowo kluczowe. Kontakty są automatycznie dodawane podczas rejestrowania.
nazwa	name	string	Nazwa tej grupy.
Notatki	notes	string	Wszelkie uwagi dotyczące tej grupy.
last_message_sent_utc	last_message_sent_utc	string	Znacznik czasu wysłania ostatniej wiadomości grupy dla tej grupy.

Tworzy nową płatność

Identyfikator operacji:: CreatePayment

Tworzy nową płatność z podaną wiadomością do podanego kontaktu.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator pulpitu nawigacyjnego do wykonania tego wywołania	dashboard_id	True	integer	Pulpit nawigacyjny numeru telefonu do pracy. Jedno konto może mieć kilka pulpitów nawigacyjnych reprezentujących różne linie telefoniczne dla klientów.
Opis płatności	description		string	Opis płatności. Opis nie jest wyświetlany kontaktowi i jest używany tylko przez użytkowników wewnętrznych w kontekście płatności.
Numer telefonu odbiorcy	customer_phone		string	Numer telefonu kontaktu, na który zostanie wysłana ta płatność.
Kwota żądana w dolarach	amount_requested		float	Kwota w dolarach żądana przez tę płatność.
Treść wiadomości e-mail płatności	message		string	Tekst wiadomości do wysłania do kontaktu wraz z linkiem płatności.
Ciąg referencyjny płatności	reference_number		string	Zdefiniowany przez użytkownika identyfikator zdefiniowany podczas tworzenia płatności, których można użyć do szybkiego znajdowania płatności. Numery referencyjne nie są unikatowe; wiele płatności może mieć to samo odwołanie.

Zwraca

Nazwa	Ścieżka	Typ	Opis
payment_id	payment_id	integer	Numeryczny identyfikator płatności.
request_date	request_date	string	Sygnatura czasowa wysłania początkowego komunikatu płatności.
adresat	recipient	string	Nazwa odbiorcy płatności. Może to mieć wartość null, jeśli kontakt nie ma nazwy skojarzonej z ich numerem telefonu.
opis	description	string	Opis płatności. Nie jest to widoczne dla kontaktu. Jest on używany tylko przez użytkowników wewnętrznych w kontekście płatności.
customer_phone	customer_phone	string	Numer telefonu kontaktu, który jest wysyłany do tej płatności.
amount_requested	amount_requested	float	Kwota w dolarach żądana przez tę płatność.
is_past_due	is_past_due	boolean	Czy ta płatność jest wcześniejsza niż data żądania.
reminder_was_sent	reminder_was_sent	boolean	Czy przypomnienie tekstowe zostało już wysłane do tej płatności.
transaction_status	transaction_status	string	Stan transakcji w authvia. Ta wartość jest uruchamiana jako Nieznany.
textrequest_payment_status	textrequest_payment_status	string	Stan transakcji w żądaniu tekstowym. Oznacza to, że stan wyświetlany na stronie płatności w aplikacji Żądanie tekstowe. Rozpoczyna się ono w postaci wysłanej.
reference_number	reference_number	string	Identyfikator zdefiniowany przez użytkownika zdefiniowany podczas tworzenia płatności, których można użyć do szybkiego znajdowania płatności. Numery referencyjne nie są unikatowe; wiele płatności może mieć to samo odwołanie.

Usuwa grupę z określonym identyfikatorem

Identyfikator operacji:: DeleteGroup

Usuwa grupę z określonym identyfikatorem. Powiedzie się to nawet wtedy, gdy istnieją kontakty należące do grupy (kontakty nie zostaną usunięte).

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator pulpitu nawigacyjnego do wykonania tego wywołania	dashboard_id	True	integer	Pulpit nawigacyjny numeru telefonu do pracy. Jedno konto może mieć kilka pulpitów nawigacyjnych reprezentujących różne linie telefoniczne dla klientów.
Identyfikator grupy	group_id	True	integer	Identyfikator liczbowy grupy do usunięcia.

Zwraca

response: string

Usuwa kontakt z określonym numerem telefonu

Identyfikator operacji:: DeleteContact

Usuwa kontakt z określonym numerem telefonu

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator pulpitu nawigacyjnego do wykonania tego wywołania	dashboard_id	True	integer	Pulpit nawigacyjny numeru telefonu do pracy. Jedno konto może mieć kilka pulpitów nawigacyjnych reprezentujących różne linie telefoniczne dla klientów.
Numer telefonu kontaktu	phone_number	True	string	Numer telefonu kontaktu do usunięcia.

Zwraca

response: string

Usuwa określony pulpit nawigacyjny

Identyfikator operacji:: DeleteDashboard

Usuwa określony pulpit nawigacyjny.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator pulpitu nawigacyjnego do wykonania tego wywołania	dashboard_id	True	integer	Pulpit nawigacyjny numeru telefonu do pracy. Jedno konto może mieć kilka pulpitów nawigacyjnych reprezentujących różne linie telefoniczne dla klientów.

Zwraca

response: string

Uzyskiwanie informacji na temat tego konkretnego pulpitu nawigacyjnego

Identyfikator operacji:: GetDashboard

Zwraca nazwę i telefon pulpitu nawigacyjnego.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator pulpitu nawigacyjnego do wykonania tego wywołania	dashboard_id	True	integer	Pulpit nawigacyjny numeru telefonu do pracy. Jedno konto może mieć kilka pulpitów nawigacyjnych reprezentujących różne linie telefoniczne dla klientów.

Zwraca

Nazwa	Ścieżka	Typ	Opis
id	id	integer	Numeryczny identyfikator pulpitu nawigacyjnego.
nazwa	name	string	Nazwa pulpitu nawigacyjnego.
phone	phone	string	Numer tekstowy skojarzony z tym pulpitem nawigacyjnym.

Wyślij tekst z monitem przypominającym użytkownikowi, aby zapłacił określoną płatność

Identyfikator operacji:: SendPaymentReminder

Wysyła przypomnienie do kontaktu w celu zapłaty określonej płatności. Zawartość komunikatu jest generowana automatycznie. Aby uniknąć spamu, można wysłać tylko jedno przypomnienie na płatność

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator pulpitu nawigacyjnego do wykonania tego wywołania	dashboard_id	True	integer	Pulpit nawigacyjny numeru telefonu do pracy. Jedno konto może mieć kilka pulpitów nawigacyjnych reprezentujących różne linie telefoniczne dla klientów.
Identyfikator płatności	payment_id	True	integer	Numeryczny identyfikator płatności do zaktualizowania.

Zwraca

Nazwa	Ścieżka	Typ	Opis
payment_id	payment_id	integer	Numeryczny identyfikator płatności.
request_date	request_date	string	Sygnatura czasowa wysłania początkowego komunikatu płatności.
adresat	recipient	string	Nazwa odbiorcy płatności. Może to mieć wartość null, jeśli kontakt nie ma nazwy skojarzonej z ich numerem telefonu.
opis	description	string	Opis płatności. Nie jest to widoczne dla kontaktu. Jest on używany tylko przez użytkowników wewnętrznych w kontekście płatności.
customer_phone	customer_phone	string	Numer telefonu kontaktu, który jest wysyłany do tej płatności.
amount_requested	amount_requested	float	Kwota w dolarach żądana przez tę płatność.
is_past_due	is_past_due	boolean	Czy ta płatność jest wcześniejsza niż data żądania.
reminder_was_sent	reminder_was_sent	boolean	Czy przypomnienie tekstowe zostało już wysłane do tej płatności.
transaction_status	transaction_status	string	Stan transakcji w authvia. Ta wartość jest uruchamiana jako Nieznany.
textrequest_payment_status	textrequest_payment_status	string	Stan transakcji w żądaniu tekstowym. Oznacza to, że stan wyświetlany na stronie płatności w aplikacji Żądanie tekstowe. Rozpoczyna się ono w postaci wysłanej.
reference_number	reference_number	string	Identyfikator zdefiniowany przez użytkownika zdefiniowany podczas tworzenia płatności, których można użyć do szybkiego znajdowania płatności. Numery referencyjne nie są unikatowe; wiele płatności może mieć to samo odwołanie.

Wyślij wiadomość do kontaktu z podanym numerem telefonu

Identyfikator operacji:: SendMessageByPhoneNumber

Wysyła wiadomość (rozpoczynanie nowej konwersacji, jeśli podany numer telefonu nie ma historii wiadomości).

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator pulpitu nawigacyjnego do wykonania tego wywołania	dashboard_id	True	integer	Pulpit nawigacyjny numeru telefonu do pracy. Jedno konto może mieć kilka pulpitów nawigacyjnych reprezentujących różne linie telefoniczne dla klientów.
Numer telefonu do wiadomości	phone_number	True	string	Numer telefonu kontaktu do wysłania wiadomości.
Treść wiadomości	body		string	Zawartość wiadomości do wysłania.
Nazwa nadawcy	sender_name		string	Nazwa nadawcy wiadomości. Jest to wyświetlane w aplikacji internetowej TextRequest i interfejsie API podczas pobierania tego komunikatu.
Adres URL wywołania zwrotnego dla momentu aktualizacji stanu komunikatu	status_callback		string	Adres URL aplikacji internetowej do trafienia za pomocą polecenia POST za każdym razem, gdy stan tego komunikatu przejdzie z niedostarczonego do wysłania (lub błędu).
Adres URL wywołania zwrotnego dla żądań lokalizacji, jeśli ten komunikat zawiera jeden	location_callback		string	Adres URL wywołania zwrotnego lokalizacji trafiony za pomocą polecenia POST, gdy użytkownik uzyskuje dostęp do lokalizacji i zatwierdza udostępnianie ich lokalizacji nadawcy. Aby dołączyć link, dodaj element [Żądanie lokalizacji] do treści wiadomości. To wywołanie zwrotne nie jest wymagane w przypadku żądań lokalizacji, ale może być przydatne w przypadku interfejsów API.
Załączniki multimediów MMS dla tej wiadomości	mms_media		array of string	Tablica załączników multimediów MMS dla tej wiadomości. Załączniki muszą być adresami URL uzyskanymi z punktu końcowego wpisu /mms (nieuwzględniane w tym łączniku). Linki załączników zewnętrznych nie zostaną zaakceptowane.

Zwraca

Nazwa	Ścieżka	Typ	Opis
message_id	message_id	string	Identyfikator wiadomości. Ta wartość jest unikatowa dla każdego komunikatu.
body	body	string	Zawartość tej wiadomości.
message_direction	message_direction	string	Znak pojedynczy, R lub S, oznaczający, czy ta wiadomość została odebrana od kontaktu, czy wysłana do nich odpowiednio.
response_by_username	response_by_username	string	Nazwa użytkownika żądania tekstowego, który ostatnio wysłał wiadomość do tego użytkownika.
message_timestamp_utc	message_timestamp_utc	string	Sygnatura czasowa wysłania lub odebrania wiadomości przez żądanie tekstowe.
delivery_status	delivery_status	string	Bieżący stan tej wiadomości. Może to być "wysyłanie", "dostarczone", "błąd" lub "wyślij".
delivery_error	delivery_error	string	Błąd, który spowodował, że ten komunikat nie został dostarczony. Jeśli delivery_status nie jest "błąd", ta wartość będzie równa null.
mms_media	mms_media	array of string	Lista adresów URL wskazujących załączniki tej wiadomości. Wszystkie adresy URL będą adresami URL wygenerowanymi przez tekst.

Zbiorcze aktualizowanie kontaktów

Identyfikator operacji:: BulkUpdateContacts

Tylko określony pulpit nawigacyjny będzie miał dodane kontakty; kontakty są zorganizowane według pulpitu nawigacyjnego i nie ma wyszukiwania na poziomie konta dla dostępnej liczby.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator pulpitu nawigacyjnego do wykonania tego wywołania	dashboard_id	True	integer	Pulpit nawigacyjny numeru telefonu do pracy. Jedno konto może mieć kilka pulpitów nawigacyjnych reprezentujących różne linie telefoniczne dla klientów.
Numer telefonu kontaktu	phone_number		string	Numer telefonu kontaktu w celu utworzenia lub zaktualizowania.
Imię kontaktu	first_name		string	Nowe imię kontaktu.
Nazwisko kontaktu	last_name		string	Nowe nazwisko kontaktu.
Imię i nazwisko kontaktu	display_name		string	Nowa pełna nazwa kontaktu. Jest to domyślna nazwa wyświetlana w aplikacji internetowej podczas wyświetlania kontaktów.
Czy wiadomości z tego kontaktu są pomijane	is_suppressed		boolean	Określa, czy rozmowy z tym kontaktem są pomijane i dlatego nie są wypychane do góry kolejki komunikatów po odebraniu.
Czy wiadomości z tego kontaktu są archiwizowane	is_archived		boolean	Określa, czy konwersacje z tym kontaktem są archiwizowane i dlatego nie można ich zobaczyć podczas wykonywania zapytań dotyczących konwersacji (domyślnie).
Czy wiadomości z tego kontaktu są zablokowane	is_blocked		boolean	Określa, czy rozmowy z tym kontaktem są blokowane, a zatem nie są odbierane lub przechowywane.
Przyczyna pomijania tego kontaktu	suppressed_reason		string	Fraza opisująca przyczynę pomijania kontaktu.
Notatka kontaktowa	note		string	Krótka fraza opisująca kontakt. Używane dla wygody. Nigdy nie jest to pokazywane kontaktowi.
Grupy kontaktów	groups		array of integer	Tablica identyfikatorów liczb całkowitych odwołujące się do grup, do których będzie należeć ten kontakt.
Tagi kontaktu	contact_tags		array of string	Tablica identyfikatorów GUID odwołujące się do tagów dołączonych do tego kontaktu.
Identyfikator pola niestandardowego	id		string	Identyfikator GUID odwołujące się do pola niestandardowego.
Wartość pola niestandardowego	value		string	Wartość tego kontaktu dla tego pola niestandardowego.
Czy bieżąca rozmowa z tym kontaktem została rozwiązana	is_resolved		boolean	Określa, czy bieżąca rozmowa z tym kontaktem została rozwiązana. Wszelkie nowe teksty otrzymane przez ten kontakt ustawią ten fałsz.

Zwraca

Nazwa	Ścieżka	Typ	Opis
		array of object
numer telefonu	phone_number	string	Numer telefonu tego kontaktu.
first_name	first_name	string	Imię tego kontaktu.
last_name	last_name	string	Nazwisko tego kontaktu.
display_name	display_name	string	Pełna nazwa tego kontaktu. Jest to domyślna nazwa wyświetlana w aplikacji internetowej podczas wyświetlania kontaktów.
is_suppressed	is_suppressed	boolean	Czy konwersacja z tym kontaktem jest pomijana, a zatem nie jest wypychana do góry kolejki komunikatów po odebraniu.
is_archived	is_archived	boolean	Czy konwersacja z tym kontaktem jest zarchiwizowana i dlatego nie można jej zobaczyć podczas wykonywania zapytań dotyczących konwersacji (domyślnie).
is_blocked	is_blocked	boolean	Niezależnie od tego, czy rozmowa z tym kontaktem jest zablokowana, a zatem nie jest odbierana lub przechowywana.
suppressed_reason	suppressed_reason	string	Fraza opisująca przyczynę pomijania kontaktu. Jeśli is_suppressed ma wartość false, będzie to wartość null.
nuta	note	string	Krótka fraza opisująca kontakt. Używane dla wygody. Nigdy nie jest to pokazywane kontaktowi.
groups	groups	array of integer	Tablica identyfikatorów liczb całkowitych odwołujące się do grup, do których należy ten kontakt.
contact_tags	contact_tags	array of string	Tablica identyfikatorów GUID odwołujące się do tagów dołączonych do tego kontaktu.
custom_fields	custom_fields	array of object	Tablica niestandardowych identyfikatorów pól i wartości zdefiniowanych dla tego kontaktu.
id	custom_fields.id	string	Identyfikator GUID odwołujące się do pola niestandardowego.
value	custom_fields.value	string	Wartość tego kontaktu dla tego pola niestandardowego.
is_resolved	is_resolved	boolean	Czy rozmowa z tym kontaktem została rozwiązana. Wszelkie nowe teksty otrzymane przez ten kontakt ustawią ten fałsz.
first_contact_utc	first_contact_utc	string	Znacznik czasu wysłania pierwszej wiadomości do tego kontaktu.
opted_out_utc	opted_out_utc	string	Znacznik czasu, kiedy ten kontakt zrezygnował z odbierania wiadomości.
last_msg_sent_utc	last_msg_sent_utc	string	Sygnatura czasowa ostatniego wysłania wiadomości do tego kontaktu.
last_msg_received_utc	last_msg_received_utc	string	Znacznik czasu odebrania ostatniej wiadomości od tego kontaktu.
total_msgs_sent	total_msgs_sent	integer	Łączna liczba wiadomości wysłanych do tego kontaktu.
total_msgs_received	total_msgs_received	integer	Liczba wszystkich wiadomości odebranych z tego kontaktu.
response_count	response_count	integer	Łączna liczba komunikatów odpowiedzi od kontaktu.
date_created_utc	date_created_utc	string	Sygnatura czasowa utworzenia kontaktu.
last_contact_date_utc	last_contact_date_utc	string	Sygnatura czasowa ostatniego wysłania lub odebrania wiadomości od tego kontaktu.
message_id	last_message.message_id	string	Identyfikator wiadomości. Ta wartość jest unikatowa dla każdego komunikatu.
body	last_message.body	string	Zawartość tej wiadomości.
message_direction	last_message.message_direction	string	Znak pojedynczy, R lub S, oznaczający, czy ta wiadomość została odebrana od kontaktu, czy wysłana do nich odpowiednio.
response_by_username	last_message.response_by_username	string	Nazwa użytkownika żądania tekstowego, który ostatnio wysłał wiadomość do tego użytkownika.
message_timestamp_utc	last_message.message_timestamp_utc	string	Sygnatura czasowa wysłania lub odebrania wiadomości przez żądanie tekstowe.
delivery_status	last_message.delivery_status	string	Bieżący stan tej wiadomości. Może to być "wysyłanie", "dostarczone", "błąd" lub "wyślij".
delivery_error	last_message.delivery_error	string	Błąd, który spowodował, że ten komunikat nie został dostarczony. Jeśli delivery_status nie jest "błąd", ta wartość będzie równa null.
mms_media	last_message.mms_media	array of string	Lista adresów URL wskazujących załączniki tej wiadomości. Wszystkie adresy URL będą adresami URL wygenerowanymi przez tekst.

Wyzwalacze

Wyzwalacze po wysłaniu lub odebraniu tekstu

Identyfikator operacji:: TextingWebhook

Wyzwalacze po wysłaniu lub odebraniu tekstu

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Pulpit nawigacyjny wyzwalacza będzie nasłuchiwać zdarzeń z	dashboard_id	True	string	Identyfikator pulpitu nawigacyjnego do dodania wyzwalacza
wydarzenie	event	True	string	wydarzenie

Zwraca

Nazwa	Ścieżka	Typ	Opis
Unikatowy identyfikator wiadomości	messageUniqueIdentifier	string	messageUniqueIdentifier
Identyfikator konta	account.id	integer	id
Identyfikator konwersacji	yourPhoneNumber.id	integer	id
Nazwa pulpitu nawigacyjnego	yourPhoneNumber.description	string	opis
Numer telefonu pulpitu nawigacyjnego	yourPhoneNumber.phoneNumber	string	numer telefonu
Identyfikator pulpitu nawigacyjnego	conversation.id	integer	id
date	conversation.date	string	date
Numer telefonu kontaktowego	conversation.consumerPhoneNumber	string	consumerPhoneNumber
messageDirection	conversation.messageDirection	string	messageDirection
komunikat	conversation.message	string	komunikat
numSegments	conversation.numSegments	integer	numSegments
stan	conversation.status	string	stan
Konwersacja odebrana przez	conversation.claimedBy	string	claimedBy
Nazwa wyświetlana kontaktu	conversation.consumerFriendlyName	string	consumerFriendlyName

Definicje

ciąg

Jest to podstawowy typ danych "string".

Udostępnij przez

Żądanie tekstowe

Pakiet Aranda Service Management Suite (ASMS)

Pre-requisites

Uzyskiwanie poświadczeń

Wprowadzenie do łącznika

Odpowiedź pomyślna

Typowe błędy i środki zaradcze

Często zadawane pytania

Tworzenie połączenia

Domyślny

Limity ograniczania

Akcje

Aktualizowanie nazwy określonego pulpitu nawigacyjnego

Parametry

Zwraca

Aktualizuje grupę o danym identyfikatorze

Parametry

Zwraca

Anuluje określoną płatność

Parametry

Zwraca

Archiwizowanie konwersacji

Parametry

Zwraca

Niearchiwne konwersacje

Parametry

Zwraca

Oznaczanie płatności jako płatnej

Parametry

Zwraca

Pobiera kontakt z określonym numerem telefonu

Parametry

Zwraca

Pobiera płatność przy użyciu określonego identyfikatora

Parametry

Zwraca

Pobiera wszystkie grupy

Parametry

Zwraca

Pobiera wszystkie konwersacje dla tego pulpitu nawigacyjnego

Parametry

Zwraca

Pobiera wszystkie pola niestandardowe

Parametry

Zwraca

Pobiera wszystkie płatności

Parametry

Zwraca

Pobiera wszystkie tagi

Parametry

Zwraca

Pobieranie grupy według jego identyfikatora

Parametry

Zwraca

Pobieranie wiadomości konwersacji według numeru telefonu kontaktu

Parametry

Zwraca

Pobieranie wszystkich pulpitów nawigacyjnych na koncie

Parametry

Zwraca

Pobierz wszystkie kontakty zgodne z określonym kryterium filtrowania

Parametry

Zwraca

Tworzenie lub aktualizowanie kontaktu

Parametry

Zwraca

Tworzenie nowego pulpitu nawigacyjnego z podaną nazwą i numerem telefonu

Parametry

Zwraca

Tworzy nową grupę

Parametry

Zwraca

Tworzy nową płatność

Parametry

Zwraca

Usuwa grupę z określonym identyfikatorem

Parametry

Zwraca

Usuwa kontakt z określonym numerem telefonu