Udostępnij przez

Konwersacje usługi HubSpot w wersji 2 (niezależny wydawca) (wersja zapoznawcza)

Usługi konwersacji HubSpot umożliwiają zarządzanie skrzynką odbiorczą konwersacji, kanałami i wiadomościami oraz zarządzanie nimi.

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
Email ttaylor@hitachisolutions.com
Metadane łącznika
Publisher Troy Taylor
Witryna internetowa https://www.hubspot.com/products/crm/conversations
Zasady ochrony prywatności https://legal.hubspot.com/privacy-policy
Kategorie Marketing; Sprzedaż i CRM

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 dostępu (w postaci "Bearer YOUR_ACCESS_TOKEN") securestring Token dostępu (w postaci "Bearer YOUR_ACCESS_TOKEN" dla tego interfejsu API Prawda

Limity ograniczania

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

Akcje

Aktualizowanie wątku

Aktualizuje pojedynczy wątek. Można zaktualizować stan wątku lub przywrócić wątek.
Archiwizowanie wątku

Archiwizowanie pojedynczego wątku. Wątek zostanie trwale usunięty 30 dni po umieszczeniu w stanie zarchiwizowanym.
Generowanie tokenu

Generuje nowy token identyfikacji odwiedzających. Ten token będzie unikatowy za każdym razem, gdy ten punkt końcowy jest wywoływany, nawet jeśli jest wywoływany przy użyciu tego samego adresu e-mail. Ten token jest tymczasowy i wygaśnie po upływie 12 godzin.
Pobieranie aktorów

Rozpoznawanie identyfikatorów aktorów dla podstawowych aktorów i uczestników.
Pobieranie historii komunikatów dla wątku

Pobieranie listy historii komunikatów dla wątku.
Pobieranie kanałów

Pobierz listę kanałów.
Pobieranie kont kanałów

Pobieranie listy kont kanałów.
Pobieranie oryginalnej zawartości pojedynczej wiadomości

Zwraca pełny tekst oryginalny i treść tekstu sformatowanego wiadomości. Będzie to inne niż tekst i tekst sformatowany w samej wiadomości, jeśli obcięciestatus wiadomości jest czymkolwiek innym niż NOT_TRUNCATED.
Pobieranie pojedynczego konta kanału

Pobieranie pojedynczego konta kanału.
Pobieranie pojedynczego wątku

Pobiera pojedynczy wątek.
Pobieranie pojedynczej skrzynki odbiorczej konwersacji

Pobieranie pojedynczej skrzynki odbiorczej konwersacji.
Pobieranie pojedynczej wiadomości

Pobieranie pojedynczego komunikatu.
Pobieranie skrzynek odbiorczych konwersacji

Pobierz listę skrzynek odbiorczych konwersacji.
Pobieranie wątków

Pobieranie listy wątków.
Uzyskiwanie pojedynczego aktora

Pobieranie pojedynczego aktora.
Uzyskiwanie pojedynczego kanału

Pobieranie pojedynczego kanału.
Wysyłanie wiadomości do wątku

Wyślij nową wiadomość w wątku w bieżącym znaczniku czasu.

Aktualizowanie wątku

Identyfikator operacji:
UpdateAThread

Aktualizuje pojedynczy wątek. Można zaktualizować stan wątku lub przywrócić wątek.

Parametry

Nazwa Klucz Wymagane Typ Opis
Archiwizowane
 archived boolean

Czy zarchiwizowane.
Identyfikator wątku
 threadId True string

Identyfikator wątku.
Status
 status string

Stan.
Archiwizowane
 archived boolean

Czy zarchiwizowane.

Zwraca

Nazwa Ścieżka Typ Opis
Skojarzony identyfikator kontaktu
 associatedContactId string

Skojarzony identyfikator kontaktu.
Utworzono pod adresem
 createdAt string

Po utworzeniu na.
identyfikator
 id string

Identyfikator.
Identyfikator skrzynki odbiorczej
 inboxId string

Identyfikator skrzynki odbiorczej.
Spam
 spam boolean

Spam.
Status
 status string

Stan.
Zamknięte o godzinie
 closedAt string

Po zamknięciu.
Znacznik czasu najnowszej wiadomości
 latestMessageTimestamp string

Najnowszy znacznik czasu wiadomości.
Znacznik czasu wysłania najnowszej wiadomości
 latestMessageSentTimestamp string

Najnowsza wiadomość wysłała znacznik czasu.
Znacznik czasu odebrania najnowszej wiadomości
 latestMessageReceivedTimestamp string

Ostatniej wiadomości odebrano znacznik czasu.
Przypisano do
 assignedTo string

Przypisana do.
Archiwizowane
 archived boolean

Czy zarchiwizowane.

Archiwizowanie wątku

Identyfikator operacji:
ArchivesAThread

Archiwizowanie pojedynczego wątku. Wątek zostanie trwale usunięty 30 dni po umieszczeniu w stanie zarchiwizowanym.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator wątku
 threadId True string

Identyfikator wątku.

Zwraca

response
string

Generowanie tokenu

Identyfikator operacji:
GenerateAToken

Generuje nowy token identyfikacji odwiedzających. Ten token będzie unikatowy za każdym razem, gdy ten punkt końcowy jest wywoływany, nawet jeśli jest wywoływany przy użyciu tego samego adresu e-mail. Ten token jest tymczasowy i wygaśnie po upływie 12 godzin.

Parametry

Nazwa Klucz Wymagane Typ Opis
Email
 email string

Adres e-mail.
Imię
 firstName string

Imię.
Nazwisko
 lastName string

Nazwisko.

Zwraca

Nazwa Ścieżka Typ Opis
Żeton
 token string

Znacznik.

Pobieranie aktorów

Identyfikator operacji:
GetActors

Rozpoznawanie identyfikatorów aktorów dla podstawowych aktorów i uczestników.

Parametry

Nazwa Klucz Wymagane Typ Opis
właściwość
 property string

Właściwość .
Dane wejściowe
 inputs array of string

Dane wejściowe.

Zwraca

Nazwa Ścieżka Typ Opis
Ukończono o
 completedAt string

Po zakończeniu na.
Results
 results array of object
identyfikator
 results.id string

Identyfikator.
Typ
 results.type string

Typ.
Name
 results.name string

Nazwa.
Email
 results.email string

Adres e-mail.
Awatar
 results.avatar string

Awatar.
Rozpoczęto o
 startedAt string

Po rozpoczęciu o.
Status
 status string

Stan.
Zażądano na
 requestedAt string

Po żądaniu na.

Pobieranie historii komunikatów dla wątku

Identyfikator operacji:
GetMessageHistoryForAThread

Pobieranie listy historii komunikatów dla wątku.

Parametry

Nazwa Klucz Wymagane Typ Opis
Po
 after string

Link Po.
Ograniczenie
 limit string

Limit odpowiedzi.
Sortuj
 sort string

Kolejność sortowania.
Archiwizowane
 archived boolean

Czy zarchiwizowane.
właściwość
 property string

Właściwość .
Identyfikator wątku
 threadId True string

Identyfikator wątku.

Zwraca

Nazwa Ścieżka Typ Opis
Results
 results array of object
Archiwizowane
 results.archived boolean

Czy zarchiwizowane.
Typ klienta
 results.client.clientType string

Typ klienta.
Identyfikator aplikacji integracji
 results.client.integrationAppId string

Identyfikator aplikacji integracji.
Utworzono pod adresem
 results.createdAt string

Po utworzeniu na.
Stworzone przez
 results.createdBy string

Utworzony przez.
Direction
 results.direction string

Kierunek.
identyfikator
 results.id string

Identyfikator.
Adresatów
 results.recipients array of object
Typ
 results.recipients.deliveryIdentifier.type string

Typ.
Wartość
 results.recipients.deliveryIdentifier.value string

Wartość.
Identyfikator aktora
 results.recipients.actorId string

Identyfikator aktora.
Name
 results.recipients.name string

Nazwa.
Pole adresata
 results.recipients.recipientField string

Pole adresata.
Nadawców
 results.senders array of object
Identyfikator aktora
 results.senders.actorId string

Identyfikator aktora.
Name
 results.senders.name string

Nazwa.
Pole nadawcy
 results.senders.senderField string

Pole nadawcy.
Typ
 results.senders.deliveryIdentifier.type string

Typ.
Wartość
 results.senders.deliveryIdentifier.value string

Wartość.
Tekst
 results.text string

Tekst.
Stan obcięcia
 results.truncationStatus string

Stan obcięcia.
Typ
 results.type string

Typ.
Zaktualizowano o
 results.updatedAt string

Po zaktualizowaniu o.
Tekst sformatowany
 results.richText string

Tekst sformatowany.
Temat
 results.subject string

Temat.
W odpowiedzi na identyfikator
 results.inReplyToId string

Element w odpowiedzi na identyfikator.
Typ stanu
 results.status.statusType string

Typ stanu.
Komunikat o błędzie
 results.status.failureDetails.errorMessage string

Komunikat o błędzie.
Identyfikator kanału
 results.channelId string

Identyfikator kanału.
Identyfikator konta kanału
 results.channelAccountId string

Identyfikator konta kanału.
Identyfikator wątku konwersacji
 results.conversationsThreadId string

Identyfikator wątku konwersacji.
Po
 paging.next.after string

Link Po.
Link
 paging.next.link string

Łącze.

Pobieranie kanałów

Identyfikator operacji:
GetChannels

Pobierz listę kanałów.

Parametry

Nazwa Klucz Wymagane Typ Opis
Po
 after string

Link Po.
Ograniczenie
 limit string

Limit odpowiedzi.
Sortuj
 sort string

Kolejność sortowania.
Długość strony
 defaultPageLength string

Domyślna długość strony.

Zwraca

Nazwa Ścieżka Typ Opis
Results
 results array of object
identyfikator
 results.id string

Identyfikator.
Name
 results.name string

Nazwa.
Total
 total integer

Suma.
Po
 paging.next.after string

Link Po.
Link
 paging.next.link string

Łącze.

Pobieranie kont kanałów

Identyfikator operacji:
GetChannelAccounts

Pobieranie listy kont kanałów.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator kanału
 channelId string

Identyfikator kanału.
Identyfikator skrzynki odbiorczej
 inboxId string

Identyfikator skrzynki odbiorczej.
Po
 after string

Link Po.
Ograniczenie
 limit string

Limit odpowiedzi.
Sortuj
 sort string

Kolejność sortowania.
Długość strony
 defaultPageLength string

Domyślna długość strony.

Zwraca

Nazwa Ścieżka Typ Opis
Results
 results array of object
identyfikator
 results.id string

Identyfikator.
Identyfikator kanału
 results.channelId string

Identyfikator kanału.
Name
 results.name string

Nazwa.
Identyfikator skrzynki odbiorczej
 results.inboxId string

Identyfikator skrzynki odbiorczej.
Aktywna
 results.active boolean

Czy aktywne.
Autoryzowanych
 results.authorized boolean

Czy autoryzowany.
Utworzono pod adresem
 results.createdAt string

Po utworzeniu na.
Typ
 results.deliveryIdentifier.type string

Typ.
Wartość
 results.deliveryIdentifier.value string

Wartość.
Total
 total integer

Suma.
Po
 paging.next.after string

Link Po.
Link
 paging.next.link string

Łącze.

Pobieranie oryginalnej zawartości pojedynczej wiadomości

Identyfikator operacji:
GetTheOriginalContentOfASingleMessage

Zwraca pełny tekst oryginalny i treść tekstu sformatowanego wiadomości. Będzie to inne niż tekst i tekst sformatowany w samej wiadomości, jeśli obcięciestatus wiadomości jest czymkolwiek innym niż NOT_TRUNCATED.

Parametry

Nazwa Klucz Wymagane Typ Opis
właściwość
 property string

Właściwość .
Identyfikator wątku
 threadId True string

Identyfikator wątku.
Identyfikator komunikatu
 messageId True string

Identyfikator komunikatu.

Zwraca

Nazwa Ścieżka Typ Opis
Tekst
 text string

Tekst.
Tekst sformatowany
 richText string

Tekst kryki.

Pobieranie pojedynczego konta kanału

Identyfikator operacji:
GetASingleChannelAccount

Pobieranie pojedynczego konta kanału.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator konta kanału
 channelAccountId True string

Identyfikator konta kanału.

Zwraca

Nazwa Ścieżka Typ Opis
identyfikator
 id string

Identyfikator.
Identyfikator kanału
 channelId string

Identyfikator kanału.
Name
 name string

Nazwa.
Identyfikator skrzynki odbiorczej
 inboxId string

Identyfikator skrzynki odbiorczej.
Aktywna
 active boolean

Czy aktywne.
Autoryzowanych
 authorized boolean

Czy autoryzowany.
Utworzono pod adresem
 createdAt string

Po utworzeniu na.
Typ
 deliveryIdentifier.type string

Typ.
Wartość
 deliveryIdentifier.value string

Wartość.

Pobieranie pojedynczego wątku

Identyfikator operacji:
GetASingleThread

Pobiera pojedynczy wątek.

Parametry

Nazwa Klucz Wymagane Typ Opis
Archiwizowane
 archived boolean

Czy zarchiwizowane.
właściwość
 property string

Właściwość .
Identyfikator wątku
 threadId True string

Identyfikator wątku.

Zwraca

Nazwa Ścieżka Typ Opis
Skojarzony identyfikator kontaktu
 associatedContactId string

Skojarzony identyfikator kontaktu.
Utworzono pod adresem
 createdAt string

Po utworzeniu na.
identyfikator
 id string

Identyfikator.
Identyfikator skrzynki odbiorczej
 inboxId string

Identyfikator skrzynki odbiorczej.
Spam
 spam boolean

Spam.
Status
 status string

Stan.
Zamknięte o godzinie
 closedAt string

Po zamknięciu.
Znacznik czasu najnowszej wiadomości
 latestMessageTimestamp string

Najnowszy znacznik czasu wiadomości.
Znacznik czasu wysłania najnowszej wiadomości
 latestMessageSentTimestamp string

Najnowsza wiadomość wysłała znacznik czasu.
Znacznik czasu odebrania najnowszej wiadomości
 latestMessageReceivedTimestamp string

Ostatniej wiadomości odebrano znacznik czasu.
Przypisano do
 assignedTo string

Przypisana do.
Archiwizowane
 archived boolean

Czy zarchiwizowane.

Pobieranie pojedynczej skrzynki odbiorczej konwersacji

Identyfikator operacji:
GetASingleConversationsInbox

Pobieranie pojedynczej skrzynki odbiorczej konwersacji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator skrzynki odbiorczej
 inboxId True string

Identyfikator skrzynki odbiorczej.

Zwraca

Nazwa Ścieżka Typ Opis
identyfikator
 id string

Identyfikator.
Name
 name string

Nazwa.
Utworzono pod adresem
 createdAt string

Po utworzeniu na.
Zaktualizowano o
 updatedAt string

Po zaktualizowaniu o.

Pobieranie pojedynczej wiadomości

Identyfikator operacji:
GetASingleMessage

Pobieranie pojedynczego komunikatu.

Parametry

Nazwa Klucz Wymagane Typ Opis
właściwość
 property string

Właściwość .
Identyfikator wątku
 threadId True string

Identyfikator wątku.
Identyfikator komunikatu
 messageId True string

Identyfikator komunikatu.

Zwraca

Nazwa Ścieżka Typ Opis
Wartość
 value string

Wartość.

Pobieranie skrzynek odbiorczych konwersacji

Identyfikator operacji:
GetConversationsInboxes

Pobierz listę skrzynek odbiorczych konwersacji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Po
 after string

Link Po.
Ograniczenie
 limit string

Limit odpowiedzi.
Sortuj
 sort string

Kolejność sortowania.
Długość strony
 defaultPageLength string

Domyślna długość strony.

Zwraca

Nazwa Ścieżka Typ Opis
Results
 results array of object
identyfikator
 results.id string

Identyfikator.
Name
 results.name string

Nazwa.
Utworzono pod adresem
 results.createdAt string

Po utworzeniu na.
Zaktualizowano o
 results.updatedAt string

Po zaktualizowaniu o.
Total
 total integer

Suma.
Po
 paging.next.after string

Link Po.
Link
 paging.next.link string

Łącze.

Pobieranie wątków

Identyfikator operacji:
GetThreads

Pobieranie listy wątków.

Parametry

Nazwa Klucz Wymagane Typ Opis
Po
 after string

Link Po.
Ograniczenie
 limit string

Limit odpowiedzi.
Sortuj
 sort string

Kolejność sortowania.
Identyfikator skrzynki odbiorczej
 inboxId string

Identyfikator skrzynki odbiorczej.
Skojarzony identyfikator kontaktu
 associatedContactId string

Skojarzony identyfikator kontaktu.
Stan wątku
 threadStatus string

Stan wątku.
Najnowszy znacznik czasu
 latestMessageTimestampAfter string

Najnowszy znacznik czasu komunikatu po.
Archiwizowane
 archived boolean

Czy zarchiwizowane.
właściwość
 property string

Właściwość .

Zwraca

Nazwa Ścieżka Typ Opis
Results
 results array of object
Skojarzony identyfikator kontaktu
 results.associatedContactId string

Skojarzony identyfikator kontaktu.
Utworzono pod adresem
 results.createdAt string

Po utworzeniu na.
identyfikator
 results.id string

Identyfikator.
Identyfikator skrzynki odbiorczej
 results.inboxId string

Identyfikator skrzynki odbiorczej.
Spam
 results.spam boolean

Czy spam.
Status
 results.status string

Stan.
Zamknięte o godzinie
 results.closedAt string

Po zamknięciu.
Znacznik czasu najnowszej wiadomości
 results.latestMessageTimestamp string

Najnowszy znacznik czasu wiadomości.
Znacznik czasu wysłania najnowszej wiadomości
 results.latestMessageSentTimestamp string

Najnowsza wiadomość wysłała znacznik czasu.
Znacznik czasu odebrania najnowszej wiadomości
 results.latestMessageReceivedTimestamp string

Ostatniej wiadomości odebrano znacznik czasu.
Przypisano do
 results.assignedTo string

Przypisana do.
Archiwizowane
 results.archived boolean

Czy zarchiwizowane.
Po
 paging.next.after string

Link Po.
Link
 paging.next.link string

Łącze.

Uzyskiwanie pojedynczego aktora

Identyfikator operacji:
GetASingleActor

Pobieranie pojedynczego aktora.

Parametry

Nazwa Klucz Wymagane Typ Opis
właściwość
 property string

Właściwość .
Identyfikator aktora
 actorId True string

Identyfikator aktora.

Zwraca

Nazwa Ścieżka Typ Opis
identyfikator
 id string

Identyfikator.
Typ
 type string

Typ.
Name
 name string

Nazwa.
Email
 email string

Adres e-mail.
Awatar
 avatar string

Awatar.

Uzyskiwanie pojedynczego kanału

Identyfikator operacji:
GetASingleChannel

Pobieranie pojedynczego kanału.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator kanału
 channelId True string

Identyfikator kanału.

Zwraca

Nazwa Ścieżka Typ Opis
identyfikator
 id string

Identyfikator.
Name
 name string

Nazwa.

Wysyłanie wiadomości do wątku

Identyfikator operacji:
SendAMessageToAThread

Wyślij nową wiadomość w wątku w bieżącym znaczniku czasu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator wątku
 threadId True string

Identyfikator wątku.
Załączniki
 attachments array of

Obiekt załączników.
Identyfikator konta kanału
 channelAccountId string

Identyfikator konta kanału.
Identyfikator kanału
 channelId string

Identyfikator kanału.
Typ
 type string

Typ.
Wartość
 value string

Wartość.
Identyfikator aktora
 actorId string

Identyfikator aktora.
Name
 name string

Nazwa.
Pole adresata
 recipientField string

Pole adresata.
Typ
 type string

Typ.
Wartość
 value string

Wartość.
Identyfikator aktora nadawcy
 senderActorId string

Identyfikator aktora nadawcy.
Tekst
 text string

Tekst.
Typ
 type string

Typ.
Tekst sformatowany
 richText string

Tekst kryki.
Temat
 subject string

Temat.

Zwraca

response
string

Definicje

ciąg

Jest to podstawowy typ danych "string".