Contatos

A base de contatos da conta: criar, editar, apagar, registrar consentimento, unir duplicados e importar em lote. Uma API key restrita a alguns números enxerga só os contatos que têm conversa nesses números, e recebe 403 no que é da base inteira — exportar, importar, criar, apagar, unir, opt-in e as definições de campos e tags.

GETListar contatosA base de contatos, paginada. Todos os filtros se somam (E).POSTCriar contatoCria um contato a partir de um telefone ou de um BSUID. O telefone é normalizado para E.164 e guardado sem o +; sem código de país, informe defaultCountry.POSTCriar ou atualizar contatos em loteAté 500 contatos por chamada, cada um criado ou atualizado pelo telefone ou BSUID. A resposta é 200 mesmo quando linhas falham: o resultado de cada uma vem…POSTSincronizar os contatos de um siteOs clientes de um site conectado, até 500 por chamada. É o que o plugin do WordPress chama para trazer os usuários, clientes e leads do site — e qualquer…GETExportar contatos em CSVA base inteira — ou o que os filtros selecionarem — num CSV, sem paginação. Uma coluna por campo personalizado, depois das fixas. O arquivo começa com BOM…GETListar importaçõesListar importações POSTAbrir uma importaçãoUm registro que acompanha uma importação grande feita em vários lotes: mande o id em options.importId de cada POST /contacts/batch e os contadores se somam…GETConsultar uma importaçãoConsultar uma importação PATCHEncerrar uma importaçãoMarca a importação como completed ou failed. Só uma importação ainda em processing pode ser encerrada.GETConsultar um contatoO contato, com as linhas da lista de supressão que batem com o telefone ou o BSUID dele.PATCHEditar um contatoCampo ausente fica como está; null apaga. attributes é um patch sobre os valores guardados, e tagIds é o conjunto completo de tags. O consentimento não se…DELApagar um contatoApaga o contato de vez, com as conversas, mensagens, tags e histórico — é o pedido de eliminação da LGPD. As linhas da lista de supressão ficam, sem a…POSTRegistrar opt-inRegistra o consentimento de marketing, com a evidência de como foi obtido. Tira o contato da lista de supressão só quando o motivo era um opt-out anterior.…POSTRegistrar opt-outTira o consentimento e põe o telefone e o BSUID do contato na lista de supressão. Dispara contact.optedout.POSTUnir contatos duplicadosO contato do caminho sobrevive; duplicateId é apagado depois de ter conversas, tags, histórico e campanhas movidos para ele. Nos campos, vale o do…GETHistórico do contatoO que aconteceu com o contato, do mais recente ao mais antigo: criação, edições, tags, consentimento, uniões e cliques em campanha.GETJanela de atendimento (24 h) do contatoSe uma mensagem livre (fora de template) ainda chega ao contato, número a número. A janela abre quando o contato escreve e dura 24 h a partir da última…GETExportar os dados de um contatoTudo o que a conta guarda sobre o contato, num JSON para download — o pedido de acesso da LGPD. Até 10.000 mensagens por conversa.