Email Marketing | Ferramenta de email marketing

emailmanager - API de Desenvolvimento (Versão 1.0)
Atualizada em: 08/07/2016 - 16:00hs

Bem vindo a versão 1.0 Beta da API do emailmanager!

Abaixo, será explicado como funciona a comunicação com a API, como criar suas chaves da API (Api-Keys) e como executar os métodos da API presentes neste documento.

As requisições da API devem ser feitas a partir da URL, passando os parâmetros da API necessários para identificar o cliente e usuário relacionados à requisição e os parâmetros do método para executar a funcionalidade desejada no sistema do mesmo.

As requisições devem estar no formato abaixo, dependendo da versão utilizada e do método executado:

http://api.emailmanager.com/1.0/?apikey=<apikey>&method=<método>& [outros parâmetros]

O método de autenticação, que é utilizado para obter a chave da API relacionada ao usuário, deve ser executada a partir da chamada ao método "authentLogin", conforme o exemplo abaixo:

http://api.emailmanager.com/1.0/?method=authentLogin&domain=<subdomínio>&username=<usuário>&password=<senha>

Veja abaixo alguns exemplos de requisição que irão retornar dados ou valores para referência (substitua a palavra "suachavedaapi" pela sua chave da API, obtida com os passos acima):

http://api.emailmanager.com/1.0/?apikey=suachavedaapi&method=exceptions
http://api.emailmanager.com/1.0/?apikey=suachavedaapi&method=editions&status_id=1
http://api.emailmanager.com/1.0/?apikey=suachavedaapi&method=editionContent&cid=1
http://api.emailmanager.com/1.0/?apikey=suachavedaapi&method=reportEditionStats&cid=1
http://api.emailmanager.com/1.0/?apikey=suachavedaapi&method=reportUnsubscribes&group_id=1&cancel=true
http://api.emailmanager.com/1.0/?apikey=suachavedaapi&method=editionMappedLinks&cid=1

Os tipos de "saída de dados" disponíveis são: XML (formato SOAP), PHP (array serializado) e JSON (array misto), que podem ser obtidos facilmente adicionando o parâmetro "output", como nos exemplos abaixo:

http://api.emailmanager.com/1.0/?apikey=suachavedaapi&method=exceptions&output=xml
http://api.emailmanager.com/1.0/?apikey=suachavedaapi&method=exceptions&output=php
http://api.emailmanager.com/1.0/?apikey=suachavedaapi&method=exceptions&output=json

As "línguas" disponíveis para exibição dos "Erros" são: pt_BR (português-brasileiro), en_US (inglês-americano) e es_ES (espanhol), que podem ser retornados com a adição do parâmetro "language":

http://api.emailmanager.com/1.0/?apikey=suachavedaapi&method=exceptions&language=pt_BR
http://api.emailmanager.com/1.0/?apikey=suachavedaapi&method=exceptions&language=en_US
http://api.emailmanager.com/1.0/?apikey=suachavedaapi&method=exceptions&language=es_ES

Por padrão, é retornado um máximo de até 100 registros por consulta. Para listar os dados desejados, em maior quantidade, devem ser utilizados os Parâmetros "begin" e "limit", informando a posição ao qual deseja retornar o primeiro registro e a quantidade desejada. Veja abaixo um exemplo que retorna 20 registros por consulta:

http://api.emailmanager.com/1.0/?apikey=suachavedaapi&method=contacts&begin=0&limit=20
http://api.emailmanager.com/1.0/?apikey=suachavedaapi&method=contacts&begin=20&limit=20
http://api.emailmanager.com/1.0/?apikey=suachavedaapi&method=contacts&begin=40&limit=20

Métodos de "Erros"

Array

exceptions ( string language )

Retorna os códigos e mensagens de erro que podem ser gerados pelo sistema.

[+] Parâmetros:

Métodos de "Autenticação"

String

authentLogin ( string domain , string username , string password )

Efetua a autenticação do usuário na base de dados do cliente e retorna a chave da API do usuário, para acesso aos demais métodos.

[+] Parâmetros:

Boolean

authentLogout ( string apikey )

Efetua o logout do usuário na base de dados do cliente e retorna o resultado da finalização do acesso.

[+] Parâmetros:

Métodos de "Campanhas"

Array

campaigns ( int parent_id , string order , int begin , int limit )

Retorna uma lista com as campanhas de edição registradas no sistema.

[+] Parâmetros:

Int

campaignCount ( int parent_id )

Retorna o número total de campanhas registradas no sistema, filtrando pela campanha "pai", caso desejado.

[+] Parâmetros:

Int

campaignCreate ( int parent_id , string name )

Cadastra um novo registro de campanha de edições relacionada à campanha "pai" informada.

[+] Parâmetros:

Boolean

campaignDelete ( int campaign_id )

Envia o registro da campanha de edições "ativa" para a lixeira, juntamente com as edições relacionadas.

[+] Parâmetros:

Boolean

campaignUpdate ( int campaign_id , string name , int parent_id )

Atualiza um registro de campanha de edições existente a partir dos dados passados.

[+] Parâmetros:

Métodos de "Edições"

Array

editions ( datetime date_creation_begin , datetime date_creation_end , datetime date_modified_begin , datetime date_modified_end , datetime date_send_begin , datetime date_send_end , int status_id , int campaign_id , int account_id , int folder_id , int mining_id , boolean content , string order , int begin , int limit )

Pesquisa e lista as edições do usuário de acordo com os parâmetros passados.

[+] Parâmetros:

datetime	date_creation_begin	Data e hora inicial de cadastro dos registros, formato "AAAA-MM-DD HH:mm:ss".
datetime	date_creation_end	Data e hora final de cadastro dos registros, formato "AAAA-MM-DD HH:mm:ss".
datetime	date_modified_begin	Data e hora inicial de modificação dos registros, formato "AAAA-MM-DD HH:mm:ss".
datetime	date_modified_end	Data e hora final de modificação dos registros, formato "AAAA-MM-DD HH:mm:ss".
datetime	date_send_begin	Data e hora inicial de envio dos registros, formato "AAAA-MM-DD HH:mm:ss".
datetime	date_send_end	Data e hora final de envio dos registros, formato "AAAA-MM-DD HH:mm:ss".
int	status_id	Identificação "id" da situação atual da edição, para filtro.
int	campaign_id	Identificação "id" da campanha relacionada à edição, para filtro.
int	account_id	Identificação "id" da conta de envio utilizada, para filtro.
int	folder_id	Identificação "id" da pasta relacionado à edição, para filtro.
int	mining_id	Identificação "id" da regra de filtro utilizado, para filtro.
boolean	content	Informa se os conteúdos das edições devem ser retornados.
string	order	Identificação do campo para ordenação dos registros retornados.
int	begin	Posição do primeiro registro a ser retornado pela pesquisa.
int	limit	Quantidade/limite de registros a serem retornados.

Int

editionCount ( int campaign_id )

Retorna o número total de edições registradas no sistema, filtrando pelo "id" da campanha relacionada, caso desejado.

[+] Parâmetros:

Array

editionContent ( int cid )

Retorna os dados de uma determinada edição, a partir de sua Identificação no sistema.

[+] Parâmetros:

Array

editionMappedLinks ( int cid , boolean active , boolean analytics )

Retorna os registros de link mapeados para a edição relacionada.

[+] Parâmetros:

Int

editionCreate ( string name , string description , string subject , string content_html , string content_txt , datetime date_send , int campaign_id , int account_id , int folder_id , int mining_id , array send_groups , array exclusion_groups )

Cadastra um novo registro de edição no sistema, com situação "preparando".

[+] Parâmetros:

string	name	Nome de identificação da edição a ser cadastrada.
string	description	Descrição relacionada à edição a ser cadastrada.
string	subject	Assunto que será exibido na edição a ser enviada.
string	content_html	Conteúdo de exibição da edição em formato HTML.
string	content_txt	Conteúdo de exibição da edição em formato TEXT.
datetime	date_send	Data e hora de envio da edição, formato "AAAA-MM-DD HH:mm:ss".
int	campaign_id	Identificação "id" da campanha relacionada à edição.
int	account_id	Identificação "id" da conta de envio a ser utilizada.
int	folder_id	Identificação "id" da pasta a ser armazenada a edição.
int	mining_id	Identificação "id" da regra de filtro a ser utilizada.
array	send_groups	Identificação "id" dos grupos de envio da edição, separados por vírgula.
array	exclusion_groups	Identificação "id" dos grupos de exclusão da edição, separados por vírgula.

Boolean

editionDelete ( int cid )

Envia o registro da edição "preparando" para a lixeira, evitando a liberação de envio da mesma.

[+] Parâmetros:

Boolean

editionUpdate ( int cid , string name , string description , string subject , string content_html , string content_txt , datetime date_send , int campaign_id , int account_id , int folder_id , int mining_id , array send_groups , array exclusion_groups )

Altera os dados de registro de uma edição com situação "preparando" no sistema.

[+] Parâmetros:

int	cid	Identificação da edição na base de dados do sistema.
string	name	Nome de identificação da edição a ser atualizada.
string	description	Descrição relacionada à edição a ser atualizada.
string	subject	Assunto que será exibido na edição a ser enviada.
string	content_html	Conteúdo de exibição da edição em formato HTML.
string	content_txt	Conteúdo de exibição da edição em formato TEXT.
datetime	date_send	Data e hora de envio da edição, formato "AAAA-MM-DD HH:mm:ss".
int	campaign_id	Identificação "id" da campanha relacionada à edição.
int	account_id	Identificação "id" da conta de envio a ser utilizada.
int	folder_id	Identificação "id" da pasta a ser armazenada a edição.
int	mining_id	Identificação "id" da regra de filtro a ser utilizada.
array	send_groups	Identificação "id" dos grupos de envio da edição, separados por vírgula.
array	exclusion_groups	Identificação "id" dos grupos de exclusão da edição, separados por vírgula.

Array

editionStatus ( boolean system )

Retorna uma lista com os tipo de "situação" ao qual uma edição pode estar definida.

[+] Parâmetros:

Array

editionAccounts ( int account_id , datetime date_begin , datetime date_end , boolean validated , boolean mapping , boolean analytics , boolean auto_release , string order , int begin , int limit )

Pesquisa e lista as contas de envio de acordo com os parâmetros passados.

[+] Parâmetros:

int	account_id	Identificação da conta de envio a ser retornada, opcional.
datetime	date_begin	Data e hora inicial de cadastro dos registros, formato "AAAA-MM-DD HH:mm:ss".
datetime	date_end	Data e hora final de cadastro dos registros, formato "AAAA-MM-DD HH:mm:ss".
boolean	validated	Informa se deve, ou não, exibir somente as contas de envio validadas ou não.
boolean	mapping	Informa se deve, ou não, exibir somente as contas com "mapping" ativado.
boolean	analytics	Informa se deve, ou não, exibir somente as contas com "analytics" ativado.
boolean	auto_release	Informa se deve, ou não, exibir somente as contas com "auto-release" ativado.
string	order	Identificação do campo para ordenação dos registros retornados.
int	begin	Posição do primeiro registro a ser retornado pela pesquisa.
int	limit	Quantidade/limite de registros a serem retornados.

Int

editionAccountCreate ( string name , string label , string email , string replyto , string abuse , boolean mapping , boolean analytics , boolean auto_release , string address , string city , string state , string country , string phone_country , string phone_code , string phone_number , string organization )

Cadastra um novo registro de conta de envio com os dados passados.

[+] Parâmetros:

string	name	Nome de identificação da conta de envio, para exibição no sistema.
string	label	Nome do remetente da conta de envio, para exibição nos e-mails.
string	email	Endereço de e-mail que será exibido nos e-mail enviados pelo sistema.
string	replyto	Endereço de e-mail que será definido como endereço de resposta aos e-mails.
string	abuse	Endereço de e-mail que receberá os e-mails de cancelamento dos contatos.
boolean	mapping	Informa se o "mapping" da conta de envio deve ser ativado ou não.
boolean	analytics	Informa se o "analytics" da conta de envio deve ser ativado ou não.
boolean	auto_release	Informa se o "auto-release" da conta de envio deve ser ativado ou não.
string	address	Endereço relacionado à da conta de envio, para assinatura digital.
string	city	Nome da cidade relacionada à conta de envio, para assinatura digital.
string	state	Nome do estado relacionada à conta de envio, para assinatura digital.
string	country	Nome do país relacionado à conta de envio, para assinatura digital.
string	phone_country	Código de área do país, para adição do telefone à assinatura digital.
string	phone_code	Código de área do estado, para adição do telefone à assinatura digital.
string	phone_number	Número do telefone relacionado, para adição do mesmo à assinatura digital.
string	organization	Nome da empresa relacionada à conta de envio, para assinatura digital.

Boolean

editionAccountDelete ( int account_id )

Envia o registro da conta de envio de edições "ativa" para a lixeira.

[+] Parâmetros:

Boolean

editionAccountUpdate ( int account_id , string name , string label , string email , string replyto , string abuse , boolean mapping , boolean analytics , boolean auto_release , string address , string city , string state , string country , string phone_country , string phone_code , string phone_number , string organization )

Atualiza um registro de conta de envio existente a partir dos dados passados.

[+] Parâmetros:

int	account_id	Identificação "id" do grupo a ser modificado na base.
string	name	Nome de identificação da conta de envio, para exibição no sistema.
string	label	Nome do remetente da conta de envio, para exibição nos e-mails.
string	email	Endereço de e-mail que será exibido nos e-mail enviados pelo sistema.
string	replyto	Endereço de e-mail que será definido como endereço de resposta aos e-mails.
string	abuse	Endereço de e-mail que receberá os e-mails de cancelamento dos contatos.
boolean	mapping	Informa se o "mapping" da conta de envio deve ser ativado ou não.
boolean	analytics	Informa se o "analytics" da conta de envio deve ser ativado ou não.
boolean	auto_release	Informa se o "auto-release" da conta de envio deve ser ativado ou não.
string	address	Endereço relacionado à da conta de envio, para assinatura digital.
string	city	Nome da cidade relacionada à conta de envio, para assinatura digital.
string	state	Nome do estado relacionada à conta de envio, para assinatura digital.
string	country	Nome do país relacionado à conta de envio, para assinatura digital.
string	phone_country	Código de área do país, para adição do telefone à assinatura digital.
string	phone_code	Código de área do estado, para adição do telefone à assinatura digital.
string	phone_number	Número do telefone relacionado, para adição do mesmo à assinatura digital.
string	organization	Nome da empresa relacionada à conta de envio, para assinatura digital.

Array

editionMinings ( datetime date_begin , datetime date_end , int folder_id , string order , int begin , int limit )

Pesquisa e lista os filtros de contato, utilizados no envio de edições, de acordo com os parâmetros passados.

[+] Parâmetros:

Array

editionMiningFolders ( int parent_id , string order , int begin , int limit )

Pesquisa e lista as pastas de filtros de contato de acordo com os parâmetros passados.

[+] Parâmetros:

Boolean

editionPause ( int cid )

Define uma edição em andamento como "pausada", interrompendo o envio da mesma.

[+] Parâmetros:

Boolean

editionResume ( int cid )

Libera uma edição anteriormente "pausada", retomando o envio da mesma.

[+] Parâmetros:

Boolean

editionSendNow ( int cid )

Libera uma edição com situação "preparando", para que seja efetuado o envio da mesma na data e horário atuais.

[+] Parâmetros:

Boolean

editionSchedule ( int cid , datetime date_send )

Libera uma edição com situação "preparando", para que seja efetuado o envio da mesma na data e horário informados.

[+] Parâmetros:

Boolean

editionUnschedule ( int cid )

Redefine a situação de uma edição "liberada para envio" para "preparando", permitindo a edição da mesma.

[+] Parâmetros:

Métodos de "Contatos"

Array

contacts ( datetime date_begin , datetime date_end , string email , string order , int begin , int limit )

Pesquisa e lista os Contatos na base do usuário de acordo com os parâmetros passados.

[+] Parâmetros:

Array

contactCount ( )

Retorna o número total de contatos registrados junto ao sistema.

Array

contactInfo ( int cid )

Retorna os dados de cadastro presentes no registro de contato relacionado.

[+] Parâmetros:

Array

contactBatchInfo ( string cids )

Retorna lista de dados de cadastro presentes nos registros de contato relacionados.

[+] Parâmetros:

Array

contactStatus ( )

Retorna uma lista com os tipo de "situação" ao qual um contato pode estar definido.

Array

contactGroups ( int cid , string order , int begin , int limit )

Retorna uma lista com as afiliações do contato referente.

[+] Parâmetros:

Int

contactCreate ( string name , string email , boolean gender , date date_birth , array groups_id , multi {extras} )

Cadastra um novo registro de contato no sistema com os dados passados, ou retorna o ID do contato já existente.

[+] Parâmetros:

Boolean

contactDelete ( int cid )

Envia o registro do contato "ativo" para a lixeira, evitando o envio de e-mail ao mesmo.

[+] Parâmetros:

Boolean

contactBatchDelete ( int group_id , string cids )

Remove registros de contatos de um determinado grupo.

[+] Parâmetros:

Boolean

contactUpdate ( int cid , string name , string email , boolean gender , date date_birth , array groups_id , multi {extras} )

Atualiza os dados de um registro de contato no sistema com os dados passados.

[+] Parâmetros:

Boolean

contactSubscribe ( int cid , array groups_id )

Registra as afiliações do contato referente aos grupos de contato informados.

[+] Parâmetros:

Boolean

contactUnsubscribe ( int cid , array groups_id )

Remove as afiliações do contato referente aos grupos de contato informados.

[+] Parâmetros:

Boolean

contactCancel ( int cid )

Marca o contato como "solicitou remoção", para não enviar mais campanhas ao mesmo.

[+] Parâmetros:

Array

contactBatchSubscribe ( int group_id , array emails )

Cadastra e/ou afilia os emails dos contatos no grupo informado e retorna uma lista com os id´s e emails que foram afiliados.

[+] Parâmetros:

Array

contactBatchCreate ( int group_id , array metadata , boolean check , boolean update , boolean info )

Cadastra e/ou afilia os dados dos contatos no grupo informado e retorna uma lista com os id's dos contatos cadastrados e/ou afiliados.

[+] Parâmetros:

Métodos de "Grupos"

Array

groups ( int folder_id , int parent_id , string order , int begin , int limit )

Retorna uma lista dos grupos de contato registrados no sistema.

[+] Parâmetros:

Array

groupCount ( int parent_id , int folder_id )

Retorna o número total de grupos de contato registrados no sistema, filtrando pelo grupo "pai", caso desejado.

[+] Parâmetros:

Array

groupContacts ( int group_id , string order , int begin , int limit )

Retorna uma lista com os contatos afiliados ao grupo de contatos referente.

[+] Parâmetros:

Int

groupCreate ( int folder_id , int parent_id , string name , string description )

Cadastra um novo registro de grupo de contatos na pasta "pai" informada.

[+] Parâmetros:

Boolean

groupDelete ( int group_id )

Envia o registro do grupo de contatos "ativo" para a lixeira, juntamente com os contatos relacionados.

[+] Parâmetros:

Boolean

groupUpdate ( int group_id , string name , string description , int parent_id , int folder_id )

Atualiza um registro de grupo de contatos existente a partir dos dados passados.

[+] Parâmetros:

Array

groupFolders ( int parent_id , string order , int begin , int limit )

Retorna uma lista de todas as pastas de grupos de contatos registradas junto ao sistema.

[+] Parâmetros:

Array

groupFolderCount ( int parent_id )

Retorna o número total de pastas de grupos de contatos registrados no sistema, filtrando pela pasta "pai", caso desejado.

[+] Parâmetros:

Int

groupFolderCreate ( int parent_id , string name )

Cadastra um nova pasta de grupos de contatos na pasta "pai" informada.

[+] Parâmetros:

Boolean

groupFolderDelete ( int folder_id )

Deleta pasta de grupos de contatos.

[+] Parâmetros:

Boolean

groupFolderUpdate ( string name , int parent_id , int folder_id )

Atualiza um registro da pasta de grupos de contatos existente a partir dos dados passados.

[+] Parâmetros:

Métodos de "Relatórios das Edições"

Array

reportEditionStats ( int cid )

Retorna um relatório de dados relacionados à edição informada.

[+] Parâmetros:

Array

reportEditionGeoCountry ( int cid , boolean unique )

Retorna uma lista de dados relacionado à quantidade de acessos efetuados em uma edição por país.

[+] Parâmetros:

Array

reportEditionGeoRegion ( int cid , string country , boolean unique )

Retorna uma lista de dados relacionado à quantidade de acessos efetuados em uma edição por estado, relacionado ao país referente.

[+] Parâmetros:

Array

reportEditionSents ( int cid , datetime date_begin , datetime date_end , string order , int begin , int limit )

Retorna a lista de registros de envio de e-mails da edição.

[+] Parâmetros:

Array

reportEditionViews ( int cid , datetime date_begin , datetime date_end , boolean unique , string order , int begin , int limit )

Retorna a lista de registros de visualização dos e-mails da edição.

[+] Parâmetros:

Array

reportEditionClicks ( int cid , datetime date_begin , datetime date_end , int link_id , boolean unique , string order , int begin , int limit )

Retorna a lista de cliques registrados junto aos links da edição.

[+] Parâmetros:

int	cid	Identificação da edição na base de dados do sistema.
datetime	date_begin	Data e hora inicial de cadastro dos registros, formato "AAAA-MM-DD HH:mm:ss".
datetime	date_end	Data e hora final de cadastro dos registros, formato "AAAA-MM-DD HH:mm:ss".
int	link_id	Identificação "id" do link relacionado à edição, para filtro.
boolean	unique	Informa se deve exibir somente um registro relacionado à cada contato.
string	order	Identificação do campo para ordenação dos registros retornados.
int	begin	Posição do primeiro registro a ser retornado pela pesquisa.
int	limit	Identificação da edição na base de dados do sistema.

Array

reportEditionSoftBounces ( int cid , datetime date_begin , datetime date_end , string order , int begin , int limit )

Retorna a lista de erros de recebimento temporários, registrados junto à edição relacionado.

[+] Parâmetros:

Array

reportEditionHardBounces ( int cid , datetime date_begin , datetime date_end , string order , int begin , int limit )

Retorna a lista de erros de recebimento permanentes, registrados junto à edição relacionada.

[+] Parâmetros:

Array

reportEditionUnsubscribes ( int cid , datetime date_begin , datetime date_end , int contact_id , boolean cancel , string order , int begin , int limit )

Retorna a lista de contatos que efetuaram cancelamento, registrados junto à edição relacionada.

[+] Parâmetros:

int	cid	Identificação da edição na base de dados do sistema.
datetime	date_begin	Data e hora inicial de cadastro dos registros, formato "AAAA-MM-DD HH:mm:ss".
datetime	date_end	Data e hora final de cadastro dos registros, formato "AAAA-MM-DD HH:mm:ss".
int	contact_id	Identificação "id" do contatos relacionado, para filtro.
boolean	cancel	Informa se deve exibir só os contatos com cancelamento "permanente" ou "específico".
string	order	Identificação do campo para ordenação dos registros retornados.
int	begin	Posição do primeiro registro a ser retornado pela pesquisa.
int	limit	Identificação da edição na base de dados do sistema.

Array

reportEditionAbuses ( int cid , datetime date_begin , datetime date_end , string order , int begin , int limit )

Retorna a lista de abusos relatados pelos contatos junto à edição relacionada.

[+] Parâmetros:

Métodos de "Relatórios dos Contatos"

Array

reportContactSents ( int cid , datetime date_begin , datetime date_end , string order , int begin , int limit )

Retorna a lista de registros de envio de e-mails para o contato referente.

[+] Parâmetros:

Array

reportContactViews ( int cid , datetime date_begin , datetime date_end , int marketing_id , string order , int begin , int limit )

Retorna a lista de registros de visualização dos e-mails pelo contato.

[+] Parâmetros:

Array

reportContactClicks ( int cid , datetime date_begin , datetime date_end , int marketing_id , int link_id , string order , int begin , int limit )

Retorna a lista de cliques registrados para o contato junto aos links da edição.

[+] Parâmetros:

int	cid	Identificação do contato na base de dados do sistema.
datetime	date_begin	Data e hora inicial de cadastro dos registros, formato "AAAA-MM-DD HH:mm:ss".
datetime	date_end	Data e hora final de cadastro dos registros, formato "AAAA-MM-DD HH:mm:ss".
int	marketing_id	Identificação "id" da edição relacionada, para filtro.
int	link_id	Identificação "id" do link relacionado à edição, para filtro.
string	order	Identificação do campo para ordenação dos registros retornados.
int	begin	Posição do primeiro registro a ser retornado pela pesquisa.
int	limit	Identificação da edição na base de dados do sistema.

Array

reportContactSoftBounces ( int cid , datetime date_begin , datetime date_end , string order , int begin , int limit )

Retorna a lista de erros de recebimento temporários, registrados para o contato.

[+] Parâmetros:

Array

reportContactHardBounces ( int cid , datetime date_begin , datetime date_end , string order , int begin , int limit )

Retorna a lista de erros de recebimento permanentes, registrados para o contato.

[+] Parâmetros:

Métodos de "Relatórios dos Grupos"

Array

reportGroupStats ( int group_id )

Retorna um relatório de dados relacionados ao grupo de contatos informado.

[+] Parâmetros:

Métodos de "Relatórios Gerais"

Array

reportStats ( date date_begin , date date_end , int marketing_id , int begin , int limit )

Retorna um relatório de dados gerais de envio e interações de todas as edições, agrupado pela data de interação.

[+] Parâmetros:

Array

reportSents ( datetime date_begin , datetime date_end , int marketing_id , int contact_id , string order , int begin , int limit )

Retorna a lista de registros de envio de e-mails das edições do sistema.

[+] Parâmetros:

Array

reportViews ( datetime date_begin , datetime date_end , int marketing_id , int contact_id , boolean unique , string order , int begin , int limit )

Retorna a lista de contatos que visualizaram as edições enviadas pelo sistema.

[+] Parâmetros:

datetime	date_begin	Data e hora inicial de cadastro dos registros, formato "AAAA-MM-DD HH:mm:ss".
datetime	date_end	Data e hora final de cadastro dos registros, formato "AAAA-MM-DD HH:mm:ss".
int	marketing_id	Identificação "id" da edição relacionada, para filtro.
int	contact_id	Identificação "id" do contatos relacionado, para filtro.
boolean	unique	Informa se deve exibir somente um registro relacionado à cada contato.
string	order	Identificação do campo para ordenação dos registros retornados.
int	begin	Posição do primeiro registro a ser retornado pela pesquisa.
int	limit	Identificação da edição na base de dados do sistema.

Array

reportClicks ( datetime date_begin , datetime date_end , int marketing_id , int link_id , int contact_id , boolean unique , string order , int begin , int limit )

Retorna a lista de cliques registrados junto às edições do sistema.

[+] Parâmetros:

datetime	date_begin	Data e hora inicial de cadastro dos registros, formato "AAAA-MM-DD HH:mm:ss".
datetime	date_end	Data e hora final de cadastro dos registros, formato "AAAA-MM-DD HH:mm:ss".
int	marketing_id	Identificação "id" da edição relacionada, para filtro.
int	link_id	Identificação "id" do link relacionado à edição, para filtro.
int	contact_id	Identificação "id" do contatos relacionado, para filtro.
boolean	unique	Informa se deve exibir somente um registro relacionado à cada contato.
string	order	Identificação do campo para ordenação dos registros retornados.
int	begin	Posição do primeiro registro a ser retornado pela pesquisa.
int	limit	Identificação da edição na base de dados do sistema.

Array

reportBounces ( datetime date_begin , datetime date_end , int marketing_id , int contact_id , boolean temporary , string order , int begin , int limit )

Retorna a lista de erros de recebimento registrados pelos envios das edições.

[+] Parâmetros:

datetime	date_begin	Data e hora inicial de cadastro dos registros, formato "AAAA-MM-DD HH:mm:ss".
datetime	date_end	Data e hora final de cadastro dos registros, formato "AAAA-MM-DD HH:mm:ss".
int	marketing_id	Identificação "id" da edição relacionada, para filtro.
int	contact_id	Identificação "id" do contatos relacionado, para filtro.
boolean	temporary	Informa se deve, ou não, exibir somente os "bounces" temporários ou permanentes.
string	order	Identificação do campo para ordenação dos registros retornados.
int	begin	Posição do primeiro registro a ser retornado pela pesquisa.
int	limit	Identificação da edição na base de dados do sistema.

Array

reportUnsubscribes ( datetime date_begin , datetime date_end , int marketing_id , int contact_id , boolean cancel , string order , int begin , int limit )

Retorna a lista de contatos que cancelaram o recebimento das edições do sistema.

[+] Parâmetros:

datetime	date_begin	Data e hora inicial de cadastro dos registros, formato "AAAA-MM-DD HH:mm:ss".
datetime	date_end	Data e hora final de cadastro dos registros, formato "AAAA-MM-DD HH:mm:ss".
int	marketing_id	Identificação "id" da edição relacionada, para filtro.
int	contact_id	Identificação "id" do contatos relacionado, para filtro.
boolean	cancel	Informa se deve exibir só os contatos com cancelamento "permanente" ou "específico".
string	order	Identificação do campo para ordenação dos registros retornados.
int	begin	Posição do primeiro registro a ser retornado pela pesquisa.
int	limit	Identificação da edição na base de dados do sistema.

Array

reportAbuses ( int cid , datetime date_begin , datetime date_end , int marketing_id , string order , int begin , int limit )

Retorna a lista de abusos relatados pelos contatos nas edições do sistema.

[+] Parâmetros:

Array

reportBlacklist ( date date_begin , date date_end , string order , int begin , int limit )

Retorna um relatório de dados com os e-mails registrados na lista negra da base do cliente.

[+] Parâmetros:

Array

reportNotifyMessages ( boolean displayed , date date_begin , date date_end , string order , int begin , int limit )

Retorna uma lista de mensagens de notificação registradas na base de dados do cliente.

[+] Parâmetros:

Array

reportNotifyCount ( boolean displayed )

Retorna o número total de mensagens de notificação registradas na base de dados do cliente, visualizadas ou não.

[+] Parâmetros:

Métodos de "Usuarios"

Array

users ( string order , int begin , int limit )

Retorna a lista dos usuários registrados no sistema.

[+] Parâmetros:

Int

userCreate ( string name , string email , int permission_id , array departaments_id , string password , boolean active )

Cadastra um novo registro de usuário no sistema com os dados passados, ou retorna o ID do usuário já existente.

[+] Parâmetros:

Int

userUpdate ( int uid , string name , int permission_id , array departaments_id , boolean active )

Atualiza registro de usuário existente no sistema com os dados passados.

[+] Parâmetros:

Boolean

userDelete ( int uid )

Exclui um cadastro de usuário existente no sistema, removendo acesso.

[+] Parâmetros:

Array

userPermissions ( string order , int begin , int limit )

Retorna lista dos grupos de permissão relacionados aos usuários.

[+] Parâmetros:

Array

userDepartaments ( string order , int begin , int limit )

Retorna lista de departamentos ao quais os usuários podem estar associados.

[+] Parâmetros:

Métodos de "Revenda"

Array

resellerClients ( string order , int begin , int limit )

Retorna a lista dos clientes da revenda já cadastrados.

[+] Parâmetros:

Int

resellerClientCreate ( string domain , string name , string email , string password , int plan_id )

Cria novo cliente de revenda, de acordo com os dados passados.

[+] Parâmetros:

Boolean

resellerClientUpdate ( string cid , string name , int plan_id , boolean status )

Altera registro do cliente de revenda, de acordo com os dados passados.

[+] Parâmetros:

Boolean

resellerClientDelete ( string cid )

Remove registro do cliente de revenda, marcando a base para remoção.

[+] Parâmetros:

Array

resellerPlans ( string order , int begin , int limit )

Retorna a lista dos planos da revenda já cadastrados.

[+] Parâmetros:

Int

resellerPlanCreate ( string name , string description , int limit_contacts , int limit_period )

Cria novo plano da revenda, de acordo com os dados passados.

[+] Parâmetros:

Boolean

resellerPlanUpdate ( int plan_id , string name , string description )

Alterado plano da revenda existente, de acordo com os dados passados.

[+] Parâmetros:

Boolean

resellerPlanDelete ( int plan_id )

Remove plano da revenda informado, mantendo limite dos clientes.

[+] Parâmetros:

Array

resellerReport ( datetime date_begin , datetime date_end , string domain , string order , int begin , int limit )

Retorna a lista dos clientes que efetuaram disparo no período.

[+] Parâmetros: