Tutichat API Endpoints

[mseltahir]

• http://<domain>/chatapi/v1/connect

  • Response: the response from this endpoint will return a websocket connection that the client and server can use to exchange messages.
  • Request:
    1. clientID.
  • This endpoint is going to be hit when the user does one of the following actions (we need to decide which one it will be):
    1. Connect to the internet (like other chat applications, when you connect to the internet you automatically are connected the the servers and all your unread messages will be sent to you).
    2. Open the Tutipay app.
    3. Open the chat tab in the Tutipay app.

• http://<domain>/chatapi/v1/getMessages

  • Response: the response from this endpoint will return all the messages that were sent to this client when he was not connected (unread messages).
  • Request:
    1. ClientID.
    2. Websocket connection.

• Sending/receiving messages does not need an endpoint, since it's done through the websocket connection that is established when the client hits the connect endpoint.

[mseltahir]

@adonese what do you think?