Gerencie as informações de sua conta.
A autenticação é realizada através da inclusão do parâmetro “chave” na URL. Esta chave pode ser gerada no sistema, na seção "Chaves da API". Exemplo:
$ curl -X GET https://api.criaenvio.com/v1/campos?chave=V2FASZTf208fhs98cwuTVZ4WHcuZkcwMWguDssY=
Para requisições POST e PUT, os parâmetros não incluidos na URL devem ser codificados em JSON com um header "Content-Type: application/json". Exemplo:
$ curl -X PUT -H "Content-Type:application/json" -d '{"campo": "Valor"}' https://api.criaenvio.com
Requisições que retornam múltiplos itens serão paginadas com 30 itens por padrão. Você pode especificar as páginas através do parâmetro "page". Para alguns recursos você pode definir um tamanho de página, com um limite superior de 100 itens, através do parâmetro "number".
Essas requisições acompanham um objeto JSON chamado "pagination", com informações adicionais sobre a paginação. Exemplo:
...,
pagination: {
total: 18
count: 18
per_page: 30
current_page: 1
total_pages: 1
links: [ ]
}
Abaixo serão detalhados os recursos existentes na API.
Destinatários para os quais as mensagens são enviadas.
Visualiza um único contato.
string (required) Example: ioddw4ID do contato
string (optional) Example: gruposDados relacionados
Choices: grupos campos
200ShowHide{
"data": {
"id": "idasd",
"nome": "Editado",
"email": "[email protected]",
"qualidade": "2",
"ativo": false,
"descadastrado": false,
"sexo": "m",
"dataNascimento": "2012-02-02",
"dataCadastro": "2014-03-10 18:20:12"
}
}
ou
{
"data": {
"id": "idasd",
"nome": "Editado",
"email": "[email protected]",
"qualidade": "2",
"ativo": false,
"descadastrado": false,
"sexo": "m",
"dataNascimento": "2012-02-02",
"dataCadastro": "2014-03-10 18:20:12"
"campos": {
"data": [
{
"id": "ifafe",
"nome": "campo personalizado 1",
"valor": "valor do campo para este contato"
},
{
"id": "itota",
"nome": "campor personalizado 2",
"valor": "valor deste outro campo para este contato"
},
]
}
}
}
ou
{
"data": {
"id": "idasd",
"nome": "Editado",
"email": "[email protected]",
"qualidade": "2",
"ativo": false,
"descadastrado": false,
"sexo": "m",
"dataNascimento": "2012-02-02",
"dataCadastro": "2014-03-10 18:20:12"
"grupos": {
"data": [
{
"id": "iGfd",
"nome": "Nome da Lista",
"ativo": true,
"contatos_ativos": "3212"
},
{
"id": "iZip",
"nome": "Nome de Outra Lista",
"ativo": true,
"contatos_ativos": "1530"
},
],
"pagination":
{
...
}
}
}
}
404ShowHide{
"error": {
"code":"01-NAO-ENCONTRADO",
"http_code":404,
"message":"Registro não encontrado."
}
}
500ShowHide{
"error": {
"code":"04-ERRO-INTERNO",
"http_code":500,
"message":"Internal Error"
}
}
Atualiza um contato.
string (required) Example: ioddw4ID do contato
string (optional) Example: gruposDados relacionados
Choices: grupos campos
Content-Type: application/json
{
"nome": "novo nome para contato",
"sexo": "m",
"data_de_nascimento": "02/02/2012"
}
200ShowHide {
"data": {
"OK": "OK"
}
}
404ShowHide{
"error": {
"code":"01-NAO-ENCONTRADO",
"http_code":404,
"message":"Registro não encontrado."
}
}
400ShowHide{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":404,
"message":"Erro ao processar requisição. Detalhe(s): ..."
}
}
ou
{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":400,
"message":"Já existe um contato com este email. Tente atualizá-lo."
}
}
ou
{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":400,
"message":"Não é possível editar o e-mail de um contato que já recebeu envios."
}
}
Cria um novo contato.
Content-Type: application/json
{
"nome": "novo contato",
"email": "[email protected]",
"sexo": "f",
"data_de_nascimento": "02/02/2012"
}
200ShowHide{
"data" : {
"id": "Fssd12",
"nome": "novo contato",
"email": "[email protected]",
"sexo": "f",
"data_de_nascimento": "02/02/2012"
}
}
400ShowHide{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":400,
"message":"Erro ao processar requisição. Detalhe(s): ..."
}
}
ou
{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":400,
"message":"Já existe um contato com este email. Tente atualizá-lo."
}
}
Busca contatos.
string (optional) Example: io4,sd0Lista de IDs de contatos, separados por vírgula
string (optional) Example: Campo de testeNome do contato
string (optional) Example: @yahoo.comE-mail do contato
string (optional) Example: mSexo do contato
Choices: m f mf vazio
integer (optional) Example: 18Idade mínima do contato
integer (optional) Example: 70Idade máxima do contato
string (optional) Example: 10/01/2010Data de cadastro mínima do contato
string (optional) Example: 10/01/2014Data de cadastro máxima do contato
string (optional) Example: 10/01/1986Data de nascimento mínima do contato
string (optional) Example: 10/01/1999Data de nascimento máxima do contato
string (optional) Example: 31/01Faixa inferior do aniversário do contato
string (optional) Example: 31/01Faixa superior do aniversário do contato
string (optional) Default: ativos Example: todosStatus do contato
Choices: ativos inativos descadastros todos
string (optional) Example: 5,6,7Lista de valores, separados por vírgula
string (optional) Example: valor do campoValor de um campo personalizado
200ShowHide{
"data": [
{
"id":"k",
"nome":"Editado",
"email":"[email protected]",
"qualidade":"2",
"ativo":true,
"descadastrado":false,
"sexo":"m",
"dataNascimento":"2012-02-02",
"dataCadastro":"2013-01-20 09:27:05"
},
{
"id":"E",
"nome":"",
"email":"[email protected]",
"qualidade":"5",
"ativo":true,
"descadastrado":false,
"sexo":null,
"dataNascimento":null,
"dataCadastro":"2014-02-18 18:58:10"
}
],
"pagination":
{
...
}
}
Ativa um contato.
Atenção: Não é possível ativar um contato descadastrado.
string (required) Example: io4ID do contato
200ShowHide{
"data": {
"OK": "OK"
}
}
400ShowHide{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":400,
"message":"Erro ao processar requisição. Detalhe(s): ..."
}
}
401ShowHide{
"error": {
"code":"03-NAO-AUTORIZADO",
"http_code":401,
"message":"Não é possível ativar um contato descadastrado."
}
}
404ShowHide{
"error": {
"code":"01-NAO-ENCONTRADO",
"http_code":404,
"message":"Registro não encontrado."
}
}
Desativa um contato.
string (required) Example: io4ID do contato
200ShowHide{
"data": {
"OK": "OK"
}
}
400ShowHide{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":400,
"message":"Erro ao processar requisição. Detalhe(s): ..."
}
}
404ShowHide{
"error": {
"code":"01-NAO-ENCONTRADO",
"http_code":404,
"message":"Registro não encontrado."
}
}
Inscreve o contato em uma ou mais listas.
string (required) Example: io4ID do contato
Content-Type: application/json
{
"idGrupos": "io4, lis2, jj",
}
200ShowHide{
"data": {
"OK": "OK"
}
}
404ShowHide{
"error": {
"code":"01-NAO-ENCONTRADO",
"http_code":404,
"message":"Registro não encontrado."
}
}
400ShowHide{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":400,
"message":"Erro ao processar requisição. Detalhe(s): ..."
}
}
ou
{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":400,
"message":"Não foram encontrado os ids de grupos."
}
}
ou
{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":400,
"message":"Limite de registros excedido."
}
}
Desinscreve o contato de uma ou mais listas.
string (required) Example: io4ID do contato
Content-Type: application/json
{
"idGrupos": "io4, lis2, jj",
}
200ShowHide{
"data": {
"OK": "OK"
}
}
404ShowHide{
"error": {
"code":"01-NAO-ENCONTRADO",
"http_code":404,
"message":"Registro não encontrado."
}
}
400ShowHide{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":400,
"message":"Erro ao processar requisição. Detalhe(s): ..."
}
}
ou
{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":400,
"message":"Não foram encontrado os ids de grupos."
}
}
ou
{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":400,
"message":"Limite de registros excedido."
}
}
Atualiza os campos personalizados do contato.
string (required) Example: io4ID do contato
Content-Type: application/json
{
"campos": {
"iof": "valor para o campo",
"io4k": "outro valor"
}
}
200ShowHide{
"data": {
"OK": "OK"
}
}
404ShowHide{
"error": {
"code":"01-NAO-ENCONTRADO",
"http_code":404,
"message":"Registro não encontrado."
}
}
400ShowHide{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":400,
"message":"É necessário informar ao menos um campo para realizar a atualização."
}
}
ou
{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":400,
"message":"Erro ao processar requisição. Detalhe(s): ..."
}
}
ou
{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":400,
"message":"Limite de registros excedido."
}
}
Conjunto de contatos.
Visualiza uma única lista.
string (required) Example: io4ID da lista
string (optional) Example: contatosDados relacionados
Choices: contatos
string (optional) Default: ativos Example: todosStatus dos contatos inscritos
Choices: inativos descadastros todos ativos
200ShowHide{
"data": {
"id": "io4",
"nome": "Nome da lista",
"ativo": true,
"contatos_ativos": "22"
}
}
ou
{
"data": {
"id": "io4",
"nome": "Nome da lista",
"ativo": true,
"contatos_ativos": "22",
"contatos": {
"data": [
{
"id":"k",
"nome":"Editado",
"email":"[email protected]",
"qualidade":"2",
"ativo":true,
"descadastrado":false,
"sexo":"m",
"dataNascimento":"2012-02-02",
"dataCadastro":"2013-01-20 09:27:05"
},
{
"id":"E",
"nome":"",
"email":"[email protected]",
"qualidade":"5",
"ativo":true,
"descadastrado":false,
"sexo":null,
"dataNascimento":null,
"dataCadastro":"2014-02-18 18:58:10"
}
],
"pagination":
{
...
}
}
}
}
404ShowHide{
"error": {
"code":"01-NAO-ENCONTRADO",
"http_code":404,
"message":"Registro não encontrado."
}
}
Atualiza uma lista.
string (required) Example: io4ID da lista
string (optional) Example: contatosDados relacionados
Choices: contatos
string (optional) Default: ativos Example: todosStatus dos contatos inscritos
Choices: inativos descadastros todos ativos
Content-Type: application/json
{
"nome": "Novo nome da lista"
}
200ShowHide{
"data": {
"OK": "OK"
}
}
404ShowHide{
"error": {
"code":"01-NAO-ENCONTRADO",
"http_code":404,
"message":"Registro não encontrado."
}
}
400ShowHide{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":404,
"message":"Erro ao processar requisição. Detalhe(s): ..."
}
}
Cria uma nova lista.
Content-Type: application/json
{
"nome": "Nome da nova lista"
}
200ShowHide{
"data" : {
"id": "FHId12",
"nome": "Nome da nova lista",
"ativo": true,
"contatos_ativos": "0"
}
}
400ShowHide{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":404,
"message":"Erro ao processar requisição. Detalhe(s): ..."
}
}
Busca listas.
string (optional) Example: io4,sd0Lista de IDs de listas, separados por vírgula
string (optional) Example: Campo de testeNome da lista
string (optional) Default: true Example: trueStatus da lista
Choices: true false
200ShowHide{
"data": [
{
"id": "DHIda",
"nome": "Campo de teste",
"ativo": true,
"contatos_ativos": "21"
},
{
"id": "io4",
"nome": "Lista de Exemplo",
"ativo": true,
"contatos_ativos": "11"
}
],
"pagination":
{
...
}
}
Ativa uma ou mais listas.
string (required) Example: io4,sd0Lista de IDs de listas, separados por vírgula
200ShowHide{
"data": {
"OK": "OK"
}
}
400ShowHide{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":400,
"message":"Argumentos inválidos."
}
}
ou
{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":400,
"message":"Erro ao processar requisição. Detalhe(s): ..."
}
}
404ShowHide{
"error": {
"code":"01-NAO-ENCONTRADO",
"http_code":404,
"message":"Registro não encontrado."
}
}
Desativa uma ou mais listas.
string (required) Example: io4,sd0Lista de IDs de listas, separados por vírgula
200ShowHide{
"data": {
"OK": "OK"
}
}
400ShowHide{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":400,
"message":"Argumentos inválidos."
}
}
ou
{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":400,
"message":"Erro ao processar requisição. Detalhe(s): ..."
}
}
404ShowHide{
"error": {
"code":"01-NAO-ENCONTRADO",
"http_code":404,
"message":"Registro não encontrado."
}
}
Índices utilizados para definir os atributos de um contato.
Visualiza um único campo personalizado.
string (required) Example: d12I4ID do campo personalizado
Atualiza um campo personalizado.
string (required) Example: d12I4ID do campo personalizado
Content-Type: application/json
{
"nome": "Novo nome do campo personalizado"
}
200ShowHide{
"data": {
"OK": "OK"
}
}
404ShowHide{
"error": {
"code":"01-NAO-ENCONTRADO",
"http_code":404,
"message":"Campo personalizado não encontrado."
}
}
400ShowHide{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":404,
"message":"O nome do campo deve ser informado."
}
}
ou
{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":404,
"message":"Erro ao processar requisição. Detalhe(s): ..."
}
}
Remove um campo personalizado.
Atenção: Essa ação remove permanentemente todas as informações do campo personalizado.
string (required) Example: d12I4ID do campo personalizado
200ShowHide {
"data": {
"OK": "OK"
}
}
404ShowHide{
"error": {
"code":"01-NAO-ENCONTRADO",
"http_code":404,
"message":"Campo personalizado não encontrado."
}
}
400ShowHide{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":404,
"message":"Erro ao processar requisição. Detalhe(s): ..."
}
}
Cria um novo campo personalizado.
Content-Type: application/json
{
"nome": "Nome do campo personalizado"
}
200ShowHide{
"data" : {
"id": "FHId12",
"nome": "Nome do campo personalizado"
}
}
400ShowHide{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":404,
"message":"Erro ao processar requisição. Detalhe(s): ..."
}
}
Busca campos personalizados.
string (optional) Example: d12I4ID do campo personalizado
string (optional) Example: Campo de testeNome do campo personalizado
200ShowHide{
"data": [
{
"id": "DHIda",
"nome": "Campo de teste"
},
{
"id": "ASDdh1",
"nome": "Mês de aniversário"
}
],
"pagination":
{
...
}
}
E-mails remetentes configurados na conta.
Busca remetentes.
string (optional) Example: d12I4ID do remetente
string (optional) Example: Nome da ContaNome do remetente
string (optional) Example: [email protected]E-mail do remetente
200ShowHide{
"data": [
{
"id": "Eo",
"nome": "Nome do remetente",
"email": "[email protected]",
"principal": true,
"confirmado": true
},
{
"id": "Xo",
"nome": "Nome do remetente 2",
"email": "[email protected]",
"principal": false,
"confirmado": true
}
],
"pagination":
{
...
}
}
Mensagens da conta.
Visualiza uma única mensagem.
string (required) Example: sdID da mensagem
200ShowHide{
"data": {
"assunto": "Novo teste",
"contador": "22",
"dataCadastro": "2015-02-02",
"emailResposta": "[email protected]",
"id": "-q",
"html": "html da mensagem",
"jaEnviada": true,
"mensagemDescadastro": "caso queira sair da lista",
"nome": "Nome da mensagem"
}
}
404ShowHide{
"error": {
"code":"01-NAO-ENCONTRADO",
"http_code":404,
"message":"Mensagem não encontrada."
}
}
Atualiza uma mensagem.
Observação: Ao atualizar uma mensagem que já foi enviada, o sistema cria uma nova mensagem por fins de referência a versão antiga.
string (required) Example: -jID da mensagem
string (optional) Example: Assunto testeAssunto da mensagem
string (optional) Example: Dia das mãesHTML da mensagem
string (optional) Example: Nome da newsletterNome secundário da mensagem
string (optional) Example: [email protected]E-mail de resposta da mensagem
string (optional) Example: Quer sair?Mensagem localizada antes do link de cancelamento
Content-Type: application/json
{
"assunto": "Assunto da mensagem",
"html": "<html><body>Corpo da mensagem</body></html>",
"nome": "Nome secundário da mensagem",
"email_resposta": "[email protected]",
"mensagem_descadastro": "Deseja sair da lista? Clique ao lado"
}
200ShowHide{
"data": {
"OK": "OK",
"registro" : {
"id": "-X",
"contador": "112",
"assunto": "Assunto da mensagem",
"html": "<html><body>Corpo da mensagem</body></html>",
"nome": "Nome secundário da mensagem",
"dataCadastro": "2015-07-21",
"emailResposta": "[email protected]",
"mensagemDescadastro": "Deseja sair da lista? Clique ao lado",
"jaEnviada": false
}
}
}
400ShowHide{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":400,
"message":"Erro ao processar requisição. Detalhe(s): ..."
}
}
ou
{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":400,
"message":"Tamanho de mensagem excedido."
}
}
404ShowHide{
"error": {
"code":"01-NAO-ENCONTRADO",
"http_code":404,
"message":"Mensagem não encontrada."
}
}
500ShowHide{
"error": {
"code":"04-ERRO-INTERNO",
"http_code":500,
"message":"Falha ao calcular o tamanho da mensagem. Tente mais tarde."
}
}
Remove uma mensagem.
Atenção: Apenas mensagens que não foram enviadas podem ser removidas.
string (required) Example: sdID da mensagem
200ShowHide {
"data": {
"OK": "OK"
}
}
404ShowHide{
"error": {
"code":"01-NAO-ENCONTRADO",
"http_code":404,
"message":"Mensagem não encontrada."
}
}
401ShowHide{
"error": {
"code":"03-NAO-AUTORIZADO",
"http_code":401,
"message":"Não é possível remover uma mensagem que já foi enviada."
}
}
400ShowHide{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":404,
"message":"Erro ao processar requisição. Detalhe(s): ..."
}
}
Cria uma nova mensagem.
string (required) Example: Assunto testeAssunto da mensagem
string (required) Example: Dia das mãesHTML da mensagem
string (optional) Example: Nome da newsletterNome secundário da mensagem
string (optional) Example: [email protected]E-mail de resposta da mensagem
string (optional) Example: Quer sair?Mensagem localizada antes do link de cancelamento
Content-Type: application/json
{
"assunto": "Assunto da mensagem",
"html": "<html><body>Corpo da mensagem</body></html>",
"nome": "Nome secundário da mensagem",
"email_resposta": "[email protected]",
"mensagem_descadastro": "Deseja sair da lista? Clique ao lado"
}
200ShowHide{
"data" : {
"id": "-X",
"contador": "112",
"assunto": "Assunto da mensagem",
"html": "<html><body>Corpo da mensagem</body></html>",
"nome": "Nome secundário da mensagem",
"dataCadastro": "2015-07-21",
"emailResposta": "[email protected]",
"mensagemDescadastro": "Deseja sair da lista? Clique ao lado",
"jaEnviada": false
}
}
400ShowHide{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":400,
"message":"Campo assunto/html não preenchido."
}
}
ou
{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":400,
"message":"Erro ao processar requisição. Detalhe(s): ..."
}
}
ou
{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":400,
"message":"Tamanho de mensagem excedido."
}
}
500ShowHide{
"error": {
"code":"04-ERRO-INTERNO",
"http_code":500,
"message":"Falha ao calcular o tamanho da mensagem. Tente mais tarde."
}
}
Busca mensagens.
string (optional) Example: d12I4,-WID(s) da mensagem
string (optional) Example: Dia das mãesAssunto da mensagem
string (optional) Example: Nome exemploNome da mensagem
string (optional) Example: 92Lista de contadores da mensagem
string (optional) Example: 10/01/2010Data de cadastro mínima da mensagem
string (optional) Example: 10/01/2015Data de cadastro máxima da mensagem
200ShowHide{
"data": [
{
"assunto": "Novo teste",
"contador": "22",
"dataCadastro": "2015-02-02",
"emailResposta": "[email protected]",
"id": "-q",
"jaEnviada": true,
"mensagemDescadastro": "caso queira sair da lista",
"nome": "Nome da mensagem"
},
{
"assunto": "Novo Teste 2",
"contador": "94",
"dataCadastro": "2015-03-06",
"emailResposta": "[email protected]",
"id": "-W",
"jaEnviada": false,
"mensagemDescadastro": "caso queira sair da lista",
"nome": null
}
],
"pagination":
{
...
}
}
Realiza o envio teste da mensagem para a Lista Teste.
200ShowHide {
"data": {
"OK": "OK"
}
}
400ShowHide{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":400,
"message":"Não existem contatos válidos na Lista Teste."
}
}
404ShowHide{
"error": {
"code":"01-NAO-ENCONTRADO",
"http_code":404,
"message":"Mensagem não encontrada."
}
}
500ShowHide{
"error": {
"code":"04-ERRO-INTERNO",
"http_code":500,
"message":"Falha realizar o envio para a Lista Teste. Tente mais tarde."
}
}
Envios da conta.
Visualiza uma único envio.
string (required) Example: io4ID do envio
string (optional) Example: listas,mensagemDados relacionados
Choices: listas mensagem remetente
200ShowHide{
"data": {
"id": "Lz",
"codigo": "54",
"status": "Concluído",
"data_de_criacao": "2013-11-20 16:07:19.594479",
"data_de_inicio": "2013-11-20 16:07:19.594479",
"data_de_termino": null,
"total_de_contatos": 430,
"total_enviado": 0,
"rejeitados": 0,
"nao_rejeitados": 0,
"descadastros": 0,
"visualizacoes_totais": 0,
"visualizacoes_unicas": 0,
"cliques_totais": 0,
"cliques_unicos": 0,
"taxa_de_abertura": 0,
"taxa_de_clique": 0,
"taxa_de_rejeicao": 0,
"remetente": "",
"mensagem": {
"data": [
{
"id": "LN",
"contador": "85",
"assunto": "testedasdsad",
"html": "<html><head><\\/head><body>\\\r\\\n\\\t\\\t<p>\\\r\\\n\\\t\\\t\\\tteste<\\/p>\\\r\\\n\\\t\\\r\\\n<\\/body><\\/html>",
"nome": "testes",
"dataCadastro": "2013-10-15",
"emailResposta": null,
"mensagemDescadastro": "caso você deseje remover seu cadastro de nossa listas",
"jaEnviada": true
}
]
},
"listas": {
"data": [
{
"id": "b",
"nome": "gg",
"ativo": true,
"contatos_ativos": null
},
{
"id": "T6",
"nome": "NomeQualquer",
"ativo": true,
"contatos_ativos": null
}
]
},
"porcentagem_de_conclusao": 0
},
"embeds": [
"mensagem",
"remetente",
"listas"
]
}
404ShowHide{
"error": {
"code":"01-NAO-ENCONTRADO",
"http_code":404,
"message":"Registro não encontrado."
}
}
Cria um novo envio.
string (required) Example: TkID da mensagem a ser enviada
string (required) Example: 3l,3sLista de IDs das listas
string (required) Example: 01/01/2015 21:10Data de início do envio, ou a palavra ‘agora’ para início imediato
string (optional) Example: SfRemetente do envio
Content-Type: application/json
{
"mensagem": "Tk",
"listas": "Lk,3s,r4",
"data_de_inicio": "agora",
}
200ShowHide{
"data": {
"id": "JW",
"codigo": "1924",
"id_mensagem": "TI",
"status": "Em criação",
"data_de_criacao": "2015-08-13 20:35:55.135908",
"data_de_inicio": "2015-09-01 10:10:00",
"data_de_termino": null,
"total_de_contatos": 38150,
"porcentagem_de_conclusao": "0.00"
}
}
400ShowHide{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":400,
"message":"Parâmetro "x" não preenchido corretamente."
}
}
ou
{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":400,
"message":"A data/hora de agendamento escolhida pertence ao passado. Favor preencher com uma data futura ou a opção "agora" para iniciar o envio imediatamente."
}
}
ou
{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":400,
"message":"Somente remetentes confirmados podem ser utilizados."
}
}
401ShowHide{
"error": {
"code":"03-NAO-AUTORIZADO",
"http_code":401,
"message":"O envio não pode exceder a quantidade de créditos que você possui. Reduza o número de destinatários ou adquira mais créditos e tente novamente."
}
}
Busca envios.
string (optional) Example: d12I4,-WLista de ID(s) dos envios
string (optional) Example: 92Lista de códigos dos envios
string (optional) Example: 2,3Lista de códigos de status
Choices: 0 (Suspenso) 1 (Enviando) 2 (Concluído) 3 (Cancelado) 4 (Agendado) 5 (Em criação)
200ShowHide{
"data": [
{
"id": "f",
"codigo": "11",
"id_mensagem": "L4",
"status": "Concluído",
"data_de_criacao": "2013-09-06 18:01:19.634969",
"data_de_inicio": "2013-09-06 18:01:19.634969",
"data_de_termino": null,
"total_de_contatos": 432,
"porcentagem_de_conclusao": "46.30"
},
...
],
"pagination":
{
...
}
}
Pausa/suspende um envio.
string (required) Example: io4ID do envio
200ShowHide {
"data": {
"OK": "OK"
}
}
400ShowHide{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":400,
"message":"Não é possível pausar o envio devido ao seu status atual."
}
}
404ShowHide{
"error": {
"code":"01-NAO-ENCONTRADO",
"http_code":404,
"message":"Envio não encontrado."
}
}
Cancela um envio.
string (required) Example: io4ID do envio
200ShowHide {
"data": {
"OK": "OK"
}
}
400ShowHide{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":400,
"message":"Não é possível cancelar o envio devido ao seu status atual."
}
}
404ShowHide{
"error": {
"code":"01-NAO-ENCONTRADO",
"http_code":404,
"message":"Envio não encontrado."
}
}
Retoma ou agenda um envio que está pausado ou agendado.
string (required) Example: io4ID do envio
string (required) Example: 01/01/2015 21:10Data de reinício do envio, ou a palavra ‘agora’ para reinício imediato
Content-Type: application/json
{
"data": "agora",
}
200ShowHide{
"data": {
"OK": "OK"
}
}
400ShowHide{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":400,
"message":"A data/hora de agendamento escolhida pertence ao passado. Favor preencher com uma data futura ou a opção "agora" para iniciar o envio imediatamente."
}
}
ou
{
"error": {
"code":"02-ARGUMENTOS-INVALIDOS",
"http_code":400,
"message":"Não é possível cancelar o envio devido ao seu status atual."
}
}
Generated by aglio on 19 Aug 2015