voltar

API Referências: Contato | AtualizarEmail

post /api/Contato/AtualizarEmail?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Contato: varchar,
     Email: varchar,
     Empresa: 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: Contato | AtualizarEmailPrincipal

post /api/Contato/AtualizarEmailPrincipal?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Contato: varchar,
     Email: varchar,
     Empresa: 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: Contato | AtualizarTelefone

post /api/Contato/AtualizarTelefone?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Contato: varchar,
     Empresa: varchar,
     Telefone: 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: Contato | AtualizarTelefonePrincipal

post /api/Contato/AtualizarTelefonePrincipal?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Contato: varchar,
     Empresa: varchar,
     Telefone: 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: Contato | AtualizarWhatsapp

post /api/Contato/AtualizarWhatsapp?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Contato: varchar,
     Empresa: varchar,
     Telefone: 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: Contato | AtualizarWhatsappPrincipal

post /api/Contato/AtualizarWhatsappPrincipal?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Contato: varchar,
     Empresa: varchar,
     Telefone: 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: Contato | CriarAtendimentoChat

post /api/Contato/CriarAtendimentoChat?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Email: varchar,
     Empresa: varchar,
     Telefone: varchar,
     Titulo: varchar,
     Whatsapp: 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: Contato | CriarOportunidade

post /api/Contato/CriarOportunidade?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Assunto: varchar,
     Bairro: varchar,
     Categoria: int,
     Cep: varchar,
     Cidade: varchar,
     Complemento: varchar,
     Concordado: varchar,
     DescricaoAdicional: nvarchar,
     Email: varchar,
     Empresa: varchar,
     Endereco: varchar,
     EstadoFederal: varchar,
     FormaContato: varchar,
     Mensagem: nvarchar,
     Notificavel: bit,
     Referente: varchar,
     Residencia: varchar,
     Telefone: varchar,
     Titulo: 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: Contato | EnviarMensagemContato

post /api/Contato/EnviarMensagemContato?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Assunto: varchar,
     Bairro: varchar,
     Cep: varchar,
     Cidade: varchar,
     CodigoReferencia: varchar,
     Complemento: varchar,
     Concordado: varchar,
     DescricaoAdicional: nvarchar,
     Email: varchar,
     Empresa: varchar,
     Endereco: varchar,
     EstadoFederal: varchar,
     Mensagem: nvarchar,
     Notificavel: bit,
     Referente: varchar,
     Residencia: varchar,
     Telefone: varchar,
     Titulo: varchar,
     Whatsapp: 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: Contato | ListarHashesPorEmail

post /api/Contato/ListarHashesPorEmail?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Email: varchar,
     Empresa: varchar,
}

 json required

Response


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

array json
{
     [
          Hash: 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: Contato | ListarHashesPorTelefone

post /api/Contato/ListarHashesPorTelefone?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Empresa: varchar,
     Telefone: varchar,
}

 json required

Response


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

array json
{
     [
          Hash: 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: Contato | ListarRelatorioPrincipal

post /api/Contato/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,
          AutonumeracaoEmpresa: int,
          Cadastro: string,
          CadastroValor: datetime,
          Contato: uniqueidentifier,
          Email: string,
          FormaContato: string,
          Hash: uniqueidentifier,
          Marcadores: string,
          MarcadoresHash: string,
          Referente: string,
          ReferenteSubDescricao: string,
          ReferenteValor: uniqueidentifier,
          Telefone: string,
          Titulo: string,
          UrlPaginaForm: string,
          UsuarioResponsavel: string,
          UsuarioResponsavelImagem: string,
          UsuarioResponsavelValor: 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: Contato | ProcessarLeadInbound

post /api/Contato/ProcessarLeadInbound?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Atendimento: varchar,
     CodigoReferenciaCanal: varchar,
     Contato: varchar,
     DetalhesOportunidade: nvarchar,
     Email: varchar,
     Empresa: varchar,
     FacebookMessengerAccountId: varchar,
     InstagramUsername: varchar,
     Mensagem: nvarchar,
     Oportunidade: varchar,
     Plataforma: int,
     Telefone: varchar,
     Titulo: varchar,
     Whatsapp: 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: Contato | ProcessarLeadInboundStepEnvioMensagem

post /api/Contato/ProcessarLeadInboundStepEnvioMensagem?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Atendimento: varchar,
     CodigoReferenciaCanal: varchar,
     Contato: varchar,
     Empresa: varchar,
     Mensagem: nvarchar,
     Plataforma: 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: Contato | ProcessarLeadInboundStepGerarOportunidade

post /api/Contato/ProcessarLeadInboundStepGerarOportunidade?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Atendimento: varchar,
     Contato: varchar,
     DetalhesOportunidade: nvarchar,
     Empresa: varchar,
     FunilVendaEtapa: varchar,
     GerarOportunidade: bit,
     Plataforma: int,
     Titulo: 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: Contato | SincronizarContatoExistente

post /api/Contato/SincronizarContatoExistente?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Email: varchar,
     Empresa: varchar,
     FacebookMessengerAccountId: varchar,
     IdContato: varchar,
     InstagramUsername: varchar,
     Telefone: varchar,
     Titulo: varchar,
     Whatsapp: 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: Contato | Consultar

post /api/Contato/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
{
     [
          AceitaNewsletter: bit,
          AcessoLiberado: text,
          Alteracao: datetime,
          ArquivoAnexo: string,
          ArquivoAnexo2: string,
          Assunto: string,
          Atendido: bit,
          Autonumeracao: int,
          AutonumeracaoEmpresa: int,
          Bairro: string,
          Cadastro: datetime,
          Categoria: int,
          Cep: string,
          Cidade: string,
          CodigoOrigemIntegracao: string,
          Complemento: string,
          Concordado: bit,
          ContatoMatriz: bit,
          ContatoUnificado: uniqueidentifier,
          DataUltimaInteracao: datetime,
          DescricaoAdicional: string,
          Email: string,
          Email10: string,
          Email2: string,
          Email3: string,
          Email4: string,
          Email5: string,
          Email6: string,
          Email7: string,
          Email8: string,
          Email9: string,
          Empresa: uniqueidentifier,
          Endereco: string,
          EstadoFederal: uniqueidentifier,
          FacebookMessengerAccountId: string,
          FacebookMessengerProfilePic: string,
          FormaContato: string,
          Hash: uniqueidentifier,
          InstagramAccountId: string,
          InstagramUsername: string,
          Mensagem: text,
          NomeEmpresa: string,
          Notificavel: bit,
          ObservacoesAdicionais: text,
          OportunidadeCopiada: uniqueidentifier,
          Privado: bit,
          RamoAtuacao: string,
          Referente: uniqueidentifier,
          ReferenteDescricao: string,
          Residencia: string,
          Telefone: string,
          Telefone10: string,
          Telefone10Normalizado: string,
          Telefone2: string,
          Telefone2Normalizado: string,
          Telefone3: string,
          Telefone3Normalizado: string,
          Telefone4: string,
          Telefone4Normalizado: string,
          Telefone5: string,
          Telefone5Normalizado: string,
          Telefone6: string,
          Telefone6Normalizado: string,
          Telefone7: string,
          Telefone7Normalizado: string,
          Telefone8: string,
          Telefone8Normalizado: string,
          Telefone9: string,
          Telefone9Normalizado: string,
          TelefoneNormalizado: string,
          TelefoneWhatsapp: string,
          TelefoneWhatsappNormalizado: string,
          Titulo: string,
          UsuarioAlteracao: uniqueidentifier,
          UsuarioAlteracaoDescricao: string,
          UsuarioAlteracaoEmail: string,
          UsuarioCriacao: uniqueidentifier,
          UsuarioCriacaoDescricao: string,
          UsuarioCriacaoEmail: string,
          UsuarioResponsavel: 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: Contato | Excluir

post /api/Contato/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: Contato | Listar

post /api/Contato/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
{
     [
          AceitaNewsletter: bit,
          AcessoLiberado: text,
          Alteracao: datetime,
          Assunto: string,
          Atendido: bit,
          Autonumeracao: int,
          AutonumeracaoEmpresa: int,
          Cadastro: datetime,
          Categoria: int,
          Cep: string,
          CodigoOrigemIntegracao: string,
          Complemento: string,
          Concordado: bit,
          ContatoMatriz: bit,
          ContatoUnificado: uniqueidentifier,
          DescricaoAdicional: string,
          Email: string,
          Empresa: uniqueidentifier,
          Endereco: string,
          EstadoFederal: uniqueidentifier,
          FormaContato: string,
          Hash: uniqueidentifier,
          Mensagem: text,
          Notificavel: bit,
          ObservacoesAdicionais: text,
          OportunidadeCopiada: uniqueidentifier,
          Privado: bit,
          Referente: uniqueidentifier,
          Residencia: string,
          Telefone: string,
          TelefoneWhatsapp: string,
          Titulo: string,
          UsuarioAlteracao: uniqueidentifier,
          UsuarioCriacao: uniqueidentifier,
          UsuarioResponsavel: 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: Contato | Salvar

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

Request

Querystring parameters names Type
token string required
json

{
     AceitaNewsletter: bit,
     AcessoLiberado: text,
     ArquivoAnexo: varchar,
     ArquivoAnexo2: varchar,
     Assunto: varchar,
     Atendido: bit,
     Bairro: varchar,
     CamposAtualizados: nvarchar,
     Categoria: int,
     Cep: varchar,
     Cidade: varchar,
     Complemento: varchar,
     Concordado: bit,
     ConsultarPorCampo: varchar,
     ContatoMatriz: bit,
     ContatoUnificado: uniqueidentifier,
     DescricaoAdicional: varchar,
     Email: varchar,
     Email10: varchar,
     Email2: varchar,
     Email3: varchar,
     Email4: varchar,
     Email5: varchar,
     Email6: varchar,
     Email7: varchar,
     Email8: varchar,
     Email9: varchar,
     Empresa: varchar,
     Endereco: varchar,
     EstadoFederal: uniqueidentifier,
     FormaContato: varchar,
     Hash: varchar,
     HashAplicado: uniqueidentifier,
     InstagramUsername: varchar,
     Mensagem: text,
     Modo: varchar,
     NomeEmpresa: varchar,
     Notificavel: bit,
     ObservacoesAdicionais: text,
     OportunidadeCopiada: uniqueidentifier,
     Privado: bit,
     RamoAtuacao: varchar,
     Referente: uniqueidentifier,
     Residencia: varchar,
     RetornarDataSet: bit,
     Telefone: varchar,
     Telefone10: varchar,
     Telefone2: varchar,
     Telefone3: varchar,
     Telefone4: varchar,
     Telefone5: varchar,
     Telefone6: varchar,
     Telefone7: varchar,
     Telefone8: varchar,
     Telefone9: varchar,
     TelefoneWhatsapp: varchar,
     Titulo: varchar,
     UsuarioAlteracao: uniqueidentifier,
     UsuarioCriacao: uniqueidentifier,
     UsuarioResponsavel: 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/contato?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