Live Chat Api

Get Organisation Info Create Operator Get Operator Info Get Operator List Update Operator Create Domain Get Domain Info Update Domain Delete Domain Assign Operator In Domain Update Assigned Operator Remove Assigned Operator Assigned Operator List Delete User

Get Organisation Info API

Request Type	GET
Request URL	baseURL + auth/organisation

Expected Output:

{
      "status": 1,  // 1=> successfull request, 0=> Un sucessfull request 
      "type" : "Success" // success or error or warning  
      "message" : {  // organisation data 
          "status": 1 => Active, 0 => Blocked by sa , 2 => Incomplete Payment 
          "dummyDomain": true => Dummy account, false => Live account 
          "name": Organisation name 
          "email": Organisation email 
          "access": [{ // access type either 'admin' or 'staff'
              "role": admin => have all access, staff => access using by permission array 
              "status": 0 => blocked, 1 => active (Only applicable for staff account)
              "permission": permission array using by staff role 
              "name":  name of the account 
              "email": email of the account 
          }],
          "plan": [{
              "name": Plan name 
              "price": plan price 
              "features": plan features 
              "subscriptionID": paypal subsciption id
          }],
          "addon": [{
              "name": addon name 
              "uniqueName": addon unique name 
              "subscriptionID": paypal subscription id 
              "status": 1 => active, 2 => inactive 
              "plan": addon plan installed by organisation 
              "uvdeskConfig": uvdesk config (only use in uvdesk addon)
              "schedulerConfig": scheduler config (only use in scheduler addon),
              "accessToken": (only use in seller buyer addon)
              "refreshToken": (only use in seller buyer addon)
          }]   
      }
}

Create Operator API

Required Fields (In body parameter) :
Request Type	POST
Request URL	baseUrl + auth/addon/live_chat/operator/add
email	email of operator
name	name of operator

Expected Output :

{
      "status": 1,  // 1=> successfull request, 0=> Un sucessfull request 
      "type" : "Success" // success or error or warning  
      "message": {
          "name": name of operator
          "email": email of operator 
      }
}

Get Operator Info API

Required Field (In query parameter)
Request Type	GET
Request URL	baseUrl + auth/addon/live_chat/operator/get
email	email of operator

Expected Output:

{
     "status": 1,  // 1=> successfull request, 0=> Un sucessfull request 
      "type" : "Success" // success or error or warning  
     "message": {
          "name": name of operator
          "email": email of operator
          "status": status of operator // 0 => offline 1=> online 3=> busy 2=> away
          "active": 1 => user able to login 0=> unable to login
          "operator": true => operator, false => not a operator 
          "addOns": [{ // live chat addon 
              "status": 1 => active in addon 0 => Inactive in addon
          }]
      }
}

Get Operator List API

Request Type	GET
Request URL	baseUrl + auth/addon/live_chat/operator/list

Expected Output:

{
     "status": 1,  // 1=> successfull request, 0=> Un sucessfull request 
      "type" : "Success" // success or error or warning  
     "message": [
           {
              "name": { // name  of operator
                  "lastName": last name of operator,
                  "firstName": first name of operator
              },
              "email": email of operator
              "status": status of operator // 0 => offline 1=> online 3=> busy 2=> away
              "active": 1 => user able to login 0=> unable to login
              "operator": true => operator, false => not a operator 
              "addOns": [{ // live chat addon 
                  "status": 1 => active in addon 0 => Inactive in addon
              }]
          },
          {},{},......
      ]
}

Update Operator API (used to update the status of operator at live chat addon)

Required Fields (In body parameter) :
Request Type	PUT
Request URL	baseUrl + auth/addon/live_chat/operator/update
email	email of operator
Updated Fields (This field is mandatory for update) :
status	accepted value 0 or 1 // (1=> active or 0=> inactive only for the live chat addon)
Optional Fields //(only used in case of status value is 1)
domain	[test.com, webkul.com] // use in this specific format

Expected Output:

{
      "status": 1,  // 1=> successfull request, 0=> Un sucessfull request 
      "type" : "Success" // success or error or warning  
      "message": 'Record Updated Successfully'
}

Create Domain API

Required Fields (In body parameter) :
Request Type	POST
Request URL	baseUrl + auth/addon/live_chat/domain/add
domain	name of domain // without http:// or https://
email	email for domain register

Expected Output:

{
     "status": 1,  // 1=> successfull request, 0=> Un sucessfull request 
     "type" : "Success" // success or error or warning  
     "message": {
          "name": name domain
          "email": email of domain
          "link": use this code at web page
          "socketLink": use this code at web page
      }
}

Get Domain Info API

Required Field (In query parameter)
Request Type	GET
Request URL	baseUrl + auth/addon/live_chat/domain/get
domain	name of domain

Expected Output:

{
     "status": 1,  // 1=> successfull request, 0=> Un sucessfull request 
     "type" : "Success" // success or error or warning  
     "message": {
          "name": name of domain
          "email": email of domain
          "status": status of domain // true => active false=>  inactive,
          "addonUniqueName": unique name of addon 
          "operators": Operator details 
      }
}

Update Domain API (used to update the status, name, email of domain)

Required Fields (In body parameter) :
Request Type	PUT
Request URL	baseUrl + auth/addon/live_chat/domain/update
domain	name of domain
updated Fields (minimum one field is mandatory for update) :
new_domain	name of domain // new domain name without http:// https:// www
status	status of domain // true => active, false => inactive
email	email for domain // which you want to update

Expected Output:

{
      "status": 1,  // 1=> successfull request, 0=> Un sucessfull request 
      "type" : "Success" // success or error or warning  
      "message": 'Domain Update Successfully'
}

Delete Domain API

Required Fields (In body parameter) :
Request Type	DELETE
Request URL	baseUrl + auth/addon/live_chat/domain/delete
domain	name of domain

Expected Output:

{
      "status": 1,  // 1=> successfull request, 0=> Un sucessfull request 
      "type" : "Success" // success or error or warning  
      "message": 'Domain Deleted Successfully'
}

Assign Operator In Domain At Live Chat Addon

Required Fields (In body parameter):
Request Type	POST
Request URL	baseUrl + auth/addon/live_chat/domain/operator/add
domain	name of domain // name of domain at which create operator
email	email of operator // operator's email that you want to assign at domain

Expected Output :

{
     "status": 1,  // 1=> successfull request, 0=> Un sucessfull request 
     "type" : "Success" // success or error or warning  
     "message": 'Operator Added Successfully'
}

Update Assigned Operator (update operator's online_status, is_admin, active )

Required Fields (In body parameter):
Request Type	PUT
Request URL	baseUrl + auth/addon/live_chat/domain/operator/update
domain	name of domain
email	email of operator
Updated Fields (minimum one field is mandatory for update) :
is_admin	true or false
online_status	true or false // operator visible online or offline
active	true or false // operator getting message or not

Expected Output :

{
     "status": 1,  // 1=> successfull request, 0=> Un sucessfull request 
     "type" : "Success" // success or error or warning
     "message": {
          "operators": 'Operator Updated Successfully'
      }
}

Remove Assigned Operator

Required Fields (In body parameter):
Request Type	PUT
Request URL	baseUrl + auth/addon/live_chat/domain/operator/remove
domain	name of domain
email	email of operator

Expected Output :

{
     "status": 1,  // 1=> successfull request, 0=> Un sucessfull request 
     "type" : "Success" // success or error or warning
     "message": {
          "operators": 'Operator Updated Successfully'
      }
}

Assigned Operator List

Required Fields (In query parameter):
Request Type	GET
Request URL	baseUrl + auth/addon/live_chat/domain/operator/list
domain	name of domain

Expected Output :

{
     "status": 1,  // 1=> successfull request, 0=> Un sucessfull request 
     "type" : "Success" // success or error or warning
     "message": [
          {
              "name": { // name  of operator
                  "lastName": last name of operator,
                  "firstName": first name of operator
              },
              "isAdmin": false,     // admin permission
              "chatStatus": true,   // operator's online status
              "active": true,       // operator's activity  
              "userId": "5ebb9869660dcd1a533469e7",
              "email": "saurabhbarnwal1998@gmail.com" // email of operator
          }, {}, {}, .....
      ]
}

Delete User

Required Fields (In body parameter):
Request Type	DELETE
Request URL	baseUrl + auth/user/delete
email	email of operator or user

Expected Output :

{
     "status": 1,  // 1=> successfull request, 0=> Un sucessfull request 
     "type" : "Success" // success or error or warning
     "message": {
          "operators": 'User Deleted Successfully'
      }
}

Chatwhizz Live Chat External API

Get Organisation Info API

Create Operator API

Get Operator Info API

Get Operator List API

Update Operator API (used to update the status of operator at live chat addon)

Create Domain API

Get Domain Info API

Update Domain API (used to update the status, name, email of domain)

Delete Domain API

Assign Operator In Domain At Live Chat Addon

Update Assigned Operator (update operator's online_status, is_admin, active )

Remove Assigned Operator

Assigned Operator List

Delete User