voltar

API Referências: Email | Consultar

post /api/Email/Consultar?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Hash: varchar,
}

 json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          Ip: string,
          AcessoLiberado: text,
          Agendado: datetime,
          Alteracao: datetime,
          ArquivoAnexo: string,
          Assunto: string,
          Autonumeracao: int,
          AutonumeracaoEmpresa: int,
          Cadastro: datetime,
          Categoria: int,
          Clicado: datetime,
          Clicado: bit,
          Codigo: string,
          Destinatario: string,
          EmailDestinatario: string,
          EmailRemetente: string,
          Empresa: uniqueidentifier,
          Identificador: uniqueidentifier,
          Enviado: bit,
          Envio: datetime,
          Hash: uniqueidentifier,
          Html: bit,
          LoginCredencial: string,
          Mensagem: text,
          Notificavel: bit,
          ObservacoesAdicionais: text,
          Porta: string,
          Preparado: bit,
          Privado: bit,
          Referente: uniqueidentifier,
          Remetente: string,
          ServidorSmtp: string,
          SessaoCliente: string,
          UsuarioAlteracao: uniqueidentifier,
          UsuarioAlteracaoDescricao: string,
          UsuarioAlteracaoEmail: string,
          UsuarioCriacao: uniqueidentifier,
          UsuarioCriacaoDescricao: string,
          UsuarioCriacaoEmail: string,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Email | Excluir

post /api/Email/Excluir?token=[SEU-TOKEN-SECRETO]&Hash=[Hash]

Request

Querystring parameters names Type
token string required
Hash guid required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json null

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Email | Listar

post /api/Email/Listar?token=[SEU-TOKEN-SECRETO]

Request

Querystring parameters names Type
token string required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          Ip: string,
          AcessoLiberado: text,
          Agendado: datetime,
          Alteracao: datetime,
          Assunto: string,
          Autonumeracao: int,
          AutonumeracaoEmpresa: int,
          Cadastro: datetime,
          Categoria: int,
          Clicado: datetime,
          Clicado: bit,
          Codigo: string,
          EmailDestinatario: string,
          EmailRemetente: string,
          Empresa: uniqueidentifier,
          Identificador: uniqueidentifier,
          Enviado: bit,
          Envio: datetime,
          Hash: uniqueidentifier,
          Html: bit,
          LoginCredencial: string,
          Mensagem: text,
          Notificavel: bit,
          ObservacoesAdicionais: text,
          Porta: string,
          Preparado: bit,
          Privado: bit,
          Referente: uniqueidentifier,
          ServidorSmtp: string,
          SessaoCliente: string,
          UsuarioAlteracao: uniqueidentifier,
          UsuarioCriacao: uniqueidentifier,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Email | Salvar

post /api/Email/Salvar?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     AcessoLiberado: text,
     Agendado: datetime,
     ArquivoAnexo: varchar,
     Assunto: varchar,
     CamposAtualizados: nvarchar,
     Categoria: int,
     Clicado: datetime,
     Codigo: varchar,
     ConsultarPorCampo: varchar,
     Destinatario: varchar,
     EmailDestinatario: varchar,
     EmailRemetente: varchar,
     Empresa: varchar,
     Envio: datetime,
     Hash: varchar,
     HashAplicado: uniqueidentifier,
     Html: bit,
     Identificador: uniqueidentifier,
     Ip: varchar,
     LoginCredencial: varchar,
     Mensagem: text,
     Modo: varchar,
     Notificavel: bit,
     ObservacoesAdicionais: text,
     Porta: varchar,
     Preparado: bit,
     Privado: bit,
     Referente: uniqueidentifier,
     Remetente: varchar,
     RetornarDataSet: bit,
     ServidorSmtp: varchar,
     SessaoCliente: varchar,
     UsuarioAlteracao: uniqueidentifier,
     UsuarioCriacao: uniqueidentifier,
     ValorConsultaPorCampo: varchar,
}

 json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json Consultar: https://api.tempbox.com.br/referencias/email?key=Consultar

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Email | Agendar

post /api/Email/Agendar?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     CdCategoria: int,
     CdCodigo: varchar,
     DsAssunto: varchar,
     DsEmailDestinatario: varchar,
     DsMensagem: nvarchar,
     IdEmpresa: varchar,
     IdIdentificador: varchar,
     NmDestinatario: varchar,
}

 json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json null

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Email | AgendarGrupo

post /api/Email/AgendarGrupo?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     CdCodigo: varchar,
     DsAssunto: varchar,
     DsMensagem: nvarchar,
     IdEmpresa: varchar,
     IdGrupoUsuario: varchar,
     IdIdentificador: varchar,
}

 json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json null

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Email | AtualizarLoteNewsletter

post /api/Email/AtualizarLoteNewsletter?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     IdEmpresa: varchar,
     IdLoteNewsletter: varchar,
     RepetirEmails: bit,
     TipoNewsletter: int,
}

 json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json null

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Email | EliminarDuplicados

post /api/Email/EliminarDuplicados?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

Obs: EliminarDuplicados não possui parâmetros. Logo, o parâmetro json pode ser enviado sem valor.
json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json null

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Email | LimparLixo

post /api/Email/LimparLixo?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

Obs: LimparLixo não possui parâmetros. Logo, o parâmetro json pode ser enviado sem valor.
json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json null

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Email | ListarRelatorioPrincipal

post /api/Email/ListarRelatorioPrincipal?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Empresa: varchar,
     Usuario: varchar,
}

 json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          Assunto: string,
          Autonumeracao: int,
          AutonumeracaoEmpresa: int,
          Cadastro: datetime,
          Destinatario: string,
          Email: uniqueidentifier,
          EmailDestinatario: string,
          EmailRemetente: string,
          Enviado: string,
          EnviadoValor: bit,
          Envio: datetime,
          Hash: uniqueidentifier,
          Identificador: uniqueidentifier,
          IdentificadorValor: uniqueidentifier,
          Mensagem: text,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token