wiki:WebServiceDraft

Version 10 (modified by niltonneto, 12 years ago) (diff)

--

Expresso Web Service

Este Draft é destinado à especificação dos requisitos referentes à implementação do Web Service do Expresso. Todas as informações contidas neste documento poderão sofrer alterações sem aviso prévio, até o fechamento do escopo deste subprojeto do Expresso.


1. Objetivo


2. Compatibilidade

API: Versões > 2.2

ExpressoMail?: Versões > 2.2

ContactCenter?: Versões > 2.2


3. Arquitetura


4. Protocolo de Comunicação

JSON-RPC versão 1.0


5. Recursos disponíveis

I. Criar sessão autenticada no Expresso

Parâmetros:

  • params:
  • method: Expresso.login
  • format: json-rpc
  • id: 1

Resposta:

  • result
  • error
  • id: 1

II) Finalizar sessão autenticada no Expresso

Parâmetros:

  • params:
  • method: Expresso.logout
  • format: json-rpc
  • id: 2

Resposta:

  • result
  • error
  • id: 2

III) Listar pastas de Email

Parâmetros:

  • params:
  • method: Mail.getUserFolders
  • format: json-rpc
  • id: 3

Resposta:

  • result
  • error
  • id: 3

IV) Listar mensagens de uma pasta de Email

Parâmetros:

  • params:
  • method: Mail.getUserMessages
  • format: json-rpc
  • id: 4

Resposta:

  • result
  • error
  • id: 4