API DE ENVIO DE EMAIL
Disponibilizamos de uma API com todas as funções necessárias para você sincronizar seus contatos com nossa plataforma.
Todas requisições deverão ser realizadas através da seguinte url:
Para realizar uma requisição é necessário executar um ação do tipo POST com a chave de integração no header da mesma.
| Nome | Tipo | Descrição |
|---|---|---|
| IAGENTE-KEY | String | Hash de integração gerado por dentro da ferramenta |
A requisição pode ser feita por qualquer linguagem que possua método com opções de header, como exemplo PHP Curl, Javascript ajax, Nodejs Axios, entre outros.
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.iagentemail.com/v1/group/list',
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_RETURNTRANSFER=> true,
CURLOPT_HEADER => false,
CURLOPT_CONNECTTIMEOUT => 10,
CURLOPT_TIMEOUT => 10,
CURLOPT_POSTFIELDS => array(
'group_id' => '1234',
),
CURLOPT_HTTPHEADER => array(
'IAGENTE-KEY: chave-do-usuario'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
Abaixo lista de parâmetros que podem ser enviados junto com a requisição de criação de contato
| Nome | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| Sim | String | Email do contato | |
| group_id | Sim | Integer | Código identificador do grupo que o contato será cadastrado |
| name | Não | String | Nome do contato |
| birthday | Não | Date | Data de aniversário no formato AAAA-MM-DD |
| field1 | Não | String | Campo adicional 1 |
| field2 | Não | String | Campo adicional 2 |
| field3 | Não | String | Campo adicional 3 |
| field4 | Não | String | Campo adicional 4 |
| field5 | Não | String | Campo adicional 5 |
| field6 | Não | String | Campo adicional 6 |
| field7 | Não | String | Campo adicional 7 |
| field8 | Não | String | Campo adicional 8 |
| field9 | Não | String | Campo adicional 9 |
| field10 | Não | String | Campo adicional 10 |
A requisição pode ser feita por qualquer linguagem que possua método com opções de header, como exemplo PHP Curl, Javascript ajax, Nodejs Axios, entre outros.
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.iagentemail.com/v1/contact/create',
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_RETURNTRANSFER=> true,
CURLOPT_HEADER => false,
CURLOPT_CONNECTTIMEOUT => 10,
CURLOPT_TIMEOUT => 10,
CURLOPT_POSTFIELDS => array(
'group_id' => 1234,
'email' => 'teste@iagente.com.br',
'name' => 'nome do contato',
),
CURLOPT_HTTPHEADER => array(
'IAGENTE-KEY: chave-do-usuario'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
{
status: "success",
message: "Contato inserido com sucesso",
contact_id: 1234
}
{
status: "error",
message: "Não foi possível adicionar o contato"
}
Abaixo lista de parâmetros que podem ser enviados junto com a requisição de criação de grupo
| Nome | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| name | Sim | String | Nome do grupo |
A requisição pode ser feita por qualquer linguagem que possua método com opções de header, como exemplo PHP Curl, Javascript ajax, Nodejs Axios, entre outros.
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.iagentemail.com/v1/group/create',
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_RETURNTRANSFER=> true,
CURLOPT_HEADER => false,
CURLOPT_CONNECTTIMEOUT => 10,
CURLOPT_TIMEOUT => 10,
CURLOPT_POSTFIELDS => array(
'name' => 'nome do grupo'
),
CURLOPT_HTTPHEADER => array(
'IAGENTE-KEY: chave-do-usuario'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
{
status: "success",
message: Grupo inserido com sucesso
group_id: 1234
}
{
status: "error",
message: "Não foi possível adicionar o grupo"
}
Abaixo lista de parâmetros que podem ser enviados junto com a requisição de listagem de contatos de um grupo
| Nome | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| group_id | Sim | Integer | Código identificador do grupo que o contato será cadastrado |
| order | Não | String | Ordenação da consulta .Pode ser name, email ou created_date. Valor padrão: name |
| orientation | Não | String | Orientação da ordenação. Pode ser ASC ou DESC. Valor padrão: ASC |
| search | Não | String | Valor a ser buscado |
| page | Não | String | Página da consulta. Valor padrão: 1 |
A requisição pode ser feita por qualquer linguagem que possua método com opções de header, como exemplo PHP Curl, Javascript ajax, Nodejs Axios, entre outros.
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.iagentemail.com/v1/group/contact/list',
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_RETURNTRANSFER=> true,
CURLOPT_HEADER => false,
CURLOPT_CONNECTTIMEOUT => 10,
CURLOPT_TIMEOUT => 10,
CURLOPT_POSTFIELDS => array(
'group_id' => 123,
'order' => 'name',
'search' => 'terra',
'page' => 3
),
CURLOPT_HTTPHEADER => array(
'IAGENTE-KEY: chave-do-usuario'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
{
status: "success",
current_page: 1
last_page: 4,
total: 119,
data:
[
{
contact_id: 123,
name: "Nome do contato",
email: "contato@contato.com",
birthday: "1991-04-29",
field1: "Rua ABC",
field2: "Casa",
field3: "",
field4: "",
field5: "",
field6: "",
field7: "",
field8: "",
field9: "",
field10: "",
created_at: "01/01/2021 14:23:01",
},
{...}
]
}
{
status: "error",
message: "Não foi possível listar o grupo"
}
Abaixo lista de parâmetros que podem ser enviados junto com a requisição de listagem de grupos
| Nome | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| order | Não | String | Ordenação da consulta. Pode ser name ou created_date. Valor padrão: name |
| orientation | Não | String | Orientação da ordenação. Pode ser ASC ou DESC. Valor padrão: ASC |
| search | Não | String | Valor a ser buscado |
| page | Não | Integer | Página da consulta. Valor padrão: 1 |
A requisição pode ser feita por qualquer linguagem que possua método com opções de header, como exemplo PHP Curl, Javascript ajax, Nodejs Axios, entre outros.
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.iagentemail.com/v1/group/list',
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_RETURNTRANSFER=> true,
CURLOPT_HEADER => false,
CURLOPT_CONNECTTIMEOUT => 10,
CURLOPT_TIMEOUT => 10,
CURLOPT_POSTFIELDS => array(
'order' => 'name',
'search' => 'terra',
'page' => 3
),
CURLOPT_HTTPHEADER => array(
'IAGENTE-KEY: chave-do-usuario'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
{
status: "success",
current_page: 1
last_page: 4,
total: 119,
data:
[
{
group_id: 123,
name: "Grupo teste",
created_at: "01/01/2021 14:23:01"
},
{...}
]
}
{
status: "error",
message: "Não foi possível listar o grupo"
}
Abaixo lista de parâmetros que podem ser enviados junto com a requisição de listagem de contatos
| Nome | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| order | Não | String | Ordenação da consulta .Pode ser name, email ou created_date. Valor padrão: name |
| orientation | Não | String | Orientação da ordenação. Pode ser ASC ou DESC. Valor padrão: ASC |
| search | Não | String | Valor a ser buscado |
| page | Não | Integer | Página da consulta. Valor padrão: 1 |
A requisição pode ser feita por qualquer linguagem que possua método com opções de header, como exemplo PHP Curl, Javascript ajax, Nodejs Axios, entre outros.
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.iagentemail.com/v1/contact/list',
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_RETURNTRANSFER=> true,
CURLOPT_HEADER => false,
CURLOPT_CONNECTTIMEOUT => 10,
CURLOPT_TIMEOUT => 10,
CURLOPT_POSTFIELDS => array(
'order' => 'name',
'search' => 'terra',
'page' => 3
),
CURLOPT_HTTPHEADER => array(
'IAGENTE-KEY: chave-do-usuario'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
{
status: "success",
current_page: 1
last_page: 4,
total: 119,
data:
[
{
contact_id: 123,
name: "Nome do contato",
email: "contato@contato.com",
birthday: "1991-04-29",
field1: "Rua ABC",
field2: "Casa",
field3: "",
field4: "",
field5: "",
field6: "",
field7: "",
field8: "",
field9: "",
field10: "",
created_at: "01/01/2021 14:23:01",
groups:
[
{
nome: "Nome do grupo",
group_id: 123,
created_at: "2020-11-03 10:40:02"
},
{...}
]
}
{...}
]
}
{
status: "error",
message: "Não foi possível listar os contatos"
}
Abaixo lista de parâmetros que podem ser enviados junto com a requisição de edição de contato
| Nome | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| Sim | String | Email do contato | |
| name | Não | String | Nome do contato |
| birthday | Não | Date | Data de aniversário no formato AAAA-MM-DD |
| field1 | Não | String | Campo adicional 1 |
| field2 | Não | String | Campo adicional 2 |
| field3 | Não | String | Campo adicional 3 |
| field4 | Não | String | Campo adicional 4 |
| field5 | Não | String | Campo adicional 5 |
| field6 | Não | String | Campo adicional 6 |
| field7 | Não | String | Campo adicional 7 |
| field8 | Não | String | Campo adicional 8 |
| field9 | Não | String | Campo adicional 9 |
| field10 | Não | String | Campo adicional 10 |
A requisição pode ser feita por qualquer linguagem que possua método com opções de header, como exemplo PHP Curl, Javascript ajax, Nodejs Axios, entre outros.
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.iagentemail.com/v1/contact/edit',
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_RETURNTRANSFER=> true,
CURLOPT_HEADER => false,
CURLOPT_CONNECTTIMEOUT => 10,
CURLOPT_TIMEOUT => 10,
CURLOPT_POSTFIELDS => array(
'email' => 'teste@iagente.com.br',
'field1' => 'Rua A',
'field2' => 'Castelo Branco',
),
CURLOPT_HTTPHEADER => array(
'IAGENTE-KEY: chave-do-usuario'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
{
status: "success",
message: "Contato atualizado com sucesso"
}
{
status: "error",
message: "Não foi possível atualizar o contato"
}
Abaixo lista de parâmetros que podem ser enviados junto com a requisição de edição de grupo
| Nome | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| group_id | Sim | Integer | Código identificador do grupo que o contato será cadastrado |
| name | Sim | String | Nome do grupo |
A requisição pode ser feita por qualquer linguagem que possua método com opções de header, como exemplo PHP Curl, Javascript ajax, Nodejs Axios, entre outros.
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.iagentemail.com/v1/group/edit',
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_RETURNTRANSFER=> true,
CURLOPT_HEADER => false,
CURLOPT_CONNECTTIMEOUT => 10,
CURLOPT_TIMEOUT => 10,
CURLOPT_POSTFIELDS => array(
'group_id' => 123,
'name' => 'Grupo B',
),
CURLOPT_HTTPHEADER => array(
'IAGENTE-KEY: chave-do-usuario'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
{
status: "success",
message: "Grupo atualizado com sucesso"
}
{
status: "error",
message: "Não foi possível atualizar o grupo"
}
Abaixo lista de parâmetros que podem ser enviados junto com a requisição de remoção de contato
| Nome | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| Sim | String | Email do contato |
A requisição pode ser feita por qualquer linguagem que possua método com opções de header, como exemplo PHP Curl, Javascript ajax, Nodejs Axios, entre outros.
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.iagentemail.com/v1/contact/remove',
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_RETURNTRANSFER=> true,
CURLOPT_HEADER => false,
CURLOPT_CONNECTTIMEOUT => 10,
CURLOPT_TIMEOUT => 10,
CURLOPT_POSTFIELDS => array(
'email' => 'teste@contato.com'
),
CURLOPT_HTTPHEADER => array(
'IAGENTE-KEY: chave-do-usuario'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
{
status: "success",
message: "Contato removido da conta com sucesso"
}
{
status: "error",
message: "Não foi possível remover o contato"
}
Abaixo lista de parâmetros que podem ser enviados junto com a requisição de remoção de contato de um grupo
| Nome | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| Sim | String | Email do contato | |
| group_id | Sim | Integer | Código identificador do grupo que o contato será cadastrado |
A requisição pode ser feita por qualquer linguagem que possua método com opções de header, como exemplo PHP Curl, Javascript ajax, Nodejs Axios, entre outros.
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.iagentemail.com/v1/group/contact/remove',
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_RETURNTRANSFER=> true,
CURLOPT_HEADER => false,
CURLOPT_CONNECTTIMEOUT => 10,
CURLOPT_TIMEOUT => 10,
CURLOPT_POSTFIELDS => array(
'email' => 'teste@contato.com'
'group_id' => 123
),
CURLOPT_HTTPHEADER => array(
'IAGENTE-KEY: chave-do-usuario'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
{
status: "success",
message: "Contato removido do grupo com sucesso"
}
{
status: "error",
message: "Não foi possível remover o contato do grupo"
}
Abaixo lista de parâmetros que podem ser enviados junto com a requisição de remoção de um grupo
| Nome | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| group_id | Sim | Integer | Código identificador do grupo que o contato será cadastrado |
A requisição pode ser feita por qualquer linguagem que possua método com opções de header, como exemplo PHP Curl, Javascript ajax, Nodejs Axios, entre outros.
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.iagentemail.com/v1/group/remove',
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_RETURNTRANSFER=> true,
CURLOPT_HEADER => false,
CURLOPT_CONNECTTIMEOUT => 10,
CURLOPT_TIMEOUT => 10,
CURLOPT_POSTFIELDS => array(
'group_id' => 123
),
CURLOPT_HTTPHEADER => array(
'IAGENTE-KEY: chave-do-usuario'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
{
status: "success",
message: "Grupo removido com sucesso"
}
{
status: "error",
message: "Não foi possível remover o grupo"
}
Abaixo lista de parâmetros que podem ser enviados junto com a requisição de criação de contato
| Nome | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| group_id | Sim | Integer | Código identificador do grupo que o contato será cadastrado |
| contacts | Sim | Array | Array contendo os contatos |
Você pode enviar os campos adicionais de cada contato dentro do array, como faria com um contato único
A requisição pode ser feita por qualquer linguagem que possua método com opções de header, como exemplo PHP Curl, Javascript ajax, Nodejs Axios, entre outros.
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.iagentemail.com/v1/contact/mass/add',
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_RETURNTRANSFER=> true,
CURLOPT_HEADER => false,
CURLOPT_CONNECTTIMEOUT => 10,
CURLOPT_TIMEOUT => 10,
CURLOPT_POSTFIELDS => array(
'group_id' => 1234,
'contacts[0][email]' => 'teste@iagente.com.br',
'contacts[0][name]' => 'nome do contato',
'contacts[1][email]' => 'teste_1@iagente.com.br',
'contacts[1][name]' => 'nome do contato 1',
),
CURLOPT_HTTPHEADER => array(
'IAGENTE-KEY: chave-do-usuario'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
{
status: "success",
message: "Operação concluída!",
invalids: 0
imports: 2
details: []
}
{
status: "error",
message: "Não foi possível executar esta ação."
}