API Kontakty

Za pomocą tego interfejsu API można wyświetlać, wyszukiwać, dodawać, edytować, łączyć i usuwać kontakty w projekcie.

Odbiór.

Umożliwia pobranie listy kontaktów w projekcie.

GET https://api.smartsender.com/v1/contacts

Tytuł	Opis	Walidacja

Tytuł	Opis	Walidacja
page	Żądana strona	Wartość minimalna 1
limitation	Ilość danych, które mają być wyświetlane na stronie	Wartość minimalna 1, wartość maksymalna 20

Jeśli odpowiedź będzie prawidłowa, otrzymasz następujące informacje:

{
    "cursor": Cursor,
    "collection": Contact[]
}

Opis odpowiedzi:

Tytuł	Opis

Tytuł	Opis
cursor	Typ obiektu Kursor
collection	Tablica obiektów typu Kontakt

Szukaj.

Umożliwia wyszukiwanie dopasowań według kontaktów przy użyciu słowa kluczowego.

GET https://api.smartsender.com/v1/contacts/search

Tytuł	Opis	Walidacja

Tytuł	Opis	Walidacja
page	Żądana strona	Wartość minimalna 1
limitation	Ilość danych, które mają być wyświetlane na stronie	Wartość minimalna 1, wartość maksymalna 20
term	Wyszukaj słowo kluczowe	Nie puste

Jeśli odpowiedź będzie prawidłowa, otrzymasz następujące informacje:

Opis odpowiedzi:

Tytuł	Opis

Tytuł	Opis
cursor	Typ obiektu Kursor
collection	Tablica obiektów typu Kontakt

Szukaj ID.

Wyszukuj informacje kontaktowe według identyfikatora.

Jeśli się powiedzie, otrzymasz obiekt typu Kontakt.

Wyszukiwanie ID (proste).

Wyszukuj informacje kontaktowe według identyfikatora.

Jeśli się powiedzie, otrzymasz obiekt typu Kontakt.

W tej metodzie zmienne są przekazywane jako wartości kluczowe bez podawania szczegółów samych zmiennych.

Wyszukać czat ID.

Uzyskaj czat kontaktu według identyfikatora.

Jeśli odpowiedź jest pomyślna, otrzymasz obiekt Czat.

Wyszukaj dostępne komunikaty ID.

Uzyskaj listę dostępnych komunikatów kontaktu według identyfikatora.

Parametry podstawowe:

Tytuł	Opis	Walidacja

Tytuł	Opis	Walidacja
page	Żądana strona	Wartość minimalna 1
limitation	Ilość danych, które mają być wyświetlane na stronie	Wartość minimalna 1, wartość maksymalna 20

Jeśli odpowiedź będzie prawidłowa, otrzymasz następujące informacje:

Opis odpowiedzi:

Tytuł	Opis

Tytuł	Opis
cursor	Typ obiektu Kursor
collection	Tablica obiektów typu Gate

Aktualizacja.

Aktualizuje dane wybranego klienta.

Parametry podstawowe: W treści żądania podaj wszystkie parametry niezbędne do aktualizacji. Mogą to być zarówno zmienne, jak i pola systemowe.

Parametry podstawowe:

Tytuł	Typ	Описание

Tytuł	Typ	Описание
values	Obiekt (klucz-wartość)	Wszystkie parametry niezbędne do aktualizacji znajdują się w treści żądania. Mogą to być zarówno zmienne, jak i pola systemowe.

Ważne: Jeśli w polu aktualizacji zostanie podana nieprawidłowa wartość, pole zostanie pominięte, a reszta aktualizacji zostanie przetworzona.

Jeśli odpowiedź będzie prawidłowa, otrzymasz następujące informacje:

Uruchamia zdarzenie.

Uruchamia wybrane zdarzenie dla danego kontaktu.

Parametry podstawowe:

Tytuł	Opis

Tytuł	Opis
name	Nazwa zdarzenia, wielkość liter ma znaczenie

Jeśli odpowiedź będzie prawidłowa, otrzymasz następujące informacje:

Unifikacja.

Łączy jednego klienta z drugim. Wszystkie znaczniki, lejki, zmienne zostaną zsynchronizowane na rzecz {contactId}, a wszelkie brakujące wartości zostaną pobrane z {targetContactId}.

Jeśli odpowiedź będzie prawidłowa, otrzymasz następujące informacje:

(DEPRECYDOWANY) Usuń.

Umożliwia usunięcie wybranego kontaktu.

Jeśli odpowiedź będzie prawidłowa, otrzymasz następujące informacje: