voltar

API Referências: Atendimento | Acompanhar

post /api/Atendimento/Acompanhar?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

Obs: Acompanhar 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
{
     [
          Alteracao: datetime,
          AlteracaoNome: datetime,
          Autonumeracao: int,
          Cadastro: datetime,
          CadastroNome: datetime,
          Categoria: int,
          CategoriaTitulo: string,
          CodigoStatus: int,
          Empresa: uniqueidentifier,
          EmpresaTitulo: string,
          LogOcorrencia: uniqueidentifier,
          MensagemLog: string,
          Nome: string,
          Referente: uniqueidentifier,
          Sequencial: int,
          Tabela: 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: Atendimento | AgendarMensagem

post /api/Atendimento/AgendarMensagem?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Atendente: varchar,
     Atendimento: varchar,
     DataAgendamento: smalldatetime,
     Empresa: varchar,
     Mensagem: nvarchar,
}

 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: Atendimento | ColetarDadosIa

post /api/Atendimento/ColetarDadosIa?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

Obs: ColetarDadosIa 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: Atendimento | CriarPorContato

post /api/Atendimento/CriarPorContato?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Atendente: varchar,
     Atendimento: varchar,
     CodigoReferenciaCanal: varchar,
     Contato: varchar,
     Empresa: varchar,
     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: Atendimento | EncaminharAtendimento

post /api/Atendimento/EncaminharAtendimento?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Atendente: varchar,
     Atendimento: varchar,
     Empresa: varchar,
}

 json required

Response


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

array json
{
     [
          Atendente: uniqueidentifier,
          Atendimento: uniqueidentifier,
          Empresa: uniqueidentifier,
          Hash: uniqueidentifier,
          Iniciado: bit,
          ReferenteResponsavel: uniqueidentifier,
          Titulo: 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: Atendimento | EncerrarAtendimento

post /api/Atendimento/EncerrarAtendimento?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Atendimento: 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: Atendimento | EnviarMensagem

post /api/Atendimento/EnviarMensagem?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Atendente: varchar,
     Atendimento: varchar,
     AtendimentoFluxoMensagem: 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: Atendimento | IniciarAtendimento

post /api/Atendimento/IniciarAtendimento?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Atendente: varchar,
     Atendimento: varchar,
     Empresa: varchar,
}

 json required

Response


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

array json
{
     [
          Atendente: uniqueidentifier,
          Atendimento: uniqueidentifier,
          Empresa: uniqueidentifier,
          Hash: uniqueidentifier,
          Iniciado: bit,
          ReferenteResponsavel: 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: Atendimento | ListarDiasHorariosAtendentesAgendaDisponivel

post /api/Atendimento/ListarDiasHorariosAtendentesAgendaDisponivel?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     AtendenteRelacionado: varchar,
     Empresa: varchar,
}

 json required

Response


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

array json
{
     [
          Data: datetime,
          Usuario: 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: Atendimento | ListarEmAberto

post /api/Atendimento/ListarEmAberto?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Empresa: varchar,
}

 json required

Response


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

array json
{
     [
          AtendenteHash: uniqueidentifier,
          AtendenteImagem: string,
          AtendentePrimeiroNome: string,
          AtendenteTitulo: string,
          Atendimento: uniqueidentifier,
          AtendimentoMensagem: uniqueidentifier,
          Autonumeracao: int,
          AutonumeracaoEmpresa: int,
          Cadastro: string,
          ChatInterno: bit,
          Cidade: string,
          Cliente: uniqueidentifier,
          DiaMesHora: string,
          Empresa: uniqueidentifier,
          EquipesAtendentes: string,
          Hash: uniqueidentifier,
          Horario: string,
          Imagem: string,
          Iniciado: bit,
          InicioAtendimento: string,
          Mensagem: string,
          Momento: string,
          NaoLidas: int,
          Plataforma: int,
          PlataformaFormaContato: int,
          PlataformaFormaContatoTitulo: string,
          PlataformaTitulo: string,
          QtdAtendimentos: int,
          ReferenteCanal: string,
          ReferenteCanalFormaContato: string,
          ReferenteSolicitante: uniqueidentifier,
          ReferenteSolicitanteHash: uniqueidentifier,
          SolicitanteCor: string,
          SolicitanteEmail: string,
          SolicitanteEmpresa: string,
          SolicitanteIniciais: string,
          SolicitanteLocalizacao: string,
          SolicitanteTelefone: string,
          SolicitanteTitulo: string,
          SolicitanteWhatsapp: string,
          TagCliente: string,
          TagNovo: bit,
     ]
}

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: Atendimento | ListarHashesOutrosAtendentesEquipesAtendente

post /api/Atendimento/ListarHashesOutrosAtendentesEquipesAtendente?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Atendente: 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: Atendimento | ListarHashesOutrosHumanosEquipesAtendente

post /api/Atendimento/ListarHashesOutrosHumanosEquipesAtendente?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Atendente: 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: Atendimento | ListarMensagensAtendimento

post /api/Atendimento/ListarMensagensAtendimento?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Atendimento: varchar,
     Empresa: varchar,
}

 json required

Response


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

array json
{
     [
          AtendenteHash: uniqueidentifier,
          AtendenteImagem: string,
          AtendenteMensagemTipoAtendenteTitulo: string,
          AtendentePrimeiroNome: string,
          AtendenteTitulo: string,
          Atendimento: uniqueidentifier,
          AtendimentoHash: uniqueidentifier,
          AtendimentoMensagem: uniqueidentifier,
          Autonumeracao: int,
          AutorMensagem: string,
          Cadastro: datetime,
          Empresa: uniqueidentifier,
          Hash: uniqueidentifier,
          Horario: string,
          HorarioSegundos: string,
          Imagem: int,
          Mensagem: string,
          MensagemAtendente: int,
          Momento: string,
          SolicitanteCor: string,
          SolicitanteIniciais: string,
          SolicitanteTitulo: 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: Atendimento | ListarMensagensAtendimentoChat

post /api/Atendimento/ListarMensagensAtendimentoChat?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Atendimento: varchar,
     Empresa: varchar,
}

 json required

Response


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

array json
{
     [
          AtendenteHash: uniqueidentifier,
          AtendenteImagem: string,
          AtendentePrimeiroNome: string,
          AtendenteTitulo: string,
          Atendimento: uniqueidentifier,
          AtendimentoHash: uniqueidentifier,
          AtendimentoMensagem: uniqueidentifier,
          Autonumeracao: int,
          AutorMensagem: string,
          Cadastro: datetime,
          Empresa: uniqueidentifier,
          Hash: uniqueidentifier,
          Horario: string,
          Imagem: int,
          Mensagem: string,
          MensagemAtendente: int,
          Momento: string,
          SolicitanteCor: string,
          SolicitanteIniciais: string,
          SolicitanteTitulo: 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: Atendimento | ListarMensagensEmAberto

post /api/Atendimento/ListarMensagensEmAberto?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Empresa: varchar,
     Inicio: int,
     Termino: int,
}

 json required

Response


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

array json
{
     [
          ArquivoAnexo: string,
          AtendenteHash: uniqueidentifier,
          AtendenteImagem: string,
          AtendenteMensagemTipoAtendenteTitulo: string,
          AtendenteOriginalTitulo: string,
          AtendentePrimeiroNome: string,
          AtendenteResponsavel: uniqueidentifier,
          AtendenteResponsavelImagem: string,
          AtendenteResponsavelPrimeiroNome: string,
          AtendenteResponsavelTitulo: string,
          AtendenteTitulo: string,
          Atendimento: uniqueidentifier,
          AtendimentoHash: uniqueidentifier,
          AtendimentoMensagem: uniqueidentifier,
          AtendimentoOriginalHash: uniqueidentifier,
          Autonumeracao: int,
          Autonumeracao: int,
          AutorMensagem: string,
          Cadastro: datetime,
          Empresa: uniqueidentifier,
          Extensao: string,
          Hash: uniqueidentifier,
          Horario: string,
          HorarioSegundos: string,
          Imagem: int,
          InicioAtendimentoOriginal: smalldatetime,
          Mensagem: string,
          MensagemAtendente: bit,
          Momento: string,
          SolicitanteCor: string,
          SolicitanteIniciais: string,
          SolicitanteTitulo: string,
          TerminoAtendimentoOriginal: smalldatetime,
          UrlAnexo: 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: Atendimento | ListarMensagensPadrao

post /api/Atendimento/ListarMensagensPadrao?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Empresa: varchar,
}

 json required

Response


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

array json
{
     [
          AtendimentoMensagemPadrao: uniqueidentifier,
          Hash: uniqueidentifier,
          Plataforma: int,
          Titulo: string,
          TituloAbreviado: bigint,
     ]
}

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: Atendimento | ListarMeusAtendimentos

post /api/Atendimento/ListarMeusAtendimentos?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Contato: varchar,
     Empresa: varchar,
}

 json required

Response


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

array json
{
     [
          AtendenteHash: uniqueidentifier,
          AtendenteImagem: string,
          AtendentePrimeiroNome: string,
          AtendenteTitulo: string,
          Atendimento: uniqueidentifier,
          AtendimentoMensagem: uniqueidentifier,
          Autonumeracao: int,
          AutonumeracaoEmpresa: int,
          Cadastro: string,
          ChatInterno: bit,
          Cidade: string,
          Cliente: uniqueidentifier,
          Concluido: bit,
          Empresa: uniqueidentifier,
          EquipesAtendentes: string,
          Hash: uniqueidentifier,
          Horario: string,
          Imagem: string,
          Iniciado: bit,
          InicioAtendimento: string,
          Mensagem: string,
          Momento: string,
          NaoLidas: int,
          Plataforma: int,
          PlataformaFormaContato: int,
          PlataformaFormaContatoTitulo: string,
          PlataformaTitulo: string,
          QtdAtendimentos: int,
          ReferenteCanal: string,
          ReferenteCanalFormaContato: string,
          ReferenteSolicitante: uniqueidentifier,
          ReferenteSolicitanteHash: uniqueidentifier,
          SolicitanteCor: string,
          SolicitanteEmail: string,
          SolicitanteEmpresa: string,
          SolicitanteIniciais: string,
          SolicitanteLocalizacao: string,
          SolicitanteTelefone: string,
          SolicitanteTitulo: string,
          SolicitanteWhatsapp: string,
          TagCliente: string,
          TagNovo: bit,
     ]
}

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: Atendimento | ListarRecentes

post /api/Atendimento/ListarRecentes?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     top: int,
}

 json required

Response


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

array json
{
     [
          Alteracao: datetime,
          Atendente: uniqueidentifier,
          AtendenteTitulo: string,
          Atendimento: uniqueidentifier,
          Autonumeracao: int,
          Cadastro: smalldatetime,
          Concluido: bit,
          ContatoTitulo: string,
          DataUltimaInteracaoAtendente: datetime,
          DataUltimaInteracaoSolicitante: datetime,
          Email: string,
          Empresa: uniqueidentifier,
          EmpresaTitulo: string,
          Iniciado: bit,
          InicioAtendimento: smalldatetime,
          Plataforma: int,
          PlataformaFormaContato: int,
          ReferenteCanal: uniqueidentifier,
          ReferenteCanalFormaContato: uniqueidentifier,
          ReferenteSolicitante: uniqueidentifier,
          SolicitanteEmEspera: bit,
          TelefoneWhatsapp: string,
          TerminoAtendimento: smalldatetime,
     ]
}

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: Atendimento | ListarRelatorioPrincipal

post /api/Atendimento/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
{
     [
          Atendente: string,
          AtendenteHash: uniqueidentifier,
          Atendimento: uniqueidentifier,
          AtendimentoCodigo: string,
          Autonumeracao: int,
          AutonumeracaoEmpresa: int,
          Cadastro: string,
          CadastroValor: smalldatetime,
          Concluido: string,
          ConcluidoValor: bit,
          Hash: uniqueidentifier,
          Iniciado: string,
          IniciadoValor: bit,
          InicioAtendimento: string,
          InicioAtendimentoValor: smalldatetime,
          Marcadores: string,
          MarcadoresHash: string,
          Plataforma: string,
          PlataformaConteudo: string,
          PlataformaImagem: int,
          PlataformaLabel: int,
          ReferenteResponsavel: string,
          ReferenteResponsavelDescricao: string,
          ReferenteResponsavelHash: uniqueidentifier,
          ReferenteResponsavelTipo: string,
          ReferenteSolicitante: string,
          ReferenteSolicitanteEmail: string,
          ReferenteSolicitanteHash: uniqueidentifier,
          TerminoAtendimento: string,
          TerminoAtendimentoValor: smalldatetime,
          Titulo: 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: Atendimento | ListarUltimasMensagens

post /api/Atendimento/ListarUltimasMensagens?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Empresa: varchar,
}

 json required

Response


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

array json
{
     [
          ArquivoAnexo: string,
          AtendenteHash: uniqueidentifier,
          AtendenteImagem: string,
          AtendenteMensagemTipoAtendenteTitulo: string,
          AtendenteOriginalTitulo: string,
          AtendentePrimeiroNome: string,
          AtendenteResponsavel: uniqueidentifier,
          AtendenteResponsavelImagem: string,
          AtendenteResponsavelPrimeiroNome: string,
          AtendenteResponsavelTitulo: string,
          AtendenteTitulo: string,
          Atendimento: uniqueidentifier,
          AtendimentoHash: uniqueidentifier,
          AtendimentoMensagem: uniqueidentifier,
          AtendimentoOriginalHash: uniqueidentifier,
          Autonumeracao: int,
          AutonumeracaoEmpresa: int,
          AutorMensagem: string,
          Cadastro: datetime,
          Empresa: uniqueidentifier,
          Extensao: string,
          Hash: uniqueidentifier,
          Horario: string,
          HorarioSegundos: string,
          Imagem: int,
          InicioAtendimentoOriginal: smalldatetime,
          Mensagem: string,
          MensagemAtendente: bit,
          MensagemReticencias: string,
          Momento: string,
          PlataformaConteudo: string,
          PlataformaTitulo: string,
          SolicitanteCor: string,
          SolicitanteEmEspera: bit,
          SolicitanteIniciais: string,
          SolicitanteTitulo: string,
          TerminoAtendimentoOriginal: smalldatetime,
          UrlAnexo: 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: Atendimento | ObterDashboard

post /api/Atendimento/ObterDashboard?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Empresa: varchar,
}

 json required

Response


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

array json
{
     [
          Propriedade: string,
          Valor: 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: Atendimento | ObterNovasMensagensChatSiteSse

post /api/Atendimento/ObterNovasMensagensChatSiteSse?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Inicio: int,
     Termino: int,
}

 json required

Response


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

array json
{
     [
          AtendenteHash: uniqueidentifier,
          AtendenteImagem: string,
          AtendentePrimeiroNome: string,
          AtendenteTitulo: string,
          Atendimento: uniqueidentifier,
          AtendimentoHash: uniqueidentifier,
          AtendimentoMensagem: uniqueidentifier,
          Autonumeracao: int,
          AutorMensagem: string,
          Cadastro: datetime,
          Empresa: uniqueidentifier,
          Hash: uniqueidentifier,
          Horario: string,
          Imagem: int,
          Mensagem: string,
          MensagemAtendente: int,
          Momento: string,
          SolicitanteCor: string,
          SolicitanteIniciais: string,
          SolicitanteTitulo: string,
          TipoAtendente: int,
     ]
}

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: Atendimento | PegarAtendimento

post /api/Atendimento/PegarAtendimento?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Atendente: varchar,
     Atendimento: varchar,
     Empresa: varchar,
}

 json required

Response


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

array json
{
     [
          Atendente: uniqueidentifier,
          Atendimento: uniqueidentifier,
          Concluido: bit,
          Empresa: uniqueidentifier,
          Hash: uniqueidentifier,
          Iniciado: bit,
          ReferenteResponsavel: 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: Atendimento | ProcessarOcorrenciaRespostaInicialBotIa

post /api/Atendimento/ProcessarOcorrenciaRespostaInicialBotIa?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

Obs: ProcessarOcorrenciaRespostaInicialBotIa 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: Atendimento | ProcessarOcorrenciaSemAtendente

post /api/Atendimento/ProcessarOcorrenciaSemAtendente?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

Obs: ProcessarOcorrenciaSemAtendente 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: Atendimento | ResponderMensagemBot

post /api/Atendimento/ResponderMensagemBot?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     AtendimentoMensagem: 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: Atendimento | ResponderMensagemIa

post /api/Atendimento/ResponderMensagemIa?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Atendimento: 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: Atendimento | RespostaAutomaticaPronta

post /api/Atendimento/RespostaAutomaticaPronta?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

Obs: RespostaAutomaticaPronta 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: Atendimento | Consultar

post /api/Atendimento/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
{
     [
          AcessoLiberado: text,
          Alteracao: datetime,
          Atendente: uniqueidentifier,
          AtendenteDescricao: string,
          Autonumeracao: int,
          AutonumeracaoEmpresa: int,
          Cadastro: smalldatetime,
          Categoria: int,
          Concluido: bit,
          DataUltimaInteracaoAtendente: datetime,
          DataUltimaInteracaoSolicitante: datetime,
          DefinirObrigatoriamenteAtendenteHumano: bit,
          Empresa: uniqueidentifier,
          Hash: uniqueidentifier,
          Iniciado: bit,
          InicioAtendimento: smalldatetime,
          Notificavel: bit,
          ObservacoesAdicionais: text,
          Plataforma: int,
          PlataformaFormaContato: int,
          Privado: bit,
          ReferenteCanal: uniqueidentifier,
          ReferenteCanalFormaContato: uniqueidentifier,
          ReferenteResponsavel: uniqueidentifier,
          ReferenteResponsavelDescricao: string,
          ReferenteSolicitante: uniqueidentifier,
          ReferenteSolicitanteDescricao: string,
          SolicitanteEmEspera: bit,
          TerminoAtendimento: smalldatetime,
          Titulo: string,
          UsuarioAlteracao: uniqueidentifier,
          UsuarioAlteracaoDescricao: string,
          UsuarioAlteracaoEmail: string,
          UsuarioCriacao: uniqueidentifier,
          UsuarioCriacaoDescricao: string,
          UsuarioCriacaoEmail: string,
          VirtualHtmlConversa: 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: Atendimento | Excluir

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

post /api/Atendimento/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
{
     [
          AcessoLiberado: text,
          Alteracao: datetime,
          Atendente: uniqueidentifier,
          Autonumeracao: int,
          AutonumeracaoEmpresa: int,
          Cadastro: smalldatetime,
          Categoria: int,
          Concluido: bit,
          Empresa: uniqueidentifier,
          Hash: uniqueidentifier,
          Iniciado: bit,
          InicioAtendimento: smalldatetime,
          Notificavel: bit,
          ObservacoesAdicionais: text,
          Plataforma: int,
          PlataformaFormaContato: int,
          Privado: bit,
          ReferenteResponsavel: uniqueidentifier,
          ReferenteSolicitante: uniqueidentifier,
          SolicitanteEmEspera: bit,
          TerminoAtendimento: smalldatetime,
          Titulo: 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: Atendimento | Salvar

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

Request

Querystring parameters names Type
token string required
json

{
     AcessoLiberado: text,
     Atendente: uniqueidentifier,
     CamposAtualizados: nvarchar,
     Categoria: int,
     Concluido: bit,
     ConsultarPorCampo: varchar,
     Empresa: varchar,
     Hash: varchar,
     HashAplicado: uniqueidentifier,
     Iniciado: bit,
     InicioAtendimento: smalldatetime,
     Modo: varchar,
     Notificavel: bit,
     ObservacoesAdicionais: text,
     Plataforma: int,
     Privado: bit,
     ReferenteResponsavel: uniqueidentifier,
     ReferenteSolicitante: uniqueidentifier,
     RetornarDataSet: bit,
     TerminoAtendimento: smalldatetime,
     Titulo: varchar,
     UsuarioAlteracao: uniqueidentifier,
     UsuarioCriacao: uniqueidentifier,
     ValorConsultaPorCampo: varchar,
     VirtualHtmlConversa: nvarchar,
}

 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/atendimento?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