Conversas do HubSpot V2 (Editor Independente) (versão prévia)
Os serviços de conversas hubSpot permitem que você gerencie e interaja com a caixa de entrada de conversas, canais e mensagens.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| Metadados do conector | |
|---|---|
| Publicador | Troy Taylor |
| Site | https://www.hubspot.com/products/crm/conversations |
| Política de privacidade | https://legal.hubspot.com/privacy-policy |
| Categorias | Marketing; Vendas e CRM |
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: todas as regiões
Parâmetros para criar conexão.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Token de Acesso (no formato 'Portador YOUR_ACCESS_TOKEN') | secureString | O Token de Acesso (no formato 'Bearer YOUR_ACCESS_TOKEN') para esta api | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Arquiva um thread |
Arquiva um único thread. O thread será excluído permanentemente 30 dias depois de colocado em um estado arquivado. |
| Atualizar um thread |
Atualiza um único thread. O status de um thread pode ser atualizado ou o thread pode ser restaurado. |
| Enviar uma mensagem para um thread |
Envie uma nova mensagem em um thread no carimbo de data/hora atual. |
| Gerar um token |
Gera um novo token de identificação de visitante. Esse token será exclusivo sempre que esse ponto de extremidade for chamado, mesmo se for chamado com o mesmo endereço de email. Esse token é temporário e expirará após 12 horas. |
| Obter atores |
Resolva os identificadores de atores para os atores e participantes subjacentes. |
| Obter caixas de entrada de conversas |
Recupere uma lista de caixas de entrada de conversas. |
| Obter canais |
Recupere uma lista de canais. |
| Obter contas de canal |
Recupere uma lista de contas de canal. |
| Obter o conteúdo original de uma única mensagem |
Retorna o texto original completo e os corpos de rich text de uma mensagem. Isso será diferente do texto e do rich text na própria mensagem se o truncationStatus da mensagem for algo diferente de NOT_TRUNCATED. |
| Obter o histórico de mensagens para um thread |
Recupere uma lista do histórico de mensagens de um thread. |
| Obter threads |
Recupere uma lista de threads. |
| Obter um único ator |
Recupere um único ator. |
| Obter um único canal |
Recupere um único canal. |
| Obter um único thread |
Recupera um único thread. |
| Obter uma conta de canal único |
Recuperar uma conta de canal único. |
| Obter uma única caixa de entrada de conversas |
Recuperar uma única caixa de entrada de conversas. |
| Obter uma única mensagem |
Recupere uma única mensagem. |
Arquiva um thread
Arquiva um único thread. O thread será excluído permanentemente 30 dias depois de colocado em um estado arquivado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Thread ID
|
threadId | True | string |
O identificador de thread. |
Retornos
- response
- string
Atualizar um thread
Atualiza um único thread. O status de um thread pode ser atualizado ou o thread pode ser restaurado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
|
Thread ID
|
threadId | True | string |
O identificador de thread. |
|
Situação
|
status | string |
O status. |
|
|
Arquivados
|
archived | boolean |
Se arquivado. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID de contato associada
|
associatedContactId | string |
O identificador de contato associado. |
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
ID da caixa de entrada
|
inboxId | string |
O identificador da caixa de entrada. |
|
Spam
|
spam | boolean |
O spam. |
|
Situação
|
status | string |
O status. |
|
Fechado em
|
closedAt | string |
Quando fechado em. |
|
Carimbo de data/hora da mensagem mais recente
|
latestMessageTimestamp | string |
O carimbo de data/hora da mensagem mais recente. |
|
Carimbo de data/hora enviado da mensagem mais recente
|
latestMessageSentTimestamp | string |
A mensagem mais recente enviou carimbo de data/hora. |
|
Carimbo de data/hora recebido da mensagem mais recente
|
latestMessageReceivedTimestamp | string |
A mensagem mais recente recebeu carimbo de data/hora. |
|
Atribuído a
|
assignedTo | string |
O atribuído a. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
Enviar uma mensagem para um thread
Envie uma nova mensagem em um thread no carimbo de data/hora atual.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Thread ID
|
threadId | True | string |
O identificador de thread. |
|
Attachments
|
attachments | array of |
O objeto attachments. |
|
|
ID da Conta de Canal
|
channelAccountId | string |
O identificador da conta de canal. |
|
|
ID do canal
|
channelId | string |
O identificador do canal. |
|
|
Tipo
|
type | string |
O tipo. |
|
|
Value
|
value | string |
O valor. |
|
|
ID do ator
|
actorId | string |
O identificador do ator. |
|
|
Nome
|
name | string |
O nome. |
|
|
Campo destinatário
|
recipientField | string |
O campo destinatário. |
|
|
Tipo
|
type | string |
O tipo. |
|
|
Value
|
value | string |
O valor. |
|
|
ID do ator remetente
|
senderActorId | string |
O identificador do ator remetente. |
|
|
Texto
|
text | string |
O texto. |
|
|
Tipo
|
type | string |
O tipo. |
|
|
Rich Text
|
richText | string |
O texto do rick. |
|
|
Assunto
|
subject | string |
O assunto. |
Retornos
- response
- string
Gerar um token
Gera um novo token de identificação de visitante. Esse token será exclusivo sempre que esse ponto de extremidade for chamado, mesmo se for chamado com o mesmo endereço de email. Esse token é temporário e expirará após 12 horas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Email
|
string |
O endereço de email. |
||
|
Primeiro Nome
|
firstName | string |
O nome. |
|
|
Apelido
|
lastName | string |
O sobrenome. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Símbolo
|
token | string |
O token. |
Obter atores
Resolva os identificadores de atores para os atores e participantes subjacentes.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
propriedade
|
property | string |
A propriedade. |
|
|
Entradas
|
inputs | array of string |
As entradas. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
ID
|
results.id | string |
O identificador. |
|
Tipo
|
results.type | string |
O tipo. |
|
Nome
|
results.name | string |
O nome. |
|
Email
|
results.email | string |
O endereço de email. |
|
Avatar
|
results.avatar | string |
O avatar. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Obter caixas de entrada de conversas
Recupere uma lista de caixas de entrada de conversas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Após
|
after | string |
O link Depois. |
|
|
Limit
|
limit | string |
O limite de resposta. |
|
|
Classificar
|
sort | string |
A ordem de classificação. |
|
|
Comprimento da Página
|
defaultPageLength | string |
O comprimento da página padrão. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
ID
|
results.id | string |
O identificador. |
|
Nome
|
results.name | string |
O nome. |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Total
|
total | integer |
O total. |
|
Após
|
paging.next.after | string |
O link Depois. |
|
Link
|
paging.next.link | string |
O link. |
Obter canais
Recupere uma lista de canais.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Após
|
after | string |
O link Depois. |
|
|
Limit
|
limit | string |
O limite de resposta. |
|
|
Classificar
|
sort | string |
A ordem de classificação. |
|
|
Comprimento da Página
|
defaultPageLength | string |
O comprimento da página padrão. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
ID
|
results.id | string |
O identificador. |
|
Nome
|
results.name | string |
O nome. |
|
Total
|
total | integer |
O total. |
|
Após
|
paging.next.after | string |
O link Depois. |
|
Link
|
paging.next.link | string |
O link. |
Obter contas de canal
Recupere uma lista de contas de canal.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do canal
|
channelId | string |
O identificador do canal. |
|
|
ID da caixa de entrada
|
inboxId | string |
O identificador da caixa de entrada. |
|
|
Após
|
after | string |
O link Depois. |
|
|
Limit
|
limit | string |
O limite de resposta. |
|
|
Classificar
|
sort | string |
A ordem de classificação. |
|
|
Comprimento da Página
|
defaultPageLength | string |
O comprimento da página padrão. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
ID
|
results.id | string |
O identificador. |
|
ID do canal
|
results.channelId | string |
O identificador do canal. |
|
Nome
|
results.name | string |
O nome. |
|
ID da caixa de entrada
|
results.inboxId | string |
O identificador da caixa de entrada. |
|
Active
|
results.active | boolean |
Se está ativo. |
|
Autorizado
|
results.authorized | boolean |
Se autorizado. |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
Tipo
|
results.deliveryIdentifier.type | string |
O tipo. |
|
Value
|
results.deliveryIdentifier.value | string |
O valor. |
|
Total
|
total | integer |
O total. |
|
Após
|
paging.next.after | string |
O link Depois. |
|
Link
|
paging.next.link | string |
O link. |
Obter o conteúdo original de uma única mensagem
Retorna o texto original completo e os corpos de rich text de uma mensagem. Isso será diferente do texto e do rich text na própria mensagem se o truncationStatus da mensagem for algo diferente de NOT_TRUNCATED.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
propriedade
|
property | string |
A propriedade. |
|
|
Thread ID
|
threadId | True | string |
O identificador de thread. |
|
ID da mensagem
|
messageId | True | string |
O identificador da mensagem. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Texto
|
text | string |
O texto. |
|
Rich Text
|
richText | string |
O texto do rick. |
Obter o histórico de mensagens para um thread
Recupere uma lista do histórico de mensagens de um thread.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Após
|
after | string |
O link Depois. |
|
|
Limit
|
limit | string |
O limite de resposta. |
|
|
Classificar
|
sort | string |
A ordem de classificação. |
|
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
|
propriedade
|
property | string |
A propriedade. |
|
|
Thread ID
|
threadId | True | string |
O identificador de thread. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Tipo de cliente
|
results.client.clientType | string |
O tipo de cliente. |
|
ID do Aplicativo de Integração
|
results.client.integrationAppId | string |
O identificador do aplicativo de integração. |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
Criado por
|
results.createdBy | string |
O criado por. |
|
Direção
|
results.direction | string |
A direção. |
|
ID
|
results.id | string |
O identificador. |
|
Destinatários
|
results.recipients | array of object | |
|
Tipo
|
results.recipients.deliveryIdentifier.type | string |
O tipo. |
|
Value
|
results.recipients.deliveryIdentifier.value | string |
O valor. |
|
ID do ator
|
results.recipients.actorId | string |
O identificador do ator. |
|
Nome
|
results.recipients.name | string |
O nome. |
|
Campo destinatário
|
results.recipients.recipientField | string |
O campo destinatário. |
|
Remetentes
|
results.senders | array of object | |
|
ID do ator
|
results.senders.actorId | string |
O identificador do ator. |
|
Nome
|
results.senders.name | string |
O nome. |
|
Campo Remetente
|
results.senders.senderField | string |
O campo remetente. |
|
Tipo
|
results.senders.deliveryIdentifier.type | string |
O tipo. |
|
Value
|
results.senders.deliveryIdentifier.value | string |
O valor. |
|
Texto
|
results.text | string |
O texto. |
|
Status do truncamento
|
results.truncationStatus | string |
O status de truncamento. |
|
Tipo
|
results.type | string |
O tipo. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Rich Text
|
results.richText | string |
O rich text. |
|
Assunto
|
results.subject | string |
O assunto. |
|
Em Responder ao ID
|
results.inReplyToId | string |
O identificador em resposta ao identificador. |
|
Tipo de status
|
results.status.statusType | string |
O tipo de status. |
|
Mensagem de erro
|
results.status.failureDetails.errorMessage | string |
A mensagem de erro. |
|
ID do canal
|
results.channelId | string |
O identificador do canal. |
|
ID da Conta de Canal
|
results.channelAccountId | string |
O identificador da conta de canal. |
|
ID do Thread de Conversas
|
results.conversationsThreadId | string |
O identificador de thread de conversas. |
|
Após
|
paging.next.after | string |
O link Depois. |
|
Link
|
paging.next.link | string |
O link. |
Obter threads
Recupere uma lista de threads.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Após
|
after | string |
O link Depois. |
|
|
Limit
|
limit | string |
O limite de resposta. |
|
|
Classificar
|
sort | string |
A ordem de classificação. |
|
|
ID da caixa de entrada
|
inboxId | string |
O identificador da caixa de entrada. |
|
|
ID de contato associada
|
associatedContactId | string |
O identificador de contato associado. |
|
|
Thread Status
|
threadStatus | string |
O status do thread. |
|
|
Carimbo de data/hora mais recente
|
latestMessageTimestampAfter | string |
O carimbo de data/hora da mensagem mais recente depois. |
|
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
|
propriedade
|
property | string |
A propriedade. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
ID de contato associada
|
results.associatedContactId | string |
O identificador de contato associado. |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
ID da caixa de entrada
|
results.inboxId | string |
O identificador da caixa de entrada. |
|
Spam
|
results.spam | boolean |
Se spam. |
|
Situação
|
results.status | string |
O status. |
|
Fechado em
|
results.closedAt | string |
Quando fechado em. |
|
Carimbo de data/hora da mensagem mais recente
|
results.latestMessageTimestamp | string |
O carimbo de data/hora da mensagem mais recente. |
|
Carimbo de data/hora enviado da mensagem mais recente
|
results.latestMessageSentTimestamp | string |
A mensagem mais recente enviou carimbo de data/hora. |
|
Carimbo de data/hora recebido da mensagem mais recente
|
results.latestMessageReceivedTimestamp | string |
A mensagem mais recente recebeu carimbo de data/hora. |
|
Atribuído a
|
results.assignedTo | string |
O atribuído a. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Após
|
paging.next.after | string |
O link Depois. |
|
Link
|
paging.next.link | string |
O link. |
Obter um único ator
Recupere um único ator.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
propriedade
|
property | string |
A propriedade. |
|
|
ID do ator
|
actorId | True | string |
O identificador do ator. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
Tipo
|
type | string |
O tipo. |
|
Nome
|
name | string |
O nome. |
|
Email
|
string |
O endereço de email. |
|
|
Avatar
|
avatar | string |
O avatar. |
Obter um único canal
Recupere um único canal.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do canal
|
channelId | True | string |
O identificador do canal. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
Nome
|
name | string |
O nome. |
Obter um único thread
Recupera um único thread.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
|
propriedade
|
property | string |
A propriedade. |
|
|
Thread ID
|
threadId | True | string |
O identificador de thread. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID de contato associada
|
associatedContactId | string |
O identificador de contato associado. |
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
ID da caixa de entrada
|
inboxId | string |
O identificador da caixa de entrada. |
|
Spam
|
spam | boolean |
O spam. |
|
Situação
|
status | string |
O status. |
|
Fechado em
|
closedAt | string |
Quando fechado em. |
|
Carimbo de data/hora da mensagem mais recente
|
latestMessageTimestamp | string |
O carimbo de data/hora da mensagem mais recente. |
|
Carimbo de data/hora enviado da mensagem mais recente
|
latestMessageSentTimestamp | string |
A mensagem mais recente enviou carimbo de data/hora. |
|
Carimbo de data/hora recebido da mensagem mais recente
|
latestMessageReceivedTimestamp | string |
A mensagem mais recente recebeu carimbo de data/hora. |
|
Atribuído a
|
assignedTo | string |
O atribuído a. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
Obter uma conta de canal único
Recuperar uma conta de canal único.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Conta de Canal
|
channelAccountId | True | string |
O identificador da conta de canal. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
ID do canal
|
channelId | string |
O identificador do canal. |
|
Nome
|
name | string |
O nome. |
|
ID da caixa de entrada
|
inboxId | string |
O identificador da caixa de entrada. |
|
Active
|
active | boolean |
Se está ativo. |
|
Autorizado
|
authorized | boolean |
Se autorizado. |
|
Criado em
|
createdAt | string |
Quando criado em. |
|
Tipo
|
deliveryIdentifier.type | string |
O tipo. |
|
Value
|
deliveryIdentifier.value | string |
O valor. |
Obter uma única caixa de entrada de conversas
Recuperar uma única caixa de entrada de conversas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da caixa de entrada
|
inboxId | True | string |
O identificador da caixa de entrada. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
Nome
|
name | string |
O nome. |
|
Criado em
|
createdAt | string |
Quando criado em. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
Obter uma única mensagem
Recupere uma única mensagem.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
propriedade
|
property | string |
A propriedade. |
|
|
Thread ID
|
threadId | True | string |
O identificador de thread. |
|
ID da mensagem
|
messageId | True | string |
O identificador da mensagem. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Value
|
value | string |
O valor. |
Definições
cadeia
Esse é o tipo de dados básico 'string'.