Courier (niezależny wydawca) (wersja zapoznawcza)
Courier to usługa i studio internetowe dla zespołów programistycznych do zarządzania całą komunikacją wyzwalaną przez produkt (wiadomości e-mail, czat, w aplikacji, wiadomości SMS, wypychanie itp.) w jednym miejscu. Firma Courier jest tworzona dla deweloperów, którzy chcą dostarczać wyjątkowe środowisko powiadomień.
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 | Troy Taylor |
| adres URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| Metadane łącznika | |
|---|---|
| Publisher | Troy Taylor |
| Witryna internetowa | https://www.courier.com/ |
| Zasady ochrony prywatności | https://www.courier.com/privacy/ |
| Kategorie | Komunikacja; Media społecznościowe |
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 |
|---|---|---|---|
| Token (w postaci "Bearer yourToken") | securestring | Token (w postaci "Bearer yourToken") dla tego interfejsu API | Prawda |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Aktualizowanie listy |
Tworzy lub zastępuje istniejącą listę podanymi wartościami. |
| Aktualizowanie profilu |
Aktualizacje w części profilu. |
| Anulowanie subskrypcji użytkownika z listy |
Usuwa subskrypcję do listy według identyfikatorów list i adresatów. |
| Archiwizowanie wiadomości |
Zażądaj zarchiwizowania wiadomości. |
| Dodawanie subskrybentów do listy |
Dodaj dodatkowych subskrybentów do listy. |
| Dodawanie użytkowników do zadania zbiorczego |
Pozyskiwanie danych użytkownika do zadania zbiorczego. |
| Lista marek |
Pobierz listę marek. |
| Pobieranie komunikatu |
Pobierz stan komunikatu. |
| Pobieranie listy |
Pobierz elementy listy. |
| Pobieranie odbiorców |
Zwraca określoną grupę odbiorców według identyfikatora. |
| Pobieranie profilu |
Pobiera określony profil adresata. |
| Pobieranie subskrypcji listy |
Pobiera subskrypcje dla listy. |
| Pobieranie użytkowników zadania zbiorczego |
Pobieranie użytkowników zadania zbiorczego. |
| Pobieranie wszystkich list adresatów |
Pobierz listę wszystkich list adresatów. |
| Pobieranie wszystkich zdarzeń inspekcji |
Pobieranie listy zdarzeń inspekcji. |
| Pobieranie zadania zbiorczego |
Pobierz informacje o zadaniu zbiorczym. |
| Pobieranie zawartości wiadomości |
Pobierz zawartość wcześniej wysłanej wiadomości. |
| Pobieranie zdarzenia inspekcji |
Pobieranie określonego zdarzenia inspekcji według identyfikatora. |
| Przywracanie listy |
Przywraca istniejącą listę według identyfikatora. |
| Tworzenie lub aktualizowanie odbiorców |
Tworzy lub aktualizuje odbiorców na podstawie podanych parametrów i filtrów. |
| Tworzenie marki |
Tworzy nową markę na podstawie podanych ustawień. |
| Tworzenie profilu |
Scal podane wartości z istniejącym profilem lub utwórz nowy profil, jeśli jeszcze nie istnieje. |
| Tworzenie zadania zbiorczego |
Tworzy zadanie zbiorcze dla podanych parametrów komunikatu. |
| Uruchamianie automatyzacji ad hoc |
Wywołaj automatyzację w uruchomieniu ad hoc. |
| Uruchamianie automatyzacji szablonu |
Wywołaj uruchomienie automatyzacji z szablonu automatyzacji. |
| Uruchamianie zadania zbiorczego |
Rozpocznij uruchamianie zadania zbiorczego. |
| Usuwanie listy |
Usuwa listę według identyfikatora listy. |
| Usuwanie odbiorców |
Usuwa określonych odbiorców adresatów. |
| Usuwanie profilu |
Usuwa określony profil adresata. |
| Uzyskiwanie historii wiadomości |
Pobierz zdarzenia wcześniej wysłanej wiadomości. |
| Uzyskiwanie marki |
Pobieranie określonej marki według identyfikatora. |
| Wysyłanie wiadomości |
Wysyła wiadomość do co najmniej jednego adresata. |
| Wyświetl listę wszystkich odbiorców |
Pobierz wszystkich odbiorców skojarzonych z kontem. |
| Wyświetlanie listy komunikatów |
Pobierz stany wcześniej wysłanych komunikatów. |
| Wyświetlanie listy odbiorców |
Pobierz listę członków grupy odbiorców. |
| Wyświetlanie listy powiadomień |
Pobiera listę powiadomień. |
Aktualizowanie listy
Tworzy lub zastępuje istniejącą listę podanymi wartościami.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator listy
|
list_id | True | string |
Identyfikator listy. |
|
Name
|
name | string |
Nazwa. |
Zwraca
- response
- string
Aktualizowanie profilu
Aktualizacje w części profilu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator adresata
|
recipient_id | True | string |
Identyfikator adresata. |
|
Operation
|
op | string |
Operacja. |
|
|
Ścieżka
|
path | string |
Ścieżka. |
|
|
Wartość
|
value | string |
Wartość. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Status
|
status | string |
Stan. |
Anulowanie subskrypcji użytkownika z listy
Usuwa subskrypcję do listy według identyfikatorów list i adresatów.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator listy
|
list_id | True | string |
Identyfikator listy. |
|
Identyfikator adresata
|
recipient_id | True | string |
Identyfikator adresata. |
Zwraca
- response
- string
Archiwizowanie wiadomości
Zażądaj zarchiwizowania wiadomości.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator żądania
|
request_id | True | string |
Identyfikator żądania. |
Zwraca
- response
- string
Dodawanie subskrybentów do listy
Dodaj dodatkowych subskrybentów do listy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator listy
|
list_id | True | string |
Identyfikator listy. |
|
Identyfikator adresata
|
recipientId | string |
Identyfikator adresata. |
Zwraca
- response
- string
Dodawanie użytkowników do zadania zbiorczego
Pozyskiwanie danych użytkownika do zadania zbiorczego.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zadania
|
job_id | True | string |
Identyfikator zadania. |
|
Recipient
|
recipient | string |
Odbiorca. |
Zwraca
- response
- string
Lista marek
Pobierz listę marek.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Cursor
|
cursor | string |
Kursor. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Cursor
|
paging.cursor | string |
Kursor. |
|
Więcej
|
paging.more | boolean |
Czy jest więcej. |
|
Results
|
results | array of object | |
|
Created
|
results.created | integer |
Po utworzeniu. |
|
identyfikator
|
results.id | string |
Identyfikator. |
|
Name
|
results.name | string |
Nazwa. |
|
Opublikowany
|
results.published | integer |
Po opublikowaniu. |
|
Updated
|
results.updated | integer |
Po zaktualizowaniu. |
|
wersja
|
results.version | string |
Wersja. |
|
Primary
|
results.settings.colors.primary | string |
Podstawowa. |
|
Secondary
|
results.settings.colors.secondary | string |
Pomocnicza. |
|
Wyższe
|
results.settings.colors.tertiary | string |
Tertiary. |
|
Kolor paska
|
results.settings.email.header.barColor | string |
Kolor paska. |
|
HREF
|
results.settings.email.header.logo.href | string |
The HREF. |
|
obraz
|
results.settings.email.header.logo.image | string |
Obraz. |
|
Markdown
|
results.settings.email.footer.markdown | string |
Markdown. |
|
adres URL
|
results.settings.email.footer.social.facebook.url | string |
Adres URL. |
|
adres URL
|
results.settings.email.footer.social.instagram.url | string |
Adres URL. |
|
adres URL
|
results.settings.email.footer.social.linkedin.url | string |
Adres URL. |
|
adres URL
|
results.settings.email.footer.social.medium.url | string |
Adres URL. |
|
adres URL
|
results.settings.email.footer.social.twitter.url | string |
Adres URL. |
|
Wyłącz ikonę komunikatu
|
results.settings.inapp.disableMessageIcon | boolean |
Czy wyłączyć ikonę wiadomości. |
|
Umieszczenie
|
results.settings.inapp.placement | string |
Umieszczanie. |
|
Przedmioty
|
results.snippets.items | array of string |
Elementy. |
Pobieranie komunikatu
Pobierz stan komunikatu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator komunikatu
|
message_id | True | string |
Identyfikator komunikatu. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator. |
|
Status
|
status | string |
Stan. |
|
Kolejce
|
enqueued | integer |
W kolejce. |
|
Wysłane
|
sent | integer |
Wysłane. |
|
Dostarczono
|
delivered | integer |
Dostarczone. |
|
Otwarte
|
opened | integer |
Otwarte. |
|
Kliknięciu
|
clicked | integer |
Klikniętą. |
|
Recipient
|
recipient | string |
Odbiorca. |
|
Event
|
event | string |
Wydarzenie. |
|
Notification
|
notification | string |
Powiadomienie. |
|
Error
|
error | string |
Błąd. |
|
Przyczyna
|
reason | string |
Przyczyna. |
|
Dostawcy usługi
|
providers | array of object | |
|
Wysłane
|
providers.sent | integer |
Wysłane. |
|
Dostarczono
|
providers.delivered | integer |
Dostarczone. |
|
Kliknięciu
|
providers.clicked | integer |
Klikniętą. |
|
Otwarte
|
providers.opened | integer |
Otwarte. |
|
Error
|
providers.error | string |
Błąd. |
|
Provider
|
providers.provider | string |
Dostawca. |
|
Status
|
providers.status | string |
Stan. |
Pobieranie listy
Pobierz elementy listy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator listy
|
list_id | True | string |
Identyfikator listy. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Created
|
created | string |
Po utworzeniu. |
|
identyfikator
|
id | string |
Identyfikator. |
|
Name
|
name | string |
Nazwa. |
|
Updated
|
updated | string |
Zaktualizowano. |
Pobieranie odbiorców
Zwraca określoną grupę odbiorców według identyfikatora.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator odbiorców
|
audience_id | True | string |
Identyfikator odbiorców. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator. |
|
Name
|
name | string |
Nazwa. |
|
Description
|
description | string |
Opis. |
|
Operator
|
filter.operator | string |
Operator. |
|
Wartość
|
filter.value | string |
Wartość. |
|
Ścieżka
|
filter.path | string |
Ścieżka. |
Pobieranie profilu
Pobiera określony profil adresata.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator adresata
|
recipient_id | True | string |
Identyfikator adresata. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Email
|
profile.email | string |
Adres e-mail. |
|
Numer telefonu
|
profile.phone_number | string |
Numer telefonu. |
Pobieranie subskrypcji listy
Pobiera subskrypcje dla listy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator listy
|
list_id | True | string |
Identyfikator listy. |
|
Cursor
|
cursor | string |
Kursor. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Cursor
|
paging.cursor | string |
Kursor. |
|
Więcej
|
paging.more | boolean |
Czy jest więcej. |
|
Przedmioty
|
items | array of object | |
|
Identyfikator adresata
|
items.recipientId | string |
Identyfikator adresata. |
|
Created
|
items.created | string |
Po utworzeniu. |
Pobieranie użytkowników zadania zbiorczego
Pobieranie użytkowników zadania zbiorczego.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zadania
|
job_id | True | string |
Identyfikator zadania. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Przedmioty
|
items | array of object | |
|
Recipient
|
items.recipient | string |
Odbiorca. |
|
Email
|
items.email | string |
Adres e-mail. |
|
Lokalizacja
|
items.locale | string |
Ustawienia regionalne. |
|
Cursor
|
paging.cursor | string |
Kursor. |
|
Więcej
|
paging.more | boolean |
Czy jest więcej. |
Pobieranie wszystkich list adresatów
Pobierz listę wszystkich list adresatów.
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Cursor
|
paging.cursor | string |
Kursor. |
|
Więcej
|
paging.more | boolean |
Czy jest więcej. |
|
Results
|
results | array of object | |
|
Created
|
results.created | string |
Po utworzeniu. |
|
identyfikator
|
results.id | string |
Identyfikator. |
|
Name
|
results.name | string |
Nazwa. |
|
Updated
|
results.updated | string |
Po zaktualizowaniu. |
Pobieranie wszystkich zdarzeń inspekcji
Pobieranie listy zdarzeń inspekcji.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Cursor
|
cursor | string |
Kursor. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Cursor
|
paging.cursor | string |
Kursor. |
|
Więcej
|
paging.more | boolean |
Czy jest więcej. |
|
Results
|
results | array of object | |
|
Identyfikator zdarzenia inspekcji
|
results.auditEventId | string |
Identyfikator zdarzenia inspekcji. |
|
identyfikator
|
results.actor.id | string |
Identyfikator. |
|
Email
|
results.actor.email | string |
Adres e-mail. |
|
identyfikator
|
results.target.id | string |
Identyfikator. |
|
Email
|
results.target.email | string |
Adres e-mail. |
|
Źródło
|
results.source | string |
Źródło. |
|
Sygnatura czasowa
|
results.timestamp | string |
Sygnatura czasowa. |
|
Typ
|
results.type | string |
Typ. |
Pobieranie zadania zbiorczego
Pobierz informacje o zadaniu zbiorczym.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zadania
|
job_id | True | string |
Identyfikator zadania. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Event
|
job.definition.event | string |
Wydarzenie. |
|
Kolejce
|
job.enqueued | integer |
W kolejce. |
|
Awarii
|
job.failures | integer |
Błędy. |
|
Otrzymane
|
job.received | integer |
Po odebraniu. |
|
Status
|
job.status | string |
Stan. |
Pobieranie zawartości wiadomości
Pobierz zawartość wcześniej wysłanej wiadomości.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator komunikatu
|
message_id | True | string |
Identyfikator komunikatu. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Channel
|
results.channel | string |
Kanał. |
|
Identyfikator kanału
|
results.channel_id | string |
Identyfikator kanału. |
|
HTML
|
results.content.html | string |
Kod HTML. |
|
Temat
|
results.content.subject | string |
Temat. |
|
Tekst
|
results.content.text | string |
Tekst. |
|
Pudełka
|
results.content.blocks | array of object | |
|
Typ
|
results.content.blocks.type | string |
Typ. |
|
Tekst
|
results.content.blocks.text | string |
Tekst. |
Pobieranie zdarzenia inspekcji
Pobieranie określonego zdarzenia inspekcji według identyfikatora.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zdarzenia inspekcji
|
audit-event-id | True | string |
Identyfikator zdarzenia inspekcji. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator zdarzenia inspekcji
|
auditEventId | string |
Identyfikator zdarzenia inspekcji. |
|
identyfikator
|
actor.id | string |
Identyfikator. |
|
Email
|
actor.email | string |
Adres e-mail. |
|
identyfikator
|
target.id | string |
Identyfikator. |
|
Email
|
target.email | string |
Adres e-mail. |
|
Źródło
|
source | string |
Źródło. |
|
Sygnatura czasowa
|
timestamp | string |
Sygnatura czasowa. |
|
Typ
|
type | string |
Typ. |
Przywracanie listy
Przywraca istniejącą listę według identyfikatora.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator listy
|
list_id | True | string |
Identyfikator listy. |
Zwraca
- response
- string
Tworzenie lub aktualizowanie odbiorców
Tworzy lub aktualizuje odbiorców na podstawie podanych parametrów i filtrów.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator odbiorców
|
audience_id | True | string |
Identyfikator odbiorców. |
|
Name
|
name | string |
Nazwa. |
|
|
Ścieżka
|
path | string |
Ścieżka. |
|
|
Operator
|
operator | string |
Operator. |
|
|
Wartość
|
value | string |
Wartość. |
|
|
Ścieżka
|
path | string |
Ścieżka. |
|
|
Operator
|
operator | string |
Operator. |
|
|
Wartość
|
value | string |
Wartość. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator. |
|
Name
|
name | string |
Nazwa. |
|
Description
|
description | string |
Opis. |
|
Operator
|
filter.operator | string |
Operator. |
|
Wartość
|
filter.value | string |
Wartość. |
|
Ścieżka
|
filter.path | string |
Ścieżka. |
|
Filtry
|
filter.filters | array of object | |
|
Ścieżka
|
filter.filters.path | string |
Ścieżka. |
|
Operator
|
filter.filters.operator | string |
Operator. |
|
Wartość
|
filter.filters.value | string |
Wartość. |
Tworzenie marki
Tworzy nową markę na podstawie podanych ustawień.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator. |
|
|
Name
|
name | True | string |
Nazwa. |
|
Primary
|
primary | string |
Podstawowa. |
|
|
Secondary
|
secondary | string |
Pomocnicza. |
|
|
Wyższe
|
tertiary | string |
Tertiary. |
|
|
Kolor paska
|
barColor | string |
Kolor paska. |
|
|
HREF
|
href | string |
The HREF. |
|
|
obraz
|
image | string |
Obraz. |
|
|
Markdown
|
markdown | string |
Markdown. |
|
|
adres URL
|
url | string |
Adres URL. |
|
|
adres URL
|
url | string |
Adres URL. |
|
|
adres URL
|
url | string |
Adres URL. |
|
|
adres URL
|
url | string |
Adres URL. |
|
|
adres URL
|
url | string |
Adres URL. |
|
|
Wyłącz ikonę komunikatu
|
disableMessageIcon | boolean |
Czy wyłączyć ikonę wiadomości. |
|
|
Umieszczenie
|
placement | string |
Umieszczanie. |
|
|
Przedmioty
|
items | array of string |
Elementy. |
Zwraca
- response
- string
Tworzenie profilu
Scal podane wartości z istniejącym profilem lub utwórz nowy profil, jeśli jeszcze nie istnieje.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator adresata
|
recipient_id | True | string |
Identyfikator adresata. |
|
Email
|
string |
Adres e-mail. |
||
|
Numer telefonu
|
phone_number | string |
Numer telefonu. |
|
|
Sformatowany
|
formatted | string |
Sformatowany adres. |
|
|
Adres ulicy
|
street_address | string |
Adres ulicy. |
|
|
Miejscowość
|
locality | string |
Lokalizacja. |
|
|
Region
|
region | string |
Region. |
|
|
Kod pocztowy
|
postal_code | string |
Kod pocztowy. |
|
|
Country
|
country | string |
Kraj. |
|
|
Data urodzenia
|
birthdate | string |
Data urodzenia. |
|
|
Zweryfikowana wiadomość e-mail
|
email_verified | boolean |
Czy wiadomość e-mail została zweryfikowana. |
|
|
Zweryfikowany numer telefonu
|
phone_number_verified | boolean |
Czy zweryfikowano numer telefonu. |
|
|
Imię
|
given_name | string |
Podana nazwa. |
|
|
Drugie imię
|
middle_name | string |
Nazwa środkowa. |
|
|
Nazwisko
|
family_name | string |
Nazwa rodziny. |
|
|
Preferowana nazwa
|
preferred_name | string |
Preferowana nazwa. |
|
|
Gender
|
gender | string |
Płeć. |
|
|
Lokalizacja
|
locale | string |
Ustawienia regionalne. |
|
|
Obraz
|
picture | string |
Obraz. |
|
|
Profile
|
profile | string |
Profil. |
|
|
Subskrybuj
|
sub | string |
Podsieć. |
|
|
Zaktualizowano o
|
updated_at | string |
Po zaktualizowaniu o. |
|
|
Witryna internetowa
|
website | string |
Witryna internetowa. |
|
|
Informacje o strefie
|
zoneinfo | string |
Informacje o strefie. |
|
|
Nazwany użytkownik
|
named_user | string |
Nazwany użytkownik. |
|
|
Typy urządzeń
|
device_types | array of string |
Typy urządzeń. |
|
|
APN
|
apn | string |
The APN. |
|
|
Docelowa nazwa ARN
|
target_arn | string |
Docelowa nazwa ARN. |
|
|
Identyfikator kanału
|
channel_id | string |
Identyfikator kanału. |
|
|
Identyfikator użytkownika
|
user_id | string |
Identyfikator użytkownika. |
|
|
Żeton
|
token | string |
Znacznik. |
|
|
Tokens
|
tokens | array of string |
Tokeny. |
|
|
Facebook PS ID
|
facebookPSID | string |
Identyfikator usługi Facebook PS. |
|
|
Firebase Token
|
firebaseToken | string |
Token Firebase. |
|
|
Źródło
|
from | string |
Od. |
|
|
identyfikator
|
id | string |
Identyfikator. |
|
|
Identyfikator użytkownika
|
user_id | string |
Identyfikator użytkownika. |
|
|
Identyfikator konwersacji
|
conversation_id | string |
Identyfikator konwersacji. |
|
|
Identyfikator dzierżawy
|
tenant_id | string |
Identyfikator dzierżawy. |
|
|
Adres URL usługi
|
service_url | string |
Adres URL usługi. |
|
|
Identyfikator odtwarzacza OneSignal
|
oneSignalPlayerID | string |
Identyfikator odtwarzacza OneSignal. |
|
|
Token dostępu
|
access_token | string |
Token dostępu. |
|
|
Channel
|
channel | string |
Kanał. |
|
|
Email
|
string |
Adres e-mail. |
||
|
Identyfikator użytkownika
|
user_id | string |
Identyfikator użytkownika. |
|
|
adres URL
|
url | string |
Adres URL. |
|
|
adres URL
|
url | string |
Adres URL. |
|
|
Metoda
|
method | string |
Metody. |
|
|
Mode
|
mode | string |
Tryb. |
|
|
Nazwa użytkownika
|
username | string |
Nazwa użytkownika. |
|
|
Hasło
|
password | string |
Hasło. |
|
|
Żeton
|
token | string |
Znacznik. |
|
|
Profile
|
profile | string |
Profil. |
Zwraca
- response
- string
Tworzenie zadania zbiorczego
Tworzy zadanie zbiorcze dla podanych parametrów komunikatu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Event
|
event | string |
Wydarzenie. |
|
|
Marka
|
brand | string |
Marka. |
|
|
Template
|
template | string |
Szablon. |
|
|
Identyfikator marki
|
brand_id | string |
Identyfikator marki. |
|
|
Metoda
|
method | string |
Metoda. |
|
|
Kanały
|
channels | array of string |
Kanały. |
|
|
Event
|
event | string |
Wydarzenie. |
|
|
Etykiety
|
tags | array of string |
Tagi. |
|
|
Identyfikator śledzenia
|
trace_id | string |
Identyfikator śledzenia. |
|
|
Campaign
|
campaign | string |
Kampania. |
|
|
Content
|
content | string |
Zawartość. |
|
|
Średni
|
medium | string |
Medium. |
|
|
Źródło
|
source | string |
Źródło. |
|
|
Termin
|
term | string |
Termin. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator zadania
|
jobId | string |
Identyfikator zadania. |
Uruchamianie automatyzacji ad hoc
Wywołaj automatyzację w uruchomieniu ad hoc.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Token anulowania
|
cancelation_token | string |
Token anulowania. |
|
|
Marka
|
brand | string |
Marka. |
|
|
Template
|
template | string |
Szablon. |
|
|
Recipient
|
recipient | string |
Odbiorca. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator przebiegu
|
runId | string |
Identyfikator przebiegu. |
Uruchamianie automatyzacji szablonu
Wywołaj uruchomienie automatyzacji z szablonu automatyzacji.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator szablonu
|
templateId | True | string |
Identyfikator szablonu. |
|
Marka
|
brand | string |
Marka. |
|
|
Template
|
template | string |
Szablon. |
|
|
Recipient
|
recipient | string |
Odbiorca. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator przebiegu
|
runId | string |
Identyfikator przebiegu. |
Uruchamianie zadania zbiorczego
Rozpocznij uruchamianie zadania zbiorczego.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zadania
|
job_id | True | string |
Identyfikator zadania. |
Zwraca
- response
- object
Usuwanie listy
Usuwa listę według identyfikatora listy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator listy
|
list_id | True | string |
Identyfikator listy. |
Zwraca
- response
- string
Usuwanie odbiorców
Usuwa określonych odbiorców adresatów.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator odbiorców
|
audience_id | True | string |
Identyfikator odbiorców. |
Zwraca
- response
- string
Usuwanie profilu
Usuwa określony profil adresata.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator adresata
|
recipient_id | True | string |
Identyfikator adresata. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Status
|
status | string |
Stan. |
Uzyskiwanie historii wiadomości
Pobierz zdarzenia wcześniej wysłanej wiadomości.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator komunikatu
|
message_id | True | string |
Identyfikator komunikatu. |
|
Typ
|
type | string |
Typ. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Name
|
results.data.name | string |
Nazwa. |
|
Event
|
results.event | string |
Wydarzenie. |
|
Recipient
|
results.recipient | string |
Odbiorca. |
|
TS
|
results.ts | integer |
The TS. |
|
Typ
|
results.type | string |
Typ. |
|
Identyfikator zdarzenia
|
results.event_id | string |
Identyfikator zdarzenia. |
|
Identyfikator powiadomienia
|
results.notification_id | string |
Identyfikator powiadomienia. |
|
identyfikator
|
results.channel.id | string |
Identyfikator. |
|
identyfikator
|
results.integration.id | string |
Identyfikator. |
|
Provider
|
results.integration.provider | string |
Dostawca. |
Uzyskiwanie marki
Pobieranie określonej marki według identyfikatora.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator marki
|
brand_id | True | string |
Identyfikator marki. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Created
|
created | integer |
Po utworzeniu. |
|
identyfikator
|
id | string |
Identyfikator. |
|
Name
|
name | string |
Nazwa. |
|
Opublikowany
|
published | integer |
Po opublikowaniu. |
|
Updated
|
updated | integer |
Zaktualizowano. |
|
wersja
|
version | string |
Wersja. |
|
Primary
|
settings.colors.primary | string |
Podstawowa. |
|
Secondary
|
settings.colors.secondary | string |
Pomocnicza. |
|
Wyższe
|
settings.colors.tertiary | string |
Tertiary. |
|
Kolor paska
|
settings.email.header.barColor | string |
Kolor paska. |
|
HREF
|
settings.email.header.logo.href | string |
The HREF. |
|
obraz
|
settings.email.header.logo.image | string |
Obraz. |
|
Markdown
|
settings.email.footer.markdown | string |
Markdown. |
|
adres URL
|
settings.email.footer.social.facebook.url | string |
Adres URL. |
|
adres URL
|
settings.email.footer.social.instagram.url | string |
Adres URL. |
|
adres URL
|
settings.email.footer.social.linkedin.url | string |
Adres URL. |
|
adres URL
|
settings.email.footer.social.medium.url | string |
Adres URL. |
|
adres URL
|
settings.email.footer.social.twitter.url | string |
Adres URL. |
|
Wyłącz ikonę komunikatu
|
settings.inapp.disableMessageIcon | boolean |
Czy wyłączyć ikonę wiadomości. |
|
Umieszczenie
|
settings.inapp.placement | string |
Umieszczanie. |
|
Przedmioty
|
snippets.items | array of string |
Elementy. |
Wysyłanie wiadomości
Wysyła wiadomość do co najmniej jednego adresata.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Idempotentność
|
idempotency | True | string |
Klucz idempotentności. |
|
Title
|
title | string |
Tytuł. |
|
|
Body
|
body | string |
Ciało. |
|
|
Identyfikator użytkownika
|
user_id | string |
Identyfikator użytkownika. |
|
|
Identyfikator listy
|
list_id | string |
Identyfikator listy. |
|
|
Identyfikator odbiorców
|
audience_id | string |
Identyfikator odbiorców. |
|
|
Email
|
string |
Adres e-mail. |
||
|
Numer telefonu
|
phone_number | string |
Numer telefonu. |
|
|
Lokalizacja
|
locale | string |
Ustawienia regionalne. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator żądania
|
requestId | string |
Identyfikator żądania. |
Wyświetl listę wszystkich odbiorców
Pobierz wszystkich odbiorców skojarzonych z kontem.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Cursor
|
cursor | string |
Kursor. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Przedmioty
|
items | array of object | |
|
identyfikator
|
items.id | string |
Identyfikator. |
|
Name
|
items.name | string |
Nazwa. |
|
Description
|
items.description | string |
Opis. |
|
Operator
|
items.filter.operator | string |
Operator. |
|
Wartość
|
items.filter.value | string |
Wartość. |
|
Ścieżka
|
items.filter.path | string |
Ścieżka. |
|
Cursor
|
paging.cursor | string |
Kursor. |
|
Więcej
|
paging.more | boolean |
Czy jest więcej. |
Wyświetlanie listy komunikatów
Pobierz stany wcześniej wysłanych komunikatów.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Archiwizowane
|
archived | boolean |
Czy zarchiwizowane. |
|
|
Cursor
|
cursor | string |
Kursor. |
|
|
Event
|
event | string |
Wydarzenie. |
|
|
List
|
list | string |
Lista. |
|
|
Identyfikator komunikatu
|
messageId | string |
Identyfikator komunikatu. |
|
|
Notification
|
notification | string |
Powiadomienie. |
|
|
Recipient
|
recipient | string |
Odbiorca. |
|
|
Status
|
status | string |
Stan. |
|
|
Etykiety
|
tags | string |
Tagi. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Cursor
|
paging.cursor | string |
Kursor. |
|
Więcej
|
paging.more | boolean |
Czy jest więcej. |
|
Results
|
results | array of object | |
|
identyfikator
|
results.id | string |
Identyfikator. |
|
Status
|
results.status | string |
Stan. |
|
Kolejce
|
results.enqueued | integer |
W kolejce. |
|
Wysłane
|
results.sent | integer |
Wysłane. |
|
Dostarczono
|
results.delivered | integer |
Dostarczone. |
|
Otwarte
|
results.opened | integer |
Otwarte. |
|
Kliknięciu
|
results.clicked | integer |
Klikniętą. |
|
Recipient
|
results.recipient | string |
Odbiorca. |
|
Event
|
results.event | string |
Wydarzenie. |
|
Notification
|
results.notification | string |
Powiadomienie. |
|
Error
|
results.error | string |
Błąd. |
|
Przyczyna
|
results.reason | string |
Przyczyna. |
Wyświetlanie listy odbiorców
Pobierz listę członków grupy odbiorców.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator odbiorców
|
audience_id | True | string |
Identyfikator odbiorców. |
|
Cursor
|
cursor | string |
Kursor. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Przedmioty
|
items | array of object | |
|
Identyfikator elementu członkowskiego
|
items.member_id | string |
Identyfikator elementu członkowskiego. |
|
Dodano o
|
items.added_at | string |
Po dodaniu do. |
|
Identyfikator odbiorców
|
items.audience_id | string |
Identyfikator odbiorców. |
|
Wersja odbiorców
|
items.audience_version | integer |
Wersja odbiorców. |
|
Przyczyna
|
items.reason | string |
Przyczyna. |
|
Cursor
|
paging.cursor | string |
Kursor. |
|
Więcej
|
paging.more | boolean |
Czy jest więcej. |
Wyświetlanie listy powiadomień
Pobiera listę powiadomień.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Cursor
|
cursor | string |
Kursor. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Cursor
|
paging.cursor | string |
Kursor. |
|
Więcej
|
paging.more | boolean |
Czy jest więcej. |
|
Results
|
results | array of object | |
|
Utworzono pod adresem
|
results.created_at | integer |
Po utworzeniu na. |
|
identyfikator
|
results.id | string |
Identyfikator. |
|
Dane
|
results.tags.data | array of object | |
|
identyfikator
|
results.tags.data.id | string |
Identyfikator. |
|
Name
|
results.tags.data.name | string |
Nazwa. |
|
Title
|
results.title | string |
Tytuł. |
|
Zaktualizowano o
|
results.updated_at | integer |
Po zaktualizowaniu o. |
Definicje
ciąg
Jest to podstawowy typ danych "string".
obiekt
Jest to typ 'obiekt'.