Partilhar via

HubSpot Conversations V2 (Editora Independente) (Visualização)

Os serviços de conversas do HubSpot permitem que você gerencie e interaja com a caixa de entrada, canais e mensagens das conversas.

Este conector está disponível nos seguintes produtos e regiões:

Serviço Class Regiões
Estúdio Copiloto Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas Standard Todas as regiões do Logic Apps , exceto as seguintes:
     - Regiões do Azure Government
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Aplicações Power Premium Todas as regiões do Power Apps , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Automatize o poder Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Troia Taylor
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Metadados do conector
Editora Troia Taylor
Sítio Web https://www.hubspot.com/products/crm/conversations
Política de privacidade https://legal.hubspot.com/privacy-policy
Categorias Marketing; Vendas e CRM

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:
Predefinição 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.

Esta conexão não é compartilhável. Se o aplicativo avançado 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 (na forma 'YOUR_ACCESS_TOKEN ao portador') securestring O token de acesso (no formato 'Bearer YOUR_ACCESS_TOKEN') para esta api Verdade

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de API por conexão 100 60 segundos

Ações

Arquiva um tópico

Arquiva um único thread. O thread será excluído permanentemente 30 dias após ser 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. Este token será único sempre que este endpoint for chamado, mesmo que seja chamado com o mesmo endereço de e-mail. Este token é temporário e expirará após 12 horas.
Obtenha um único canal

Recupere um único canal.
Obtenha uma conta de canal único

Recupere uma conta de canal único.
Obter atores

Resolva 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 histórico de mensagens para um thread

Recupere uma lista do histórico de mensagens de um thread.
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 tópicos

Recupere uma lista de threads.
Obter um único ator

Recupere um único ator.
Obter um único thread

Recupera um único thread.
Obter uma única caixa de entrada de conversas

Recupere uma única caixa de entrada de conversas.
Receba uma única mensagem

Recupere uma única mensagem.

Arquiva um tópico

ID da Operação:
ArchivesAThread

Arquiva um único thread. O thread será excluído permanentemente 30 dias após ser colocado em um estado arquivado.

Parâmetros

Name Chave Necessário Tipo Description
Thread ID
 threadId True string

O identificador de thread.

Devoluções

response
string

Atualizar um thread

ID da Operação:
UpdateAThread

Atualiza um único thread. O status de um thread pode ser atualizado ou o thread pode ser restaurado.

Parâmetros

Name Chave Necessário Tipo Description
Arquivado
 archived boolean

Se arquivado.
Thread ID
 threadId True string

O identificador de thread.
Situação
 status string

O status.
Arquivado
 archived boolean

Se arquivado.

Devoluções

Name Caminho Tipo Description
ID de contato associado
 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 (correio não solicitado)
 spam boolean

O spam.
Situação
 status string

O status.
Fechado em
 closedAt string

Quando fechado em.
Carimbo de data/hora da última mensagem
 latestMessageTimestamp string

O carimbo de data/hora da mensagem mais recente.
Carimbo de data/hora da última mensagem enviada
 latestMessageSentTimestamp string

A última mensagem enviada carimbo de data/hora.
Carimbo de data/hora recebido da última mensagem
 latestMessageReceivedTimestamp string

A última mensagem recebida carimbo de data/hora.
Atribuído A
 assignedTo string

O atribuído a.
Arquivado
 archived boolean

Se arquivado.

Enviar uma mensagem para um thread

ID da Operação:
SendAMessageToAThread

Envie uma nova mensagem em um thread no carimbo de data/hora atual.

Parâmetros

Name Chave Necessário Tipo Description
Thread ID
 threadId True string

O identificador de thread.
Attachments
 attachments array of

O objeto attachments.
ID da conta do canal
 channelAccountId string

O identificador da conta do canal.
ID do canal
 channelId string

O identificador do canal.
Tipo
 type string

O tipo.
Valor
 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.
Valor
 value string

O valor.
ID do Ator do Remetente
 senderActorId string

O identificador do ator remetente.
Texto
 text string

O texto.
Tipo
 type string

O tipo.
Rich Text
 richText string

O texto rick.
Assunto
 subject string

O assunto.

Devoluções

response
string

Gerar um token

ID da Operação:
GenerateAToken

Gera um novo token de identificação de visitante. Este token será único sempre que este endpoint for chamado, mesmo que seja chamado com o mesmo endereço de e-mail. Este token é temporário e expirará após 12 horas.

Parâmetros

Name Chave Necessário Tipo Description
Email
 email string

O endereço de e-mail.
Nome Próprio
 firstName string

O primeiro nome.
Apelido
 lastName string

O sobrenome.

Devoluções

Name Caminho Tipo Description
Símbolo
 token string

O token.

Obtenha um único canal

ID da Operação:
GetASingleChannel

Recupere um único canal.

Parâmetros

Name Chave Necessário Tipo Description
ID do canal
 channelId True string

O identificador do canal.

Devoluções

Name Caminho Tipo Description
ID
 id string

O identificador.
Nome
 name string

O nome.

Obtenha uma conta de canal único

ID da Operação:
GetASingleChannelAccount

Recupere uma conta de canal único.

Parâmetros

Name Chave Necessário Tipo Description
ID da conta do canal
 channelAccountId True string

O identificador da conta do canal.

Devoluções

Name 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 ativo.
Autorizado
 authorized boolean

Se autorizado.
Criado em
 createdAt string

Quando criado em.
Tipo
 deliveryIdentifier.type string

O tipo.
Valor
 deliveryIdentifier.value string

O valor.

Obter atores

ID da Operação:
GetActors

Resolva identificadores de atores para os atores e participantes subjacentes.

Parâmetros

Name Chave Necessário Tipo Description
propriedade
 property string

A propriedade.
Insumos
 inputs array of string

Os inputs.

Devoluções

Name 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 e-mail.
Avatar
 results.avatar string

O avatar.
Começou em
 startedAt string

Quando iniciado em.
Situação
 status string

O status.
Solicitado em
 requestedAt string

Quando solicitado em.

Obter caixas de entrada de conversas

ID da Operação:
GetConversationsInboxes

Recupere uma lista de caixas de entrada de conversas.

Parâmetros

Name Chave Necessário Tipo Description
Depois
 after string

O link Depois.
Limite
 limit string

O limite de resposta.
Ordenar
 sort string

A ordem de classificação.
Comprimento da página
 defaultPageLength string

O comprimento de página padrão.

Devoluções

Name 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.
Depois
 paging.next.after string

O link Depois.
Link
 paging.next.link string

O link.

Obter canais

ID da Operação:
GetChannels

Recupere uma lista de canais.

Parâmetros

Name Chave Necessário Tipo Description
Depois
 after string

O link Depois.
Limite
 limit string

O limite de resposta.
Ordenar
 sort string

A ordem de classificação.
Comprimento da página
 defaultPageLength string

O comprimento de página padrão.

Devoluções

Name 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.
Depois
 paging.next.after string

O link Depois.
Link
 paging.next.link string

O link.

Obter contas de canal

ID da Operação:
GetChannelAccounts

Recupere uma lista de contas de canal.

Parâmetros

Name Chave Necessá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.
Depois
 after string

O link Depois.
Limite
 limit string

O limite de resposta.
Ordenar
 sort string

A ordem de classificação.
Comprimento da página
 defaultPageLength string

O comprimento de página padrão.

Devoluções

Name 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 ativo.
Autorizado
 results.authorized boolean

Se autorizado.
Criado em
 results.createdAt string

Quando criado em.
Tipo
 results.deliveryIdentifier.type string

O tipo.
Valor
 results.deliveryIdentifier.value string

O valor.
Total
 total integer

O total.
Depois
 paging.next.after string

O link Depois.
Link
 paging.next.link string

O link.

Obter histórico de mensagens para um thread

ID da Operação:
GetMessageHistoryForAThread

Recupere uma lista do histórico de mensagens de um thread.

Parâmetros

Name Chave Necessário Tipo Description
Depois
 after string

O link Depois.
Limite
 limit string

O limite de resposta.
Ordenar
 sort string

A ordem de classificação.
Arquivado
 archived boolean

Se arquivado.
propriedade
 property string

A propriedade.
Thread ID
 threadId True string

O identificador de thread.

Devoluções

Name Caminho Tipo Description
Results
 results array of object
Arquivado
 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.
Direction
 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.
Valor
 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 do remetente
 results.senders.senderField string

O campo remetente.
Tipo
 results.senders.deliveryIdentifier.type string

O tipo.
Valor
 results.senders.deliveryIdentifier.value string

O valor.
Texto
 results.text string

O texto.
Status de 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 resposta ao ID
 results.inReplyToId string

O 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 do canal
 results.channelAccountId string

O identificador da conta do canal.
ID do Thread de Conversas
 results.conversationsThreadId string

O identificador de thread de conversas.
Depois
 paging.next.after string

O link Depois.
Link
 paging.next.link string

O link.

Obter o conteúdo original de uma única mensagem

ID da Operação:
GetTheOriginalContentOfASingleMessage

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

Name Chave Necessá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.

Devoluções

Name Caminho Tipo Description
Texto
 text string

O texto.
Rich Text
 richText string

O texto rick.

Obter tópicos

ID da Operação:
GetThreads

Recupere uma lista de threads.

Parâmetros

Name Chave Necessário Tipo Description
Depois
 after string

O link Depois.
Limite
 limit string

O limite de resposta.
Ordenar
 sort string

A ordem de classificação.
ID da caixa de entrada
 inboxId string

O identificador da caixa de entrada.
ID de contato associado
 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 última mensagem depois.
Arquivado
 archived boolean

Se arquivado.
propriedade
 property string

A propriedade.

Devoluções

Name Caminho Tipo Description
Results
 results array of object
ID de contato associado
 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 (correio não solicitado)
 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 última mensagem
 results.latestMessageTimestamp string

O carimbo de data/hora da mensagem mais recente.
Carimbo de data/hora da última mensagem enviada
 results.latestMessageSentTimestamp string

A última mensagem enviada carimbo de data/hora.
Carimbo de data/hora recebido da última mensagem
 results.latestMessageReceivedTimestamp string

A última mensagem recebida carimbo de data/hora.
Atribuído A
 results.assignedTo string

O atribuído a.
Arquivado
 results.archived boolean

Se arquivado.
Depois
 paging.next.after string

O link Depois.
Link
 paging.next.link string

O link.

Obter um único ator

ID da Operação:
GetASingleActor

Recupere um único ator.

Parâmetros

Name Chave Necessário Tipo Description
propriedade
 property string

A propriedade.
ID do ator
 actorId True string

O identificador do ator.

Devoluções

Name Caminho Tipo Description
ID
 id string

O identificador.
Tipo
 type string

O tipo.
Nome
 name string

O nome.
Email
 email string

O endereço de e-mail.
Avatar
 avatar string

O avatar.

Obter um único thread

ID da Operação:
GetASingleThread

Recupera um único thread.

Parâmetros

Name Chave Necessário Tipo Description
Arquivado
 archived boolean

Se arquivado.
propriedade
 property string

A propriedade.
Thread ID
 threadId True string

O identificador de thread.

Devoluções

Name Caminho Tipo Description
ID de contato associado
 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 (correio não solicitado)
 spam boolean

O spam.
Situação
 status string

O status.
Fechado em
 closedAt string

Quando fechado em.
Carimbo de data/hora da última mensagem
 latestMessageTimestamp string

O carimbo de data/hora da mensagem mais recente.
Carimbo de data/hora da última mensagem enviada
 latestMessageSentTimestamp string

A última mensagem enviada carimbo de data/hora.
Carimbo de data/hora recebido da última mensagem
 latestMessageReceivedTimestamp string

A última mensagem recebida carimbo de data/hora.
Atribuído A
 assignedTo string

O atribuído a.
Arquivado
 archived boolean

Se arquivado.

Obter uma única caixa de entrada de conversas

ID da Operação:
GetASingleConversationsInbox

Recupere uma única caixa de entrada de conversas.

Parâmetros

Name Chave Necessário Tipo Description
ID da caixa de entrada
 inboxId True string

O identificador da caixa de entrada.

Devoluções

Name 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.

Receba uma única mensagem

ID da Operação:
GetASingleMessage

Recupere uma única mensagem.

Parâmetros

Name Chave Necessá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.

Devoluções

Name Caminho Tipo Description
Valor
 value string

O valor.

Definições

cadeia (de caracteres)

Este é o tipo de dados básico 'string'.