1. ActiveCampaign Centro de Ajuda
  2. Gerenciamento de contatos
  3. Adicionar e exportar contatos

Use a API do importador de contato a granel

Avatar
Sarah N
Última atualização

Os respondentes automáticos instantâneos (uma campanha que é enviada imediatamente quando uma pessoa se inscreve na sua lista) não serão enviados quando você importar contatos usando o recurso Importar Contatos.

Tome nota

A API do Importador de Contato em Massa está disponível em todos os planos ActiveCampaign

Tome nota

  • Sobre a API importador de contato a granel
  • O importador de contato a granel foi projetado para realizar operações em grandes quantidades de contatos ao mesmo tempo.
  • Essas operações incluem:

Criando novos contatos

Atualização de contatos existentes Definindo campos em contatos

  • Contatos de marcação
  • Adição de contatos a listas
  • Observação
  • O Importador de Contato em Massa não foi projetado para suportar operações frequentes envolvendo um pequeno número de contatos ou para sincronizar atualizações em tempo real a partir de um banco de dados externo.
  • Em vez disso, as atualizações de contato devem ser coletadas em lotes maiores e importadas em grupo.

Observação

O Importador de Contato em Massa não foi projetado para suportar operações frequentes envolvendo um pequeno número de contatos ou para sincronizar atualizações em tempo real a partir de um banco de dados externo. Limitação de taxas O processo de importador a granel é otimizado para o upload de listas maiores de contatos.

Se você precisar carregar 10 ou menos contatos por vez, use a funcionalidade Contatos da nossa API ActiveCampaign V3.

Como resultado, aplicamos os seguintes limites de taxa na API do Importador de Contato em Massa:

Para solicitações que contenham um único contato, há um limite de 20 solicitações por minuto Para solicitações contendo vários contatos, há um limite de 100 solicitações por minuto Recomendamos que todos os usuários tentem fazer atualizações em grupos o maior possível antes de iniciar uma importação.

  • Limitação do tamanho da carga
  • O tamanho da carga útil de uma única solicitação de bulk_import deve ser inferior a 400000 bytes.

Contatos ignorados

Os contatos devem atender a todos os seguintes critérios para serem criados ou atualizados com esta API:

O tamanho da carga útil de uma única solicitação de bulk_import deve ser inferior a 400000 bytes.

O contato deve ter um endereço de e-mail

O ’ endereço de e-mail do contato não deve estar em uma lista de exclusão

  • O ’ e-mail do contato não deve estar em uma lista de endereços de e-mail recuperados
  • O contato não deve ter desubscrevido a uma lista que a importação os adicionaria a

Se os contatos não atenderem a todos esses requisitos, eles serão ignorados pelo importador.

  • Documentação da API
  • POST https://youraccountname.api-us1.com/api/3/import/bulk_import
  • Estrutura de solicitação

JSON
{
"contatos": [{"email": "someone@somewhere.com","first_name": "Jane","last_name": "Doe","phone": "123-456-7890","customer_acct_name": "ActiveCampaign","tags": ["dictumst aliquam augue quam sollicitudin rutrum",],"fields": [


{
"id": 1,






"value": "foo"},
{"id": 2,"valor": "foo|| bar|| baz"}
],
"subscribe": [{"listid": 1}, {"listid": 2}],"unsubscribe": [{"listid": 3}],}],"callback":
}


Response
200 OK
{
"Success":1,"queued_contacts":1,"batchId":"0641fbdd-f62f-4c2c-ba02-3a83d5d11ac9",





"message":"Contact import queued"
}

400 Bad Request
{
"Success":0,
"message":"JSON payload não passou na validação.

Por favor, corrigir falhasReasons e tentar novamente.

POST https://youraccountname.api-us1.com/api/3/import/bulk_import

Estrutura de solicitação

JSON
{
"contatos": [{"email": "someone@somewhere.com","first_name": "Jane","last_name": "Doe","phone": "123-456-7890","customer_acct_name": "ActiveCampaign","tags": ["dictumst aliquam augue quam sollicitudin rutrum",],"fields": [


{
"id": 1,






 "value":  "foo"},
{"id": 2,"valor": "foo|| bar|| baz"}
],
"subscribe": [{"listid": 1}, {"listid": 2}],"unsubscribe": [{"listid": 3}],}],"callback": 
}


Response
200 OK
{
"Success":1,"queued_contacts":1,"batchId":"0641fbdd-f62f-4c2c-ba02-3a83d5d11ac9",





"message":"Contact import queued" 
}

 400 Bad Request
{
"Success":0,
"message":"JSON payload não passou na validação. Uma série de objetos contendo informações sobre um único contato. A importação não foi enfileirada para processamento.",
"failureReasons":["Payload must contain a 'contacts' field"]
}


Params corporais

matriz contacts* (objeto)

first_name (cadeia de caracteres)
O primeiro nome do contato. last_name (cadeia de caracteres)
O sobrenome do contato. telefone (string)
O número de telefone do contato.

Retornos

requestType (string)
Pode ser definido como "GET" ou "POST". Determina o tipo de solicitação HTTP que será enviada para o ponto final especificado.

JSON
{
"contatos": [ ... incluir contatos aqui ... ],"callback": {"url": "www.your_web_server.com","requestType": "POST","detailed_results": "true","params": [{"key":"","value":""}]"headers": [
{"key":"",



"value":""}]

}}




 

  • url (string)
    O ponto de extremidade de URL para o qual o importador fará uma solicitação depois que a importação for concluída.
  • requestType (string)
    Pode ser definido como "GET" ou "POST". Para uma solicitação GET, cada parâmetro será anexado ao final da URL em uma sequência de consulta.
  • detailed_results (string)
    Quando definido como "true" e o parâmetro requestType é definido como "POST", o retorno de chamada incluirá o número de sucessos e falhas na solicitação de origem, bem como uma matriz de mensagens de erro para cada contato com falha.
  • params (matriz)
    Uma lista de parâmetros a serem incluídos na solicitação de retorno de chamada. Uma lista de cabeçalhos para incluir na solicitação de retorno de chamada. Adicione cada cabeçalho na forma de um par de valor-chave. Exemplos
  • cabeçalhos (matriz)
  • {
    "contatos": [ ... incluir contatos aqui ... ],"callback": {"url": "www.yourwebsite.com/the/api/to/hit","requestType": "GET","params": [{"key":"msg","value":"hello"}]"headers": [
    {"key":"",


    "value":""}]

    }}




    Os params serão anexados à URL como parâmetros de consulta no caso de uma “” solicitação GET.

Exemplos

Receber uma notificação

{
"contatos": [ ... incluir contatos aqui ... ],"callback": {"url": "www.yourwebsite.com/the/api/to/hit","requestType": "GET","params": [{"key":"msg","value":"hello"}]"headers": [
{"key":"",


"value":""}]

}}




 

COMEÇAR www.yourwebsite.com/the/api/to/hit?msg=hello Postando uma mensagem {
"contatos": [ ... incluir contatos aqui ... ],"callback": {"requestType": "POST","params": [{"key":"msg","value":"Import completed"}]"headers": [
{"key":"Authorization",

"value":"Bearer 4u1h_t0k3N"}]

}}




Resultado:

COMEÇAR www.yourwebsite.com/the/api/to/hit?msg=hello

Postando uma mensagem

{
"contatos": [ ... incluir contatos aqui ... ],"callback": {"requestType": "POST","params": [{"key":"msg","value":"Import completed"}]"headers": [
{"key":"Authorization",

"value":"Bearer 4u1h_t0k3N"}]

}}





Resultado:

COMEÇAR www.yourwebsite.com/the/api/to/hit

JSON
[
{"key":"msg","value":"Importação concluída"}
]


Resultados de importação com mensagens de erro

{
"contatos": [ ... incluir contatos aqui ... ],"callback": {"requestType": "POST","detailed_results": "true","headers": [{"key":"",


"value":""}]
}}




Quando o “ parâmetro detailed_results for definido como ” "True", o retorno de chamada incluirá:

  • JSON
    {
    "Sucesso":1,"Fracassos":0,

    "failure_reasons":[]
    }

Resultado:

COMEÇAR www.yourwebsite.com/the/api/to/hit

JSON
{
"Sucesso":1,"Fracassos":0,

"failure_reasons":[]
}

Relativo a:

Esse artigo foi útil?
Usuários que acharam isso útil: 1 de 7

Tem mais perguntas? Envie uma solicitação

Start free trial