MailJet (niezależny wydawca) (wersja zapoznawcza)
Kompletna kolekcja wszystkich publicznie dostępnych punktów końcowych i metod interfejsu API Mailjet
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 | Clement OLIVIER |
| adres URL | https://stuffandtacos.azurewebsites.net/ |
| clement@carfup.com |
| Metadane łącznika | |
|---|---|
| Publisher | Clement Olivier |
| Witryna internetowa | https://www.mailjet.com/ |
| Zasady ochrony prywatności | https://www.mailjet.com/security-privacy/ |
| Kategorie | Marketing; Komunikacja |
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 App zostanie udostępniona innemu użytkownikowi, inny użytkownik zostanie poproszony o jawne utworzenie nowego połączenia.
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| Klucz interfejsu API/logowanie | securestring | Klucz interfejsu API/identyfikator logowania wystawiony przez firmę MailJet | Prawda |
| Wpis tajny interfejsu API | securestring | Wpis tajny interfejsu API/hasło wystawione przez mailJet | Prawda |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Aktualizacja wersji roboczej kampanii |
Aktualizowanie istniejącej wersji roboczej kampanii |
| Aktualizowanie listy kontaktów |
Aktualizowanie określonej listy kontaktów przez zmianę jej nazwy i/ lub stanu usunięcia |
| Aktualizuj kontakt |
Aktualizowanie podanej przez użytkownika nazwy i stanu wykluczenia określonego kontaktu |
| Odbieranie wiadomości |
Pobieranie listy komunikatów z określonymi informacjami na temat typu zawartości, śledzenia, wysyłania i dostarczania |
| Omówienie uzyskiwania kampanii |
Uzyskiwanie ogólnych szczegółów i statystyk dla wszystkich wersji roboczych, obiektów testowania AB i/lub wysłanych kampanii |
| Pobieranie danych kontaktowych według identyfikatora |
Pobieranie wszystkich właściwości i odpowiednich wartości skojarzonych z określonym kontaktem |
| Pobieranie danych kontaktów |
Uzyskiwanie informacji o wszystkich kontaktach i skojarzonych z nimi wartości właściwości |
| Pobieranie informacji o wiadomościach |
Pobieranie informacji o wysyłaniu/rozmiarze/spamie dotyczących wszystkich wiadomości |
| Pobieranie list kontaktów |
Pobierz szczegóły dla wszystkich list kontaktów — nazwa, liczba subskrybentów, sygnatura czasowa tworzenia, stan usunięcia. |
| Pobieranie listy kontaktów według identyfikatora |
Pobierz szczegóły dla określonej listy kontaktów — nazwa, liczba subskrybentów, sygnatura czasowa tworzenia, stan usunięcia. |
| Pobieranie statystyk kontaktów |
Pobieranie listy ogólnych zagregowanych statystyk dostarczania i zaangażowania pogrupowanych według kontaktu |
| Pobieranie wersji roboczej kampanii |
Pobieranie wszystkich wersji roboczych kampanii i ich konfiguracji |
| Pobieranie wersji roboczej kampanii według identyfikatora |
Pobieranie określonej wersji roboczej kampanii i jej szczegółów konfiguracji |
| Tworzenie kontaktu |
Dodaj nowy unikatowy kontakt do globalnej listy kontaktów i wybierz jego stan wykluczenia |
| Tworzenie listy kontaktów |
Tworzenie nowej listy kontaktów |
| Tworzenie wersji roboczej kampanii |
Utwórz nową wersję roboczą kampanii. Obiekty Newsletter i CampaignDraft różnią się wartościami EditMode. |
| Usuń listę kontaktów |
Usuwanie listy kontaktów |
| Uzyskiwanie kontaktu według identyfikatora |
Pobieranie określonego kontaktu |
| Uzyskiwanie kontaktów |
Pobierz listę wszystkich kontaktów. Zawiera informacje o stanie kontaktu i utworzeniu/sygnaturach czasowych działań |
| Wyślij wiadomość e-mail w wersji 3 |
Wysyłanie wiadomości e-mail za pośrednictwem interfejsu API wysyłania w wersji 3 |
| Wyślij wiadomość e-mail w wersji 3.1 |
Wysyłanie wiadomości e-mail za pośrednictwem interfejsu API wysyłania w wersji 3.1 |
Aktualizacja wersji roboczej kampanii
Aktualizowanie istniejącej wersji roboczej kampanii
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator wersji roboczej
|
draft_ID | True | integer |
Unikatowy identyfikator liczbowy wersji roboczej kampanii, którą chcesz zaktualizować |
|
Typ zawartości
|
Content-Type | string |
Typ zawartości |
|
|
Aktualny
|
Current | integer |
Aktualny |
|
|
Tryb edycji
|
EditMode | string |
Tryb edycji dla wersji roboczej kampanii. |
|
|
IsStarred
|
IsStarred | boolean |
Jest gwiazdą |
|
|
IsTextPartIncluded
|
IsTextPartIncluded | boolean |
Jest uwzględniona część tekstowa |
|
|
ReplyEmail
|
ReplyEmail | string |
Wiadomość e-mail z odpowiedzią |
|
|
SenderName
|
SenderName | string |
Nazwa nadawcy |
|
|
Identyfikator szablonu
|
TemplateID | integer |
Identyfikator szablonu |
|
|
Title
|
Title | string |
Title |
|
|
ContactsListID
|
ContactsListID | string |
Identyfikator listy kontaktów |
|
|
ContactsListAlt
|
ContactsListAlt | string |
Alt listy kontaktów |
|
|
Lokalizacja
|
Locale | True | string |
Lokalizacja |
|
Identyfikator segmentacji
|
SegmentationID | integer |
Identyfikator segmentacji |
|
|
SegmentacjaAlt
|
SegmentationAlt | string |
Alt segmentacji |
|
|
Nadawca
|
Sender | string |
Nadawca |
|
|
SenderEmail
|
SenderEmail | string |
Adres e-mail nadawcy |
|
|
Temat
|
Subject | True | string |
Temat |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
Count | integer |
Liczba |
|
Dane
|
Data | array of CampaignDraftResponse |
Dane |
|
Total
|
Total | integer |
Total |
Aktualizowanie listy kontaktów
Aktualizowanie określonej listy kontaktów przez zmianę jej nazwy i/ lub stanu usunięcia
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator listy
|
list_ID | True | string |
Unikatowy identyfikator liczbowy przypisany do tej listy kontaktów |
|
Name
|
Name | True | string |
Nazwa określona przez użytkownika dla tej listy kontaktów (musi być unikatowa) |
|
IsDeleted
|
IsDeleted | boolean |
W przypadku wartości true lista kontaktów zostanie oznaczona jako Usunięta |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
Count | integer |
Liczba |
|
Dane
|
Data | array of ContactsListResponse |
Dane |
|
Total
|
Total | integer |
Total |
Aktualizuj kontakt
Aktualizowanie podanej przez użytkownika nazwy i stanu wykluczenia określonego kontaktu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator kontaktu
|
contact_ID | True | string |
Unikatowy identyfikator liczbowy kontaktu, który chcesz zaktualizować |
|
IsExcludedFromCampaigns
|
IsExcludedFromCampaigns | boolean |
Wskazuje, czy kontakt jest dodawany do listy wykluczeń dla kampanii, czy nie |
|
|
Name
|
Name | string |
Wybrana przez użytkownika nazwa tego kontaktu |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
Count | integer |
Liczba |
|
Dane
|
Data | array of ContactResponse |
Dane |
|
Total
|
Total | integer |
Total |
Odbieranie wiadomości
Pobieranie listy komunikatów z określonymi informacjami na temat typu zawartości, śledzenia, wysyłania i dostarczania
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Kontakt
|
Contact | integer |
Pobiera tylko komunikaty wysyłane do określonego identyfikatora kontaktu |
|
|
Identyfikator niestandardowy
|
CustomID | integer |
Pobiera tylko komunikaty oznaczone określonym identyfikatorem CustomID |
|
|
Destynacja
|
Destination | integer |
Pobiera tylko komunikaty wysyłane do określonego identyfikatora docelowego |
|
|
Z usługiTS
|
FromTS | date-time |
Pobiera tylko komunikaty wysyłane po określonym znaczniku czasu |
|
|
Ograniczenie
|
Limit | integer |
Ogranicz odpowiedź do wybranej liczby zwracanych obiektów |
|
|
FromType
|
FromType | integer |
|
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
Count | integer |
Liczba |
|
Dane
|
Data | array of MessageResponse |
Dane |
|
Total
|
Total | integer |
Total |
Omówienie uzyskiwania kampanii
Uzyskiwanie ogólnych szczegółów i statystyk dla wszystkich wersji roboczych, obiektów testowania AB i/lub wysłanych kampanii
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
Count | integer |
Liczba |
|
Dane
|
Data | array of object |
Dane |
|
ClickedCount
|
Data.ClickedCount | integer |
Liczba kliknięć |
|
Liczba dostarczonych
|
Data.DeliveredCount | integer |
Liczba dostarczonych |
|
EditMode
|
Data.EditMode | string |
Tryb edycji |
|
EditType
|
Data.EditType | string |
Edytuj typ |
|
identyfikator
|
Data.ID | integer |
identyfikator |
|
IdType
|
Data.IDType | string |
Typ identyfikatora |
|
OpenedCount
|
Data.OpenedCount | integer |
Liczba otwartych |
|
Przetworzone konto
|
Data.ProcessedCount | integer |
Liczba przetworzonych |
|
SendTimeStart
|
Data.SendTimeStart | integer |
Godzina wysłania |
|
Gwiazda
|
Data.Starred | boolean |
Gwiazda |
|
Status
|
Data.Status | integer |
Status |
|
Temat
|
Data.Subject | string |
Temat |
|
Title
|
Data.Title | string |
Title |
|
Total
|
Total | integer |
Total |
Pobieranie danych kontaktowych według identyfikatora
Pobieranie wszystkich właściwości i odpowiednich wartości skojarzonych z określonym kontaktem
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator kontaktu
|
contactID | True | integer |
Unikatowy identyfikator liczbowy kontaktu, którego właściwości chcesz pobrać |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
Count | integer |
Liczba |
|
Dane
|
Data | array of ContactDataResponse |
Dane |
|
Total
|
Total | integer |
Total |
Pobieranie danych kontaktów
Uzyskiwanie informacji o wszystkich kontaktach i skojarzonych z nimi wartości właściwości
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Campaign
|
Campaign | integer |
Pobiera listę wartości właściwości kontaktu tylko dla kontaktów, które otrzymały wiadomości e-mail z tego identyfikatora kampanii |
|
|
Kontaktowy adres e-mail
|
ContactEmail | string |
Pobiera listę wartości właściwości kontaktu tylko dla kontaktu z tym adresem e-mail |
|
|
Identyfikator listy kontaktów
|
ContactsList | integer |
Pobiera listę wartości właściwości kontaktu tylko dla kontaktów będących częścią tego identyfikatora listy kontaktów |
|
|
Pola formularza
|
Fields | string |
Wiele właściwości można określić, oddzielając je przecinkami |
|
|
Ostatnie działanie o
|
LastActivityAt | string |
Pobiera listę wartości właściwości kontaktu tylko dla kontaktów |
|
|
Ograniczenie
|
Limit | integer |
Ogranicz odpowiedź do wybranej liczby zwracanych obiektów |
|
|
Przesunięcie
|
OffSet | integer |
Pobieranie listy obiektów rozpoczynających się od określonego przesunięcia |
|
|
Tylko liczba
|
countOnly | boolean |
Tylko liczba zwracanych wartości. |
|
|
Sortuj
|
Sort | string |
Określ nazwę właściwości dla tego parametru zapytania w celu sortowania obiektów w danych |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
Count | integer |
Liczba |
|
Dane
|
Data | array of ContactDataResponse |
Dane |
|
Total
|
Total | integer |
Total |
Pobieranie informacji o wiadomościach
Pobieranie informacji o wysyłaniu/rozmiarze/spamie dotyczących wszystkich wiadomości
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator kampanii
|
CampaignID | integer |
Pobiera informacje tylko o komunikatach, które są częścią tej kampanii |
|
|
Lista kontaktów
|
ContactsList | integer |
Pobiera informacje tylko o wiadomościach wysłanych do tej listy kontaktów |
|
|
CustomCampaign
|
CustomCampaign | integer |
Pobiera informacje tylko o komunikatach, które są częścią kampanii z określonym identyfikatorem niestandardowym |
|
|
Źródło
|
From | string |
Pobiera informacje tylko o wiadomościach wysyłanych z określonego adresu e-mail nadawcy |
|
|
Zdomeny
|
FromDomain | string |
Pobiera informacje tylko o komunikatach wysyłanych z określonej domeny nadawcy |
|
|
FromID
|
FromID | integer |
Pobiera informacje tylko o komunikatach wysyłanych z określonego identyfikatora nadawcy |
|
|
Z usługiTS
|
FromTS | date-time |
Pobiera tylko komunikaty wysyłane po określonym znaczniku czasu |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
Count | integer |
Liczba |
|
Dane
|
Data | array of MessageInformationResponse |
Dane |
|
Total
|
Total | integer |
Total |
Pobieranie list kontaktów
Pobierz szczegóły dla wszystkich list kontaktów — nazwa, liczba subskrybentów, sygnatura czasowa tworzenia, stan usunięcia.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Address
|
Address | string |
Pobiera tylko listę kontaktów z określonym unikatowym adresem utworzonym przez firmę Mailjet. |
|
|
Identyfikator wykluczenia
|
ExcludeID | integer |
Wyklucza listę kontaktów z określonym identyfikatorem z odpowiedzi. |
|
|
Czy usunięto?
|
IsDeleted | boolean |
W przypadku wartości true program pobierze tylko usunięte listy. W przypadku wartości false program pobierze listy, które nie zostaną usunięte. |
|
|
Name
|
Name | string |
Pobiera tylko listę z określoną wybraną nazwą użytkownika. |
|
|
Ograniczenie
|
Limit | integer |
Ogranicz odpowiedź na wybraną liczbę zwracanych obiektów. |
|
|
Przesunięcie
|
OffSet | integer |
Pobierz listę obiektów rozpoczynających się od określonego przesunięcia. |
|
|
Tylko liczba
|
countOnly | boolean |
Zwracaj tylko wiersze zliczaj lub nie. |
|
|
Sortuj
|
Sort | string |
Określ nazwę właściwości dla tego parametru zapytania, aby posortować obiekty w danych. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
Count | integer |
Liczba |
|
Dane
|
Data | array of ContactsListResponse |
Dane |
|
Total
|
Total | integer |
Total |
Pobieranie listy kontaktów według identyfikatora
Pobierz szczegóły dla określonej listy kontaktów — nazwa, liczba subskrybentów, sygnatura czasowa tworzenia, stan usunięcia.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Unikatowy identyfikator liczbowy
|
list_ID | True | string |
Unikatowy identyfikator liczbowy przypisany do tej listy kontaktów. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
Count | integer |
Liczba |
|
Dane
|
Data | array of ContactsListResponse |
Dane |
|
Total
|
Total | integer |
Total |
Pobieranie statystyk kontaktów
Pobieranie listy ogólnych zagregowanych statystyk dostarczania i zaangażowania pogrupowanych według kontaktu
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
Count | integer |
Liczba |
|
Dane
|
Data | array of object |
Dane |
|
BlockedCount
|
Data.BlockedCount | integer |
Liczba zablokowanych |
|
BouncedCount
|
Data.BouncedCount | integer |
Liczba odbitych |
|
ClickedCount
|
Data.ClickedCount | integer |
Liczba kliknięć |
|
Identyfikator kontaktu
|
Data.ContactID | integer |
Identyfikator kontaktu |
|
Odroczone konto
|
Data.DeferredCount | integer |
Liczba odroczona |
|
Liczba dostarczonych
|
Data.DeliveredCount | integer |
Liczba dostarczonych |
|
HardbouncedCount
|
Data.HardbouncedCount | integer |
Liczba odbita |
|
LastActivityAt
|
Data.LastActivityAt | date-time |
Ostatnie działanie o |
|
MarketingContacts
|
Data.MarketingContacts | integer |
Kontakty marketingowe |
|
OpenedCount
|
Data.OpenedCount | integer |
Liczba otwartych |
|
Przetworzone konto
|
Data.ProcessedCount | integer |
Liczba przetworzonych |
|
QueuedCount
|
Data.QueuedCount | integer |
Liczba kolejek |
|
SoftbouncedCount
|
Data.SoftbouncedCount | integer |
Liczba odbitych miękkich |
|
SpamComplaintCount
|
Data.SpamComplaintCount | integer |
Liczba skarg do spamu |
|
Subskrypcja konta
|
Data.UnsubscribedCount | integer |
Liczba anulowanych subskrypcji |
|
UserMarketingContacts
|
Data.UserMarketingContacts | integer |
Kontakty marketingowe użytkowników |
|
WorkFlowExitedCount
|
Data.WorkFlowExitedCount | integer |
Liczba zakończona przepływu pracy |
|
Total
|
Total | integer |
Total |
Pobieranie wersji roboczej kampanii
Pobieranie wszystkich wersji roboczych kampanii i ich konfiguracji
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
Count | integer |
Liczba |
|
Dane
|
Data | array of CampaignDraftResponse |
Dane |
|
Total
|
Total | integer |
Total |
Pobieranie wersji roboczej kampanii według identyfikatora
Pobieranie określonej wersji roboczej kampanii i jej szczegółów konfiguracji
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator wersji roboczej
|
draft_ID | True | integer |
Unikatowy identyfikator liczbowy wersji roboczej kampanii, którą chcesz pobrać. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
Count | integer |
Liczba |
|
Dane
|
Data | array of CampaignDraftResponse |
Dane |
|
Total
|
Total | integer |
Total |
Tworzenie kontaktu
Dodaj nowy unikatowy kontakt do globalnej listy kontaktów i wybierz jego stan wykluczenia
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
IsExcludedFromCampaigns
|
IsExcludedFromCampaigns | string |
Wskazuje, czy kontakt jest dodawany do listy wykluczeń dla kampanii, czy nie |
|
|
Name
|
Name | string |
Wybrana przez użytkownika nazwa tego kontaktu |
|
|
Email
|
True | string |
Kontaktowy adres e-mail |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
Count | integer |
Liczba |
|
Dane
|
Data | array of ContactResponse |
Dane |
|
Total
|
Total | integer |
Total |
Tworzenie listy kontaktów
Tworzenie nowej listy kontaktów
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Name
|
Name | True | string |
Nazwa określona przez użytkownika dla tej listy kontaktów (musi być unikatowa) |
|
IsDeleted
|
IsDeleted | boolean |
W przypadku wartości true lista kontaktów zostanie oznaczona jako Usunięta |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
Count | integer |
Liczba |
|
Dane
|
Data | array of ContactsListResponse |
Dane |
|
Total
|
Total | integer |
Total |
Tworzenie wersji roboczej kampanii
Utwórz nową wersję roboczą kampanii. Obiekty Newsletter i CampaignDraft różnią się wartościami EditMode.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Aktualny
|
Current | integer |
Aktualny |
|
|
Tryb edycji
|
EditMode | string |
Tryb edycji dla wersji roboczej kampanii. |
|
|
IsStarred
|
IsStarred | boolean |
Jest gwiazdą |
|
|
IsTextPartIncluded
|
IsTextPartIncluded | boolean |
Jest uwzględniona część tekstowa |
|
|
ReplyEmail
|
ReplyEmail | string |
Wiadomość e-mail z odpowiedzią |
|
|
SenderName
|
SenderName | string |
Nazwa nadawcy |
|
|
Identyfikator szablonu
|
TemplateID | integer |
Identyfikator szablonu |
|
|
Title
|
Title | string |
Title |
|
|
ContactsListID
|
ContactsListID | string |
Identyfikator listy kontaktów |
|
|
ContactsListAlt
|
ContactsListAlt | string |
Alt listy kontaktów |
|
|
Lokalizacja
|
Locale | True | string |
Lokalizacja |
|
Identyfikator segmentacji
|
SegmentationID | integer |
Identyfikator segmentacji |
|
|
SegmentacjaAlt
|
SegmentationAlt | string |
Alt segmentacji |
|
|
Nadawca
|
Sender | string |
Nadawca |
|
|
SenderEmail
|
SenderEmail | string |
Adres e-mail nadawcy |
|
|
Temat
|
Subject | True | string |
Temat |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
Count | integer |
Liczba |
|
Dane
|
Data | array of CampaignDraftResponse |
Dane |
|
Total
|
Total | integer |
Total |
Usuń listę kontaktów
Usuwanie listy kontaktów
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator listy
|
list_ID | True | string |
Identyfikator listy |
Uzyskiwanie kontaktu według identyfikatora
Pobieranie określonego kontaktu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator kontaktu
|
contact_ID | True | string |
Unikatowy identyfikator liczbowy kontaktu, który chcesz pobrać |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
Count | integer |
Liczba |
|
Dane
|
Data | array of ContactResponse |
Dane |
|
Total
|
Total | integer |
Total |
Uzyskiwanie kontaktów
Pobierz listę wszystkich kontaktów. Zawiera informacje o stanie kontaktu i utworzeniu/sygnaturach czasowych działań
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Campaign
|
Campaign | integer |
Pobiera tylko kontakty objęte tym identyfikatorem kampanii |
|
|
Lista kontaktów
|
ContactsList | integer |
Pobiera tylko kontakty będące częścią tego identyfikatora listy kontaktów |
|
|
IsExcludedFromCampaigns
|
IsExcludedFromCampaigns | boolean |
Spowoduje pobranie tylko kontaktów, które zostały dodane do listy wykluczeń dla wiadomości e-mail marketingowych |
|
|
Ograniczenie
|
Limit | integer |
Ogranicz odpowiedź do wybranej liczby zwracanych obiektów |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
Count | integer |
Liczba |
|
Dane
|
Data | array of ContactResponse |
Dane |
|
Total
|
Total | integer |
Total |
Wyślij wiadomość e-mail w wersji 3
Wysyłanie wiadomości e-mail za pośrednictwem interfejsu API wysyłania w wersji 3
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Z adresu e-mail
|
FromEmail | True | string |
Z adresu e-mail |
|
Od nazwy
|
FromName | string |
Od nazwy |
|
|
Nadawca
|
Sender | boolean |
Nadawca |
|
|
Adres e-mail z przepisem
|
string |
|
||
|
Nazwa przepisu
|
Name | string |
Name |
|
|
Do wiadomości e-mail
|
To | True | string |
Do wiadomości e-mail |
|
Dw e-mail
|
Cc | string |
Dw e-mail |
|
|
Adres e-mail udw.
|
Bcc | string |
Adres e-mail udw. |
|
|
Temat
|
Subject | string |
Wiersz tematu wiadomości e-mail |
|
|
Część tekstowa
|
Text-part | string |
Część tekstowa |
|
|
Część HTML
|
Html-part | string |
Część HTML |
|
|
Filename
|
Filename | string |
Pełna nazwa pliku (w tym rozszerzenie pliku) |
|
|
Typ zawartości
|
Content-type | string |
Definiuje typ wysyłanej zawartości przy użyciu typu MIME |
|
|
Content
|
Content | string |
Zawartość zakodowana w formacie Base64 dołączonego pliku |
|
|
Filename
|
Filename | string |
Filename |
|
|
Typ zawartości
|
Content-type | string |
Typ zawartości |
|
|
Content
|
Content | string |
Content |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Wysłane
|
Sent | array of object |
Wysłane |
|
Email
|
Sent.Email | string |
|
|
Identyfikator komunikatu
|
Sent.MessageID | integer |
Identyfikator komunikatu |
|
Identyfikator UUID komunikatu
|
Sent.MessageUUID | string |
Identyfikator UUID komunikatu |
Wyślij wiadomość e-mail w wersji 3.1
Wysyłanie wiadomości e-mail za pośrednictwem interfejsu API wysyłania w wersji 3.1
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Z adresu e-mail
|
True | string |
Adres e-mail od |
|
|
Od nazwy
|
Name | string |
Nazwa nadawcy |
|
|
Do wiadomości e-mail
|
string |
Adres e-mail odbiorcy |
||
|
Do nazwy
|
Name | string |
Nazwa adresata |
|
|
Adres e-mail nadawcy
|
string |
Adres e-mail używany do wysyłania wiadomości |
||
|
Nazwa nadawcy
|
Name | string |
Wybrana przez użytkownika nazwa adresu e-mail nadawcy |
|
|
Odpowiedź Do wiadomości e-mail
|
string |
Odpowiedź Do wiadomości e-mail |
||
|
Nazwa odpowiedzi
|
Name | string |
Nazwa odpowiedzi |
|
|
Dw e-mail
|
string |
Dw e-mail |
||
|
Nazwa DW
|
Name | string |
Nazwa DW |
|
|
Adres e-mail udw.
|
string |
Adres e-mail udw. |
||
|
Nazwa udw.
|
Name | string |
Nazwa udw. |
|
|
Temat
|
Subject | string |
Wiersz tematu wiadomości e-mail. |
|
|
TextPart
|
TextPart | string |
Zawiera część tekstowa wiadomości |
|
|
HtmlPart
|
HTMLPart | string |
Zawiera część HTML komunikatu. |
|
|
Identyfikator szablonu
|
TemplateID | integer |
Unikatowy identyfikator liczbowy szablonu, który ma być używany jako zawartość wiadomości e-mail. |
|
|
Filename
|
Filename | string |
Pełna nazwa pliku (w tym rozszerzenie pliku) |
|
|
Typ zawartości
|
Content-type | string |
Definiuje typ wysyłanej zawartości przy użyciu typu MIME |
|
|
Content
|
Base64Content | string |
Zawartość zakodowana w formacie Base64 dołączonego pliku |
|
|
Tryb piaskownicy
|
SandboxMode | boolean |
Tryb piaskownicy |
|
|
AdvanceErrorHandling
|
AdvanceErrorHandling | boolean |
Obsługa błędów z wyprzedzeniem |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Messages
|
Messages | array of object |
Messages |
|
Status
|
Messages.Status | string |
Status |
|
Errors
|
Messages.Errors | array of object |
Errors |
|
ErrorIdentifier
|
Messages.Errors.ErrorIdentifier | string |
Identyfikator błędu |
|
ErrorCode
|
Messages.Errors.ErrorCode | string |
Kod błędu |
|
Kod stanu
|
Messages.Errors.StatusCode | integer |
Kod stanu |
|
Komunikat o błędzie
|
Messages.Errors.ErrorMessage | string |
Komunikat o błędzie |
|
ErrorRelatedTo
|
Messages.Errors.ErrorRelatedTo | string |
Błąd związany z |
|
Identyfikator niestandardowy
|
Messages.CustomID | string |
Identyfikator niestandardowy |
|
Do
|
Messages.To | array of object |
Do |
|
Email
|
Messages.To.Email | string |
|
|
Identyfikator UUID komunikatu
|
Messages.To.MessageUUID | string |
Identyfikator UUID komunikatu |
|
Identyfikator komunikatu
|
Messages.To.MessageID | integer |
Identyfikator komunikatu |
|
MessageHref
|
Messages.To.MessageHref | string |
Komunikat Href |
|
DW
|
Messages.Cc | array of object |
DW |
|
Email
|
Messages.Cc.Email | string |
|
|
Identyfikator UUID komunikatu
|
Messages.Cc.MessageUUID | string |
Identyfikator UUID komunikatu |
|
Identyfikator komunikatu
|
Messages.Cc.MessageID | integer |
Identyfikator komunikatu |
|
MessageHref
|
Messages.Cc.MessageHref | string |
Komunikat Href |
|
UDW
|
Messages.Bcc | array of object |
UDW |
|
Email
|
Messages.Bcc.Email | string |
|
|
Identyfikator UUID komunikatu
|
Messages.Bcc.MessageUUID | string |
Identyfikator UUID komunikatu |
|
Identyfikator komunikatu
|
Messages.Bcc.MessageID | integer |
Identyfikator komunikatu |
|
MessageHref
|
Messages.Bcc.MessageHref | string |
Komunikat Href |
Definicje
MessageResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
ArrivedAt
|
ArrivedAt | string |
Przybył do |
|
LiczbaZałączników
|
AttachmentCount | integer |
Liczba załączników |
|
AttemptCount
|
AttemptCount | integer |
Liczba prób |
|
Identyfikator kampanii
|
CampaignID | integer |
Identyfikator kampanii |
|
ContactAlt
|
ContactAlt | string |
Alt kontaktu |
|
Identyfikator kontaktu
|
ContactID | integer |
Identyfikator kontaktu |
|
Opóźnienie
|
Delay | number |
Opóźnienie |
|
Identyfikator docelowy
|
DestinationID | integer |
Identyfikator docelowy |
|
FilterTime
|
FilterTime | integer |
Czas filtrowania |
|
identyfikator
|
ID | integer |
identyfikator |
|
IsClickTracked
|
IsClickTracked | boolean |
Kliknij pozycję Śledzone |
|
IsHTMLPartIncluded
|
IsHTMLPartIncluded | boolean |
Jest uwzględniona część HTML |
|
IsOpenTracked
|
IsOpenTracked | boolean |
Jest otwarte śledzone |
|
IsTextPartIncluded
|
IsTextPartIncluded | boolean |
Jest uwzględniona część tekstowa |
|
IsUnsubTracked
|
IsUnsubTracked | boolean |
Czy śledzenie niesubskrypcji |
|
MessageSize
|
MessageSize | integer |
Rozmiar komunikatu |
|
Identyfikator nadawcy
|
SenderID | integer |
Identyfikator nadawcy |
|
SpamassassinScore
|
SpamassassinScore | number |
Wynik spamassassin |
|
SpamassRules
|
SpamassRules | string |
Reguły spamass |
|
Identyfikator stanu
|
StateID | integer |
Identyfikator stanu |
|
StatePermanent
|
StatePermanent | boolean |
Stan trwały |
|
Status
|
Status | string |
Status |
|
Temat
|
Subject | string |
Temat |
|
UUID
|
UUID | string |
UUID |
MessageInformationResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator kampanii
|
CampaignID | integer |
Identyfikator kampanii |
|
ClickTrackedCount
|
ClickTrackedCount | integer |
Kliknij pozycję Śledzona liczba |
|
Identyfikator kontaktu
|
ContactID | integer |
Identyfikator kontaktu |
|
Utworzono
|
CreatedAt | date-time |
Utworzono pod adresem |
|
identyfikator
|
ID | integer |
identyfikator |
|
MessageSize
|
MessageSize | integer |
Rozmiar komunikatu |
|
OpenTrackedCount
|
OpenTrackedCount | integer |
Liczba śledzonych otwartych ścieżek |
|
QueuedCount
|
QueuedCount | integer |
Liczba kolejek |
|
SendEndAt
|
SendEndAt | string |
Wyślij koniec o |
|
SentCount
|
SentCount | integer |
Liczba wysłanych |
|
SpamAssassinScore
|
SpamAssassinScore | number |
Wynik zabójcy spamu |
ContactResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
IsExcludedFromCampaigns
|
IsExcludedFromCampaigns | boolean |
Jest wykluczony zcampaigns |
|
Name
|
Name | string |
Name |
|
Utworzono
|
CreatedAt | date-time |
Utworzono pod adresem |
|
Liczba dostarczonych
|
DeliveredCount | integer |
Liczba dostarczonych |
|
Email
|
string |
|
|
|
ExclusionFromCampaignsUpdatedAt
|
ExclusionFromCampaignsUpdatedAt | string |
Wykluczenie z kampanii zaktualizowanych o godzinie |
|
identyfikator
|
ID | integer |
identyfikator |
|
IsOptInPending
|
IsOptInPending | boolean |
Is OptIn Pending |
|
IsSpamComplaining
|
IsSpamComplaining | boolean |
Czy spam skarży się |
|
LastActivityAt
|
LastActivityAt | date-time |
Ostatnie działanie o |
|
LastUpdateAt
|
LastUpdateAt | date-time |
Ostatnia aktualizacja o |
KontaktyListResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Name
|
Name | string |
Name |
|
Address
|
Address | string |
Address |
|
Utworzono
|
CreatedAt | date-time |
Utworzono pod adresem |
|
identyfikator
|
ID | integer |
identyfikator |
|
Liczba subskrybentów
|
SubscriberCount | integer |
Liczba subskrybentów |
CampaignDraftResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
AXFraction
|
AXFraction | integer |
Ułamek AX |
|
AXFractionName
|
AXFractionName | string |
Nazwa ułamka AX |
|
AXTesting
|
AXTesting | string |
Testowanie AX |
|
Aktualny
|
Current | integer |
Aktualny |
|
EditMode
|
EditMode | string |
Tryb edycji |
|
IsStarred
|
IsStarred | boolean |
Jest gwiazdą |
|
IsTextPartIncluded
|
IsTextPartIncluded | boolean |
Czy dołączono składnik TextPart |
|
ReplyEmail
|
ReplyEmail | string |
Wiadomość e-mail z odpowiedzią |
|
SenderName
|
SenderName | string |
Nazwa nadawcy |
|
Identyfikator szablonu
|
TemplateID | integer |
Identyfikator szablonu |
|
Title
|
Title | string |
Title |
|
Identyfikator kampanii
|
CampaignID | integer |
Identyfikator kampanii |
|
ContactsListID
|
ContactsListID | integer |
Identyfikator listy kontaktów |
|
Utworzono
|
CreatedAt | date-time |
Utworzono pod adresem |
|
DeliveredAt
|
DeliveredAt | date-time |
Dostarczono o |
|
identyfikator
|
ID | integer |
identyfikator |
|
Lokalizacja
|
Locale | string |
Lokalizacja |
|
ModifiedAt
|
ModifiedAt | date-time |
Zmodyfikowano o |
|
Ustawienie wstępne
|
Preset | string |
Ustawienie wstępne |
|
Identyfikator segmentacji
|
SegmentationID | integer |
Identyfikator segmentacji |
|
Nadawca
|
Sender | string |
Nadawca |
|
SenderEmail
|
SenderEmail | string |
Adres e-mail nadawcy |
|
Status
|
Status | integer |
Status |
|
Temat
|
Subject | string |
Temat |
|
URL
|
Url | string |
URL |
|
Używane
|
Used | boolean |
Używane |
ContactDataResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator kontaktu
|
ContactID | integer |
Unikatowy identyfikator liczbowy dla tego kontaktu |
|
Dane
|
Data | array of |
Tablica JSON zawierająca właściwości kontaktu i ich wartości |
|
identyfikator
|
ID | integer |
Unikatowy identyfikator liczbowy obiektu danych tego kontaktu |
|
MethodCollection
|
MethodCollection | string |
MethodCollection |