Dotsignal Chat API

API Endpoint

https://chat.dotsignal.com:3001/api

 

Methods

Authenticate


Call this method first to authenticate with the web service.

 

Method URL: https://chat.dotsignal.com:3001/api/authenticate
Method Type: POST
x-www-form-urlencoded parameters (parameters in bold are required):

 

  1. auth_sig - Your Dotsignal login credentials separated by a colon, and then passed into an MD5 hashing function. For example, MD5(user123@example.com:password123) would result in an auth_sig of "e7275c237e8fef3c7cabb294c9379d0c"

Returns: JSON

{
     "success": true,
     "token": "YOUR_TOKEN",
     "expiresIn": 86400
}

 

NOTE: All methods other than authenticate require a header parameter x-access-token = YOUR_TOKEN, which was returned by the call to authenticate.

 

 

Add User


 

Call this method to programmatically create user accounts within the Dotsignal platform.

 

Method URL: https://chat.dotsignal.com:3001/api/addUser
Method Type: POST
x-www-form-urlencoded parameters (parameters in bold are required):

 

  1. firstName - The first name of the user to add
  2. lastName - The last name of the user to add
  3. phone - The user's mobile phone number
  4. email - The user's email address that will be used to login to the Dotsignal Platform
  5. password - The user's password that will be used to login to the Dotsignal Platform
  6. teamIDs - 1 or more comma-separated teams to add the user to, ex. 47,50,51 would add the user to the 3 identified teams

Returns: JSON

{
     "success": true,
     "userID": 60224
}

 


Get Users


Call this method to retrieve a list of user accounts associated with a given web site or team within the Dotsignal platform.

 

Method URL: https://chat.dotsignal.com:3001/api/getUsers
Method Type: POST
x-www-form-urlencoded parameters (parameters in bold are required):

  1. siteID - The unique site identifier that you wish to retrieve users for
  2. teamID - The unique team identifier that you wish to retrieve users for

NOTE: At least one of siteID OR teamID MUST be provided. Both may be included if desired.

Returns: JSON

{
     "success": true,
     "users": [
          {
               "teamID": 1,
               "parentTeamID": null,
              "teamName": "Base Team",
               "userID": 1,
               "firstName": "John",
               "lastName": "Doe",
              "phone": "18015555555"
         },
         {
              "teamID": 2,
              "parentTeamID": 1,
              "teamName": "Backup Team",
               "userID": 2,
               "firstName": "Jane",
               "lastName": "Doe",
              "phone": "18015555556"
          }
     ]
}

Have more questions? Submit a request