Menu
Menu
Todas requisições deverão ser realizadas através da seguinte url:
https://api.iagentemail.com/v1/
Para realizar uma requisição é necessário executar um ação do tipo POST com a chave de integração no header da mesma.
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;
https://api.iagentemail.com/v1/contact/create
Abaixo lista de parâmetros que podem ser enviados junto com a requisição de criação de contato
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/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"
}
https://api.iagentemail.com/v1/group/create
Abaixo lista de parâmetros que podem ser enviados junto com a requisição de criação de 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"
}
https://api.iagentemail.com/v1/group/contact/list
Abaixo lista de parâmetros que podem ser enviados junto com a requisição de listagem de contatos de um grupo.
Ordenação da consulta .Pode ser name, email ou created_date. Valor padrão: name
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"
}
https://api.iagentemail.com/v1/group/list
Abaixo lista de parâmetros que podem ser enviados junto com a requisição de listagem de contatos de um grupo.
Orientação da ordenação. Pode ser ASC ou DESC. Valor padrão: ASC
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"
}
https://api.iagentemail.com/v1/contact/list
Abaixo lista de parâmetros que podem ser enviados junto com a requisição de listagem de contatos
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"
}
https://api.iagentemail.com/v1/contact/edit
Abaixo lista de parâmetros que podem ser enviados junto com a requisição de edição de 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/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"
}
https://api.iagentemail.com/v1/group/edit
Abaixo lista de parâmetros que podem ser enviados junto com a requisição de edição de grupo
$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"
}
https://api.iagentemail.com/v1/contact/remove
Abaixo lista de parâmetros que podem ser enviados junto com a requisição de remoção de contato
$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"
}
https://api.iagentemail.com/v1/group/contact/remove
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"
}
https://api.iagentemail.com/v1/group/remove
Abaixo lista de parâmetros que podem ser enviados junto com a requisição de remoção de um 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/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"
}
https://api.iagentemail.com/v1/contact/mass/add
Abaixo lista de parâmetros que podem ser enviados junto com a requisição de criação de contato
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."
}
