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 |
|---|---|---|
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 |
|---|---|
cursor | Typ obiektu Cursor |
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 |
|---|---|---|
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:
{
"cursor": Cursor,
"collection": Contact[]
}
Opis odpowiedzi:
Tytuł | Opis |
|---|---|
cursor | Typ obiektu Cursor |
collection | Tablica obiektów typu Kontakt |
Szukaj ID.
Wyszukuj informacje kontaktowe według identyfikatora.
GET https://api.smartsender.com/v1/contacts/{contactId}
Jeśli się powiedzie, otrzymasz obiekt typu Kontakt.
Wyszukiwanie ID (proste).
Wyszukuj informacje kontaktowe według identyfikatora.
GET https://api.smartsender.com/v1/contacts/{contactId}/info
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.
GET https://api.smartsender.com/v1/contacts/{contactId}/chat
Jeśli odpowiedź jest pomyślna, otrzymasz obiekt Chat.
Wyszukaj dostępne komunikaty ID.
Uzyskaj listę dostępnych komunikatów kontaktu według identyfikatora.
GET https://api.smartsender.com/v1/contacts/{contactId}/gates
Parametry podstawowe:
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": Gate[]
}
Opis odpowiedzi:
Aktualizacja.
Aktualizuje dane wybranego klienta.
PUT https://api.smartsender.com/v1/contacts/{contactId}
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 | Описание |
|---|---|---|
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:
{
"state": true
}
Uruchamia zdarzenie.
Uruchamia wybrane zdarzenie dla danego kontaktu.
POST https://api.smartsender.com/v1/contacts/{contactId}/fire
Parametry podstawowe:
Tytuł | Opis |
|---|---|
name | Nazwa zdarzenia, wielkość liter ma znaczenie |
Jeśli odpowiedź będzie prawidłowa, otrzymasz następujące informacje:
{
"state": true
}
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}.
POST https://api.smartsender.com/v1/contacts/{contactId}/unite/{targetContactId}
Jeśli odpowiedź będzie prawidłowa, otrzymasz następujące informacje:
{
"state": true
}
(DEPRECYDOWANY) Usuń.
Umożliwia usunięcie wybranego kontaktu.
DELETE https://api.smartsender.com/v1/contacts/{contactId}
Jeśli odpowiedź będzie prawidłowa, otrzymasz następujące informacje:
{
"state": true
}