A mensagem CrossTalk contém 2 elementos: o cabeçalho (CrossTalk_Header) e o corpo da mensagem (CrossTalk_Body). No cabeçalho são especificados valores que identificam a mensagem (ProcessCode, MessageType, ExchangePattern, Enterprise Id) e valores de controle (DateTime, GUID, Token). No corpo pode ser especificada uma mensagem, parâmetros complementares de uma mensagem de solicitação, valores de status, etc. O corpo pode ainda estar ausente ou vazio. Esta situação ocorrerá nas mensagens onde será solicitado o resultado de um processamento.
No webservice ExchangeMessage estes dois elementos são representados por dois campos: message (header) e rawdata (body).
Abaixo segue a descrição dos campos de um cabeçalho (header ou message) CrossTalk:
Campo |
Descrição |
Opc |
Informações adicionais |
ProcessCode |
Código numérico determinando qual é o processo ao qual a mensagem pertence. |
N |
Tipos possíveis: 1004 = Gerar GUID 2009 = Envio de Operação de Pagamento 2010 = Consulta de saldo de cartão frota 2011 = Consulta de Operação de Pagamento 2012 = Cancelamento de Operação de Pagamento 2018 = Download de Operação 2027 = Consulta Roteirizador 2030 = Pagamento de OP |
MessageType |
Código numérico determinando qual é o tipo de operação que se espera realizar com a mensagem. |
N |
Tipos possíveis: 100: Insert |
ExchangePattern |
Determina o padrão de comunicação que será usado. |
S |
Tipos possíveis: 1: A mensagem é uma requisição. O cliente inicia uma mensagem de requisição a qual o provedor responde com uma mensagem de resposta (Response), ou uma exceção. A resposta pode conter um status (RespCode), que deve ser avaliado para determinar se a troca de mensagem ocorreu como esperado. Se a resposta for uma exceção, então a troca de mensagem falhou e uma nova tentativa pode ser realizada posteriormente 7: A mensagem é uma requisição que será processada de forma assíncrona, onde a resposta será buscada posteriormente. Neste modelo ocorre uma resposta síncrona informando que a mensagem foi aceita para processamento. 8: A mensagem é uma resposta assíncrona. Deve ser usado para os casos de busca do resultado de um processamento |
ResponseCode |
Código de resposta do processamento, presente apenas nas mensagens de resposta. |
S |
Tipos possíveis: 0: Default ou indeterminado 200: Processamento realizado com sucesso 202: A mensagem foi aceita e será processada. 400: A mensagem não foi entendida pelo servidor e deve ser modificada antes de ser enviada novamente. 500: Ocorreu uma exceção durante o processamento da requisição. Erro de processamento da solicitação do negócio |
ResponseCodeMessage |
Um texto complementar ao Response Code, |
S |
Exemplo: "A mensagem foi aceita e será processada.” |
GUID |
Um Global Unique Identifier para que o consumidor possa controlar suas transações. Este mesmo GUID estará presente na mensagem de resposta e deverá ser usado para solicitar o resultado de um processamento |
S |
|
EnterpriseID |
CNPJ da Contratante que está enviando a mensagem. |
N |
|
ContentType |
Especificação do tipo de dado que a mensagem está formatada. |
S |
Deve ser sempre “text/xml”. |
ContentEncoding |
Especificação do encoding em que a mensagem está formatada. |
S |
Deve ser sempre “utf-8”. |
