Messaging API Application Documentation

An Application is an entity in Quicktext who represents the user of this API.

To use this API you need to create an application in Quicktext which identifies you and gives you the required security Tokens.

In order to create an application you need the following informations:

  • Name of your application
  • Logo of the application ( Optional )
  • Type of the application ( Member or Client )
  • List of teams to subscribe to ( if your application's type is Member )
  • URL of the Webhook endpoint ( Optional ): If you are using this API from a Web Server, create a webhook endpoint ready to accept requests from Quicktext in order to receive events ( like Messages, Status, ... ), else you can use the Socket API for browser and mobile usage.

Authentication

Managing applications requires an authenticated user in Quicktext, the following endpoint allows you to login and get a Backend user token.

Login

Expected request

POST /api/member/login?returnUserData=true&returnUserTeams=true

The returnUserData and returnUserTeams query params are optional

{
  "email": "user@quicktext.im",
  "password": "********",
  "deviceRegistrationData": { // optional, register the firebase token if login is sucessful
    "registrationToken": "fmerbNju**********uKWPPRil",
    "deviceId": "dmerbNj**********Z5nhd6Q4"
  }
}

Response

{
  "token": "eyJ0eXAiOi**********5YlTnsoKno",
  "user": { // this will be returned *only if* `returnUserData` query param set to `true`
    "id": 123,
    "name": "Full Name",
    "email": "user@example.com",
    "phoneNumber": "+0123456789",
    "picture": "https://example.com/path/to/my/application/picture.png"
  },
  "userTeams": [ // this will be returned *only if* `returnUserTeams` query param set to `true`
    {
      "role": "manager",
      "teamId": 123,
      "name": "Team Name",
      "picture": "https://example.com/path/to/my/application/picture.png"
    }
  ]
}

Member endpoints

CRUD

Teams Subscriptions

Using the fllowing endpoints you can anytime subscribe/unsubscribe an application to/from any team you manage

Applications managers

Using the fllowing endpoints you can anytime assign/revoke other users to member applications which your role is admin for them

Reset Token

Get new valid token

Client endpoints

CRUD

Applications managers

Using the fllowing endpoints you can anytime assign/revoke other users to client applications which your role is admin for them

Reset Token

Get new valid token