Documento de API

Considerações Gerais

Objetivo

Implementação da fachada de integração CRM x CTI.

Nos atributos das tabelas temporárias de entrada e saída:

ttCTIPhoneType					Entrada/Saída
Tabela de Erros					Entrada/Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
charID	Char		ID do tipo de telefone
charDesc	Char		Descrição do tipo de telefone

ttCTIAccounts					Entrada/Saída
					Entrada/Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
charName	Char		Razão social da conta
erpID	Char		Identificador da conta no ERP
crmID	Char		Identificador da conta no CRM

ttCTIUser					Entrada/Saída
					Entrada/Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
charJBOSS	Char		Endereço do WebService no JBoss
charWSDL	Char		Endereço do WebService do SmartCTI
charGroup	Char		Grupo de atendimento (URA)
charExtension	Char		Numero do ramal
charPass	Char		Senha do usuário da URA
charUser	Char		Login do usuário da URA

ttCTIAccountTelephones					Entrada/Saída
					Entrada/Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
charPhone	Char		Numero do telefone
charType	Char		Descrição do tipo de telefone

ttCTICallLog					Entrada/Saída
					Entrada/Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
charHour	Char		Horário da chamada
charDate	Char		Data da chamada
charPhone	Char		Numero do telefone da chamada
intAccount	Char		ID do CRM da conta
charAccount	Char		Razão Social da conta

Quando a API for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:

getCallLog
Requisito	Nenhum
Sintaxe
Descrição	Retorna o log de ligações não atendidas pelo usuário.
	Parâmetros	Descrição
	ttCTICallLog	Lista de chamadas
	RowErrors	Lista de erros
Retorno	ttCTICallLog / RowErrors

clearPortletLog
Requisito	Nenhum
Sintaxe
Descrição	Realiza a limpeza no log de chamadas do usuário caso o mesmo tenha permissão.
	Parâmetros	Descrição
	Out	Retorno de sucesso
	RowErrors	Lista de erros
Retorno	Out / RowErrors

lostCallLog
Requisito	Nenhum
Sintaxe
Descrição	Registra a chamada perdida ou não atendida pelo usuário.
	Parâmetros	Descrição
	crmID	ID da conta no CRM
	cPhone	Numero do telefone
	RowErrors	Lista de erros
Retorno	RowErrors

getAccounts
Requisito	Nenhum
Sintaxe
Descrição	Busca todas as contas que o usuário informado possuir acesso e que tenham o telefone igual ao parâmetro enviado.
	Parâmetros	Descrição
	cPhone	Numero do telefone
	ttCTIAccounts	Lista de contas
	RowErrors	Lista de erros
Retorno	ttCTIAccounts / RowErrors

getAccountPhones
Requisito	Nenhum
Sintaxe
Descrição	Busca todos os telefones associados a conta infromada.
	Parâmetros	Descrição
	crmID	ID da conta no CRM
	ttCTIAccountTelephones	Lista de telefones da conta
	RowErrors	Lista de erros
Retorno	ttCTIAccountTelephones / RowErrors

getCTIUser (deprecated)
Requisito	Nenhum
Sintaxe
Descrição	Retorna os dados do usuário do CTI.
	Parâmetros	Descrição
	ttCTIUser	Dados do usuário
	RowErrors	Lista de erros
Retorno	ttCTIUser / RowErrors

getParameters
Requisito	Nenhum
Sintaxe
Descrição	Retorna a lista dos parâmetros do CRM para utilização do CTI.
	Parâmetros	Descrição
	ttCTIParam	Lista de parametros
	RowErrors	Lista de erros
Retorno	ttCTIParam / RowErrors

userCallLog
Requisito	Nenhum
Sintaxe
Descrição	Registra o login e logout do usuário na URA.
	Parâmetros	Descrição
	cReason	Motivo do logout
	iType	Identificador de login / logout
	RowErrors	Lista de erros
Retorno	RowErrors

registerPhone
Requisito	Nenhum
Sintaxe
Descrição	Registra o telefone da chamada recebida a conta selecionada.
	Parâmetros	Descrição
	cPhone	Numero do telefone
	cType	Tipo de telefone
	cAccount	ID da conta no CRM
	RowErrors	Lista de erros
Retorno	RowErrors

getPhoneTypes
Requisito	Nenhum
Sintaxe
Descrição	Retorna os tipos de telefones cadastrados no CRM
	Parâmetros	Descrição
	ttCTIPhoneTypes	Lista dos tipos de telefone
	RowErrors	Lista de erros
Retorno	ttCTIPhoneTypes / RowErrors

getCurrentUser
Requisito	Nenhum
Sintaxe
Descrição	Retorna o código do usuário do CRM logado.
	Parâmetros	Descrição
	iUser	Identificador do usuário no CRM
Retorno	iUser

getNextIDLog
Requisito	Nenhum
Sintaxe
Descrição	Retorna a próxima sequencia para inserção na tabela crm_log_telef.
	Parâmetros	Descrição
	iSeq	Próximo id na sequencia da tabela crm_log_telef
Retorno	iSeq

getNextIDLogUtil
Requisito	Nenhum
Sintaxe
Descrição	Retorna a próxima sequencia para inserção na tabela crm_log_utiliza_telef.
	Parâmetros	Descrição
	iSeq	Próximo id na sequencia da tabela crm_log_utiliza_telef
Retorno	iSeq

getNextIDTel
Requisito	Nenhum
Sintaxe
Descrição	Retorna a próxima sequencia para inserção na tabela crm_telef.
	Parâmetros	Descrição
	iSeq	Próximo id na sequencia da tabela crm_telef
Retorno	iSeq