Estas são respostas para perguntas frequentes relacionadas a:

Você pode criar um novo workspace de desenvolvedor para desenvolver apps. Workspaces de desenvolvedor são gratuitos e destinados apenas para fins de desenvolvimento. Depois de criar o novo workspace, você pode seguir este guia para criar um app e fazer sua primeira chamada API.

Você pode criar um novo app para seu workspace de produção e obter o token de acesso do app acessando https://app.intercom.com/a/apps/{your-workspace-id}/developer-hub/

Quando você ativa seu Articles Help Center, seu conteúdo fica disponível por padrão através do intercom.help. Sua URL ficará assim: intercom.help/exampleapp.

Se quiser usar uma URL diferente, você pode criar uma configurando manualmente um domínio customizado. Isso envolve inserir o domínio customizado nas configurações do seu Help Center, criar um registro CNAME customizado e, opcionalmente, configurar SSL. Encontre as instruções completas para configuração em nossa documentação para desenvolvedores.

SSL (ou TLS) é a forma mais usada para proteger a conexão entre seu servidor e seu navegador. Garante que a conexão entre servidor e navegador seja criptografada e segura, aparecendo como HTTPS.

Existem duas formas de configurar SSL com Articles no seu domínio customizado:

Sim! Se você ativar “HTTPS (quick setup)” nas configurações do seu Help Center, o Intercom irá provisionar e gerenciar automaticamente um certificado SSL para seu domínio customizado (como https://help.ourdomain.com). Não há necessidade de configuração manual de SSL — basta apontar seu CNAME para us.intercomhelpcenter.com, e cuidaremos do resto.

Se você pretende mudar seu domínio customizado para HTTPS:

Você pode configurar SSL para seu domínio customizado para manter informações sensíveis criptografadas. Se quiser fazer isso, certifique-se de que configurou seu CNAME com um provedor DNS que suporte SSL, como Cloudflare.

Siga o guia em nossa documentação para desenvolvedores para configurar SSL. Note que, dependendo do provedor escolhido, os passos de configuração podem variar.

1. Domain Não Seguro

A versão atual da API é 2.15. Você pode encontrar a documentação da API em nosso site de documentação para desenvolvedores. Você também pode alterar a versão que seu app está usando no seu Developer Hub seguindo os passos listados neste guia.

Se você estiver usando a API Intercom, também pode alterar a versão dentro do cabeçalho HTTP da sua requisição.

Os seguintes endpoints estão disponíveis na versão 2.15 da API Intercom:

Sim, se você quiser abrir um artigo no Messenger, pode usar o método showArticle da API JavaScript. O artigo será aberto dentro do Messenger e clicar no botão de voltar do Messenger retornará ao contexto anterior. Se o Messenger estiver fechado quando o método for chamado, ele será aberto primeiro e então o artigo será exibido. Isso está disponível em todas as plataformas no Messenger.

No Intercom, users são classificados como contacts. Não há endpoint para criar contacts em massa usando a API, mas você pode usar o endpoint de criação de contacts para criar um script que importe users ou seguir este tutorial que fornecerá exemplos de código para começar.

Certifique-se de configurar uma verificação de limite de taxa para garantir que você não ultrapasse o limite, que atualmente é de 10.000 chamadas API por minuto para cada app e 25.000 chamadas API por minuto por workspace.

Para recuperar os dados de um contact arquivado, primeiro você precisa desarquivar o contact, o que pode ser feito com o endpoint de desarquivamento de contact se você tiver o ID do contact.

Então você poderá acessar os dados do contact através do endpoint para obter um contact e suas conversas através do endpoint para recuperar uma conversa.

Não, atualmente não há como deletar notas individuais ou em massa dos contacts via API. Se essa funcionalidade for importante para suas operações, por favor visite o Product Wishlist para criar, comentar ou votar em um pedido de recurso. Notas podem ser deletadas manualmente dentro do workspace, mas apenas uma por vez.

Se você quiser atribuir uma conversa a uma equipe usando a API, você tem duas opções.

A primeira opção é atribuir uma conversa diretamente a um administrador ou a uma equipe usando o endpoint da API para gerenciar uma conversa. Você precisa ter acesso ao id provisionado do Intercom para a conversa, bem como ao admin_id e ao assignee_id.

A outra opção é executar regras de atribuição que você já configurou na conversa usando o endpoint da API para executar regras de atribuição em uma conversa. Você precisa ter acesso ao id provisionado do Intercom para a conversa.

Você pode testar a funcionalidade no recurso "Try It" na nossa documentação para desenvolvedores, na coleção Intercom Postman ou no seu próprio terminal ou IDE. Não esqueça de usar seu token de acesso Intercom como token bearer.

Uma nota é um comentário interno visível apenas para os colegas de equipe. Para adicionar uma nota a uma conversa, você pode usar o endpoint da API para responder a uma conversa. Você precisará escolher um messsage_type de note e um tipo "admin", junto com o admin_id de quem a nota deve vir.

Você pode testar a funcionalidade no recurso "Try It" na nossa documentação para desenvolvedores, na coleção Intercom Postman ou no seu próprio terminal ou IDE. Não esqueça de usar seu token de acesso Intercom como token bearer.

Se você já criou uma tag na interface, pode usar essa tag para aplicar às conversas. Você também pode criar uma nova tag usando a API.

Para usar o endpoint da API para adicionar tag a uma conversa, você precisará ter acesso ao conversation_id da conversa a ser marcada, ao id provisionado do Intercom da tag e ao admin_id.

Você pode testar a funcionalidade no recurso "Try It" na nossa documentação para desenvolvedores, na coleção Intercom Postman ou no seu próprio terminal ou IDE. Não esqueça de usar seu token de acesso Intercom como token bearer.

Você pode criar uma conversa pela API que tenha sido iniciada por um contato (ou seja, user ou lead) usando o endpoint da API para criar uma conversa. A conversa pode ser apenas uma mensagem in-app.

Você também precisará do id provisionado do Intercom para o contato e do texto do corpo. Use para iniciar a conversa.

Você pode testar a funcionalidade no recurso "Try It" na nossa documentação para desenvolvedores, na coleção Intercom Postman ou no seu próprio terminal ou IDE. Não esqueça de usar seu token de acesso Intercom como token bearer.

Para fechar uma conversa usando a API, você pode usar o endpoint da API para gerenciar uma conversa. Você precisará do id provisionado do Intercom da conversa, seu admin_id e usar um message_type de "close".

Se precisar redigir apenas uma parte da conversa, use o endpoint da API para redigir uma parte da conversa.

Você pode testar a funcionalidade no recurso "Try It" na nossa documentação para desenvolvedores, na coleção Intercom Postman ou no seu próprio terminal ou IDE. Não esqueça de usar seu token de acesso Intercom como token bearer.

Para configurar uma notificação personalizada quando uma ação for tomada, como um colega de equipe ser atribuído a uma conversa, você pode usar webhooks.

Você vai querer usar o tópico conversation.admin.assigned. Você pode encontrar todos os tópicos de conversa na nossa documentação para desenvolvedores.

Você pode então se inscrever nesse tópico de webhook no hub de desenvolvedores seguindo os passos deste guia aqui. Também precisará ter uma URL de endpoint publicamente acessível disponível para que a ação seja executada assim que o webhook for acionado para entregar a notificação ao seu canal preferido.

Side conversations não têm um endpoint dedicado, então você não pode recuperá-las diretamente. No entanto, quando você recupera uma conversa à qual a side conversation está anexada, verá partes da conversa que aparecem como "part_type": "side_conversation_reply" com o conteúdo das mensagens do user na side conversation.

Para criar um ticket usando a API do Intercom, você primeiro precisará criar ou obter o tipo de ticket para rotular o novo ticket. Depois, pode criar o ticket usando uma requisição curl ou com a linguagem de programação de sua escolha.

Siga este guia na nossa documentação para desenvolvedores para criar um tipo de ticket e criar um novo ticket.

Se você estiver usando a API para recuperar tickets e dados de ticket, pode usar o endpoint da API para buscar tickets. Para excluir tipos de ticket back office, defina o campo como ticket_type_id e use o operador != para excluir o ticket_type_id atribuído aos tipos de ticket back office.

Se você estiver usando a API para recuperar uma conversa ou listar conversas com tickets back office associados às conversas e quiser excluí-los, pode filtrar os resultados que têm o tipo de ticket back office como atributo. Tickets vinculados podem ser encontrados no parâmetro tickets na resposta ou em linked_objects.

Outra opção disponível é usar a API para marcar conversas com um ticket back office associado a elas. Você pode então usar a tag para filtrar por categoria de ticket.

Se você está recebendo uma mensagem 403 API Plan restricted em uma resposta, isso significa que a API que você está tentando usar não está disponível no plano do seu app.

Para acessar a API, você precisará atualizar seu plano. Você pode saber mais sobre os planos Intercom nesta página. Você pode encontrar uma lista completa de códigos de erro e respostas HTTP na nossa documentação para desenvolvedores.

Se você está recebendo uma mensagem 409 conflict em uma resposta, isso significa que há dados existentes no seu workspace Intercom que entram em conflito com os dados da requisição. Isso pode ocorrer se você tentar criar um contato e já houver um contato com esse endereço de email adicionado no seu app.

Para evitar esse erro, você pode usar o endpoint de atualização ou criar um novo contato por user_id. Você pode encontrar uma lista completa de códigos de erro e respostas HTTP na nossa documentação para desenvolvedores.

Se você está recebendo uma mensagem 429, isso significa que o cliente atingiu ou excedeu um limite de taxa, ou o servidor está sobrecarregado. Cada app tem um limite padrão de 10.000 chamadas API por minuto para cada app e 25.000 chamadas API por minuto por workspace. Mais informações sobre limites de taxa estão disponíveis na nossa documentação para desenvolvedores.

Para evitar esse erro, você pode configurar uma verificação de limite de taxa para garantir que não está atingindo o limite. Você pode encontrar uma lista completa de códigos de erro e respostas HTTP na nossa documentação para desenvolvedores.

Apps privados têm um limite padrão de 10.000 chamadas API por minuto por app e 25.000 chamadas API por minuto por workspace. Isso significa que se um workspace tiver vários apps privados instalados, cada um contribui para o número total de requisições.

Apps públicos têm um limite padrão de 10.000 chamadas API por minuto para cada app e 25.000 chamadas API por minuto por workspace. Isso significa que se um workspace tiver vários apps públicos instalados, cada um tem seu próprio limite de requisições separado, sem contribuir para os outros. Mais informações sobre limites de taxa estão disponíveis na nossa documentação para desenvolvedores.

Se você está criando seus próprios relatórios usando a API, pode notar algumas diferenças entre os dois relatórios. Isso pode acontecer por alguns motivos.

Um problema comum é quando datas e horários não coincidem. Isso geralmente ocorre porque o fuso horário que você está usando no seu workspace Intercom é diferente do fuso horário que você está usando para consultar a API. Para corrigir isso, ajuste os parâmetros da consulta da API para coincidir com o fuso horário do seu workspace ou altere o fuso horário do seu relatório personalizado.

Outro problema é que você pode estar usando métricas que não correspondem às métricas da interface de relatórios do Intercom. Algumas métricas disponíveis na interface de relatórios não estão disponíveis via API porque são métricas calculadas. Algumas delas podem ser criadas usando a API e realizando os cálculos do seu lado. Confira o guia para criar seus próprios relatórios na documentação para desenvolvedores do Intercom.

Se você estiver olhando os relatórios de conversas disponíveis na interface versus relatórios obtidos usando a conversations API, pode notar uma diferença no número de conversas. Isso ocorre porque os tickets de back office associados a uma conversa serão incluídos quando puxados pela API.

Para resolver isso, você pode filtrar os resultados após recuperá-los via list conversations, retrieve a conversation ou search for conversations API, e separar os tickets das conversas usando o campo ticket na resposta da conversation API. O campo ticket será preenchido com um objeto se for um ticket e será nulo se for uma conversa.

Webhooks permitem que você se inscreva para notificações em tempo real de eventos que acontecem no Intercom, como quando um contato é criado ou uma mensagem recebida é recebida.

Você pode ver os webhooks disponíveis para cada versão em nossa documentação para desenvolvedores. Depois de identificar qual webhook você precisa, siga este guia para configurá-los.

Não há planos para adicionar novos webhooks em nosso roadmap, mas se houver um webhook que sua equipe precise, por favor envie uma solicitação para a equipe ou adicione-a à lista de desejos do produto na comunidade Intercom.

As APIs do Intercom para listar e pesquisar recursos oferecem paginação baseada em cursor. Isso está disponível para que, quando você solicitar uma grande quantidade de dados — como muitas conversas com todas as suas partes — você possa recebê-los e processá-los em pedaços menores.

Para exemplos de como usar paginação com as APIs de listagem do Intercom, que aceitam parâmetros de caminho, e APIs de pesquisa, que usam parâmetros de consulta, veja nosso guia de paginação.

Para paginação baseada em cursor, o Intercom usa um ponteiro que se refere a um registro específico com base no limite que você define pelo número de páginas que especifica por solicitação.

Quando retornado em um objeto, o ponteiro terá uma aparência como 'WzXXXXXXXXXXXXXX'.

Você pode então usar o ponteiro da resposta para fazer a solicitação subsequente para o próximo lote de dados.

A formatação da paginação na solicitação difere ligeiramente entre as APIs de listagem e as APIs de pesquisa, mas as respostas funcionam da mesma forma.

Você pode ver exemplos de solicitações curl em nossa página de Paginação e tutoriais sobre o uso de list APIs e search APIs.

Qualquer app que interaja com dados de workspace de terceiros e apps construídos com Canvas Kit requerem OAuth. Você nunca deve pedir aos users seu token de acesso e deve usar OAuth apenas para interagir com seus dados.

Veja a documentação para instruções para configurar OAuth.

Você precisará configurar OAuth se estiver construindo uma integração com Intercom que acesse dados de outras pessoas no Intercom. Isso inclui apps públicos que você planeja listar na loja de apps do Intercom, bem como apps e integrações que você pedirá aos users para instalar através do seu próprio site. Saiba mais sobre OAuth em nossa documentação para desenvolvedores.

Se você estiver acessando dados apenas dentro do seu próprio workspace Intercom, pode usar um token de acesso.

Se você estiver construindo um app privado que acessa dados apenas no seu workspace Intercom, pode usar seu token de acesso Intercom para autenticação. Encontre seu token de acesso no seu hub de desenvolvedor e saiba mais sobre autenticação aqui.

Você pode usar seu token de acesso Intercom se estiver usando a API para acessar dados no seu próprio workspace Intercom. Encontre seu token de acesso no seu hub de desenvolvedor e saiba mais sobre autenticação aqui.

Para encontrar seu token de acesso API, siga estes passos:

Você pode criar um app para sua Inbox do Intercom usando Canvas Kit, um kit de ferramentas que permite criar apps que funcionam diretamente dentro da interface do Intercom.

Siga este tutorial para aprender a criar seu primeiro app para Inbox. Você também pode aprender mais sobre Canvas Kit e encontrar documentação de referência em nossa documentação para desenvolvedores.

Você pode criar um app para seu Messenger do Intercom usando Canvas Kit, um kit de ferramentas que permite criar apps que funcionam diretamente dentro da interface do Intercom.

Observe que as personalizações são limitadas ao que é possível através do Canvas Kit e devem ser criadas dentro do Messenger: não é possível recriar ou modificar a aparência do Messenger.

Siga este tutorial para aprender a criar seu primeiro app para Inbox. Você também pode aprender mais sobre Canvas Kit e encontrar documentação de referência em nossa documentação para desenvolvedores.

Se você visitar a página Test & Publish > Your Workspaces do seu app no Developer Hub, deverá ver todos os workspaces dos quais você (como membro da equipe Intercom) faz parte.

Você pode clicar em Install app ao lado do workspace onde deseja instalar o app. Este app será então instalado e um Access Token será fornecido para esse workspace para que você possa acessar seus dados através da API.

Para instruções de instalação de terceiros, veja nossa documentação para desenvolvedores.

Quando estiver pronto para publicar seu app, você pode seguir os passos no developer hub. Você pode encontrar um guia sobre como publicar seu app em nossa documentação para desenvolvedores.

O Intercom SDK para iOS permite que você use o Intercom Messenger no seu app, tenha conversas com seus clientes, envie mensagens ricas outbound, mostre seu Help Center e acompanhe eventos.

Você pode instalar o Intercom para iOS usando Cocoapods, Swift Package Manager ou manualmente. Leia os detalhes aqui. Você pode encontrar o Intercom para iOS no GitHub junto com um app de exemplo que você pode usar para testar o SDK aqui.

O Intercom SDK para Android permite que você use o Intercom Messenger no seu app, tenha conversas com seus clientes, envie mensagens ricas outbound, mostre seu Help Center e acompanhe eventos.

Você pode instalar o Intercom para Android usando Gradle ou manualmente. Leia os detalhes aqui. Você pode encontrar o Intercom para Android no GitHub junto com um app de exemplo que você pode usar para testar o SDK aqui.

O wrapper Intercom React Native permite que você use Intercom para iOS e Intercom para Android em seus apps React Native. Siga os passos de configuração aqui.