[NEW] Livechat messages rest APIs by hmagarotto · Pull Request #10054 · RocketChat/Rocket.Chat

hmagarotto · 2018-03-07T19:29:57Z

@RocketChat/core

This PR added one API route to allow some external integrator send a message to a livechat room as a visitor and make guest registration if necessary. Additionally, one endpoint to check agent availability was added.
The payload to send a message was derived from the payload send to webhook.

rodrigok · 2018-03-12T13:28:25Z

packages/rocketchat-livechat/imports/server/rest/messages.js

+			return RocketChat.API.v1.unauthorized();
+		}
+
+		const info = Meteor.call('livechat:getInitialData', this.urlParams.visitorToken);


Which data you want to get here? This method is returning a lot of data not related to visitor's status

@rodrigok we change this to pick only the fields below from initialData result:

visitor

room

departments

online

agentData

rodrigok · 2018-03-12T13:31:47Z

packages/rocketchat-livechat/imports/server/rest/messages.js

+		if (!this.bodyParams.visitor.token) {
+			return RocketChat.API.v1.failure('Body param "visitor.token" is required');
+		}
+		const visitorToken = this.bodyParams.visitor.token;


Should check this.bodyParams.messages as an array and if not empty

@rodrigok , we added some validations to messages param according to suggestions

…Chat into livechat-messages-api

rodrigok · 2018-03-15T18:16:31Z

packages/rocketchat-livechat/imports/server/rest/messages.js

+		}
+
+		const initialData = Meteor.call('livechat:getInitialData', this.urlParams.visitorToken);
+		const info = _.pick(initialData, 'visitor', 'room', 'departments', 'online', 'agentData');


Why do you need these fields? When I see the route's name I imagine it would return only the visitor's status.

Hi @rodrigok, so, in the beginning, the requirement was to know if there is some agent available (online) and then take some actions, but during the implementation, we realized that other information would be important too, such as "room", "departments" (to direct the visitor to the right chat), and "agentData" (to inform the visitor the name of agent). In the end, we left the route endpoint only named as status. Do you think is better create another endpoint to this extra information or just renaming the endpoint from status to something wider meaning is enough?

Hi @rodrigok,
I think of two ways to improve this

Proposal 1

is it better if we break that into two endpoints?

Visitor Endpoint: "http://host/api/v1/livechat/visitor/:visitorToken"

visitor data

visitor room

agent serving visitor

Livechat Status: "http://host/api/v1/livechat/status"

agents online

available departments

Proposal 2

or maybe break into four endpoints:

Visitor Endpoint: "http://host/api/v1/livechat/visitor/:visitorToken"

visitor data

Rooms Endpoint: "http://host/api/v1/livechat/visitor/:visitorToken/room"

opened rooms for the visitor or all rooms for visitor

with this endpoint we can check who is serving the visitor

Departments Endpoint: "http://host/api/v1/livechat/department"

list all departments

with this endpoint we can determine and show only available departments to the visitor (we can filter for enabled departments and with agents)

Agents Endpoint: "http://host/api/v1/livechat/agent"

list all agents

with this endpoint we can check for online agents (we can count online agents) and get agent details to show whos serving the visitor

Department endpoint already exists, but authentication is not based on the webhook token, its based on user login. We will need to deal with this.

What do you think? Is it better?

Hi @hmagarotto I prefer the second option with multiple endpoints with more clear results

Thank you @rodrigok , we'll start to make changes

hmagarotto · 2018-03-27T01:44:19Z

@rodrigok I made the requested changes as proposed.

The "department" and "agent" endpoint already existed. I added the name and status into agent user data.

All endpoints are authenticated using REST login.

Responses examples:

Visitor: http://localhost:3000/api/v1/livechat/visitor/zCzPcfA73AaQ44RJs

{
  "_id": "Woa3YMoaNuCziv9hW",
  "username": "guest-8",
  "department": "yfZZkAYZEsa8E8dQf",
  "userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/65.0.3325.146 Safari/537.36",
  "ip": "127.0.0.1",
  "host": "localhost:3000",
  "_updatedAt": "2018-03-27T00:56:50.261Z",
  "token": "zCzPcfA73AaQ44RJs",
  "visitorEmails": [
    {
      "address": "[email protected]"
    }
  ],
  "name": "Guest Name",
  "success": true
}

Rooms: http://localhost:3000/api/v1/livechat/visitor/zCzPcfA73AaQ44RJs/room

{
  "rooms": [
    {
      "t": "l",
      "cl": false,
      "usernames": [
        "agent.one"
      ],
      "servedBy": {
        "_id": "qzPNhHRKRnKXFqASi",
        "username": "agent.one"
      },
      "_id": "PZ7Nbm573kbziXgcn"
    }
  ],
  "success": true
}

Departments: http://localhost:3000/api/v1/livechat/department

{
  "departments": [
    {
      "_id": "yfZZkAYZEsa8E8dQf",
      "enabled": true,
      "name": "SAC",
      "description": "",
      "numAgents": 1,
      "showOnRegistration": true,
      "_updatedAt": "2018-03-27T00:58:30.647Z"
    }
  ],
  "success": true
}

Department Item: http://localhost:3000/api/v1/livechat/department/yfZZkAYZEsa8E8dQf

{
  "department": {
    "_id": "yfZZkAYZEsa8E8dQf",
    "enabled": true,
    "name": "SAC",
    "description": "",
    "numAgents": 1,
    "showOnRegistration": true,
    "_updatedAt": "2018-03-27T00:58:30.647Z"
  },
  "agents": [
    {
      "_id": "RFgzKhhZWqCRdmBEw",
      "agentId": "qzPNhHRKRnKXFqASi",
      "departmentId": "yfZZkAYZEsa8E8dQf",
      "username": "agent.one",
      "count": 0,
      "order": 0,
      "_updatedAt": "2018-03-27T00:58:30.658Z"
    }
  ],
  "success": true
}

Agents: http://localhost:3000/api/v1/livechat/users/agent

{
  "users": [
    {
      "_id": "yBx92hRyN5kdqiB4w",
      "username": "henrique",
      "name": "Henrique",
      "status": "away",
      "statusLivechat": "available"
    },
    {
      "_id": "qzPNhHRKRnKXFqASi",
      "username": "agent.one",
      "name": "AgentOne",
      "status": "offline",
      "statusLivechat": "available"
    }
  ],
  "success": true
}

renatobecker-zz · 2018-03-27T18:12:17Z

packages/rocketchat-livechat/imports/server/rest/messages.js

@@ -0,0 +1,64 @@
+import LivechatVisitors from '../../../server/models/LivechatVisitors';
+
+RocketChat.API.v1.addRoute('livechat/messages', {


You are using RocketChat.authz.hasPermission, so you have to set { authRequired: true } to the route parameter.

Thanks @renatobecker , I fixed this.

renatobecker-zz · 2018-03-27T18:13:00Z

packages/rocketchat-livechat/imports/server/rest/messages.js

+		if (!this.bodyParams.visitor) {
+			return RocketChat.API.v1.failure('Body param "visitor" is required');
+		}
+		if (!this.bodyParams.visitor.token) {


this.bodyParams.visitor.token doesn't work. You should use camelCased in the field names, such as this.bodyParams.visitorToken.

@renatobecker the payload used in message post was based in the payload send to webhook.

This is the expected POST for this endpoint:

curl -v -H "Content-type: application/json" -H "${H_USERID}" -H "${H_AUTHTOKEN}" "http://localhost:3000/api/v1/livechat/messages" -d'{ "visitor": { "token":"04aa15e2-31ed-11e8-ac97-93976ab3c67b", "name": "Guest Name", "email": "[email protected]", "phone": { "number": "+5511999999999" } }, "messages": [ { "msg": "Hi!!" } ] }'

Webhook payloads: https://rocket.chat/docs/administrator-guides/livechat/

Have you tried your code? We are talking about the name of a query parameter and the format you are using is not valid.

Yes, we tried it. We are using a body parameter (JSON object) not a query parameter. And this format is to access field token inside visitor inside request body (application/json). This is why "visitor.token"

The "curl" below is working and will create a new guest as shown in the screenshot.

curl -s -H "Content-type: application/json" -H "${H_USERID}" -H "${H_AUTHTOKEN}" "http://localhost:3000/api/v1/livechat/messages" -d'{ "visitor": { "token":"04aa15e2-31ed-11e8-ac97-93976ab3c67b", "name": "Guest Name", "email": "[email protected]", "phone": { "number": "+5511999999999" } }, "messages": [ { "msg": "Hi!!" } ] }'

If you want to try, here is the whole script:
https://gist.github.com/hmagarotto/6251f86e1f00035cc249c8ef05238a90

OK, sorry. I was testing this in another way.

renatobecker-zz · 2018-03-27T18:55:00Z

packages/rocketchat-livechat/imports/server/rest/messages.js

+		if (!this.bodyParams.visitor) {
+			return RocketChat.API.v1.failure('Body param "visitor" is required');
+		}
+		if (!this.bodyParams.visitor.token) {


Have you tried your code? We are talking about the name of a query parameter and the format you are using is not valid.

Changes made

ilyamsts · 2018-06-12T09:11:16Z

By http://localhost:3000/api/v1/livechat/messages method I get an error "Cannot read property 'id' of undefined" after dozens successful requests. Only refreshing the token helps, but not for long. New guest chat is visibly, and 1-st guest message is visibly too in hint agent window. But when agent takes that chat, guest message doesn't display at chat.

renatobecker-zz · 2018-07-02T20:23:12Z

Hi @ilyamsts.
Can you open a new issue describing your case, please?

Thanks.

hmagarotto and others added 2 commits February 22, 2018 15:07

Added api to enable external system sends visitor message

16e96ed

Merge branch 'develop' into livechat-messages-api

e57a6f9

rodrigok previously requested changes Mar 12, 2018

View reviewed changes

hmagarotto added 3 commits March 12, 2018 17:23

Added validations for "messages" body param

322b09d

Picked only relevant fields for status result

eb2627c

Merge branch 'livechat-messages-api' of github.com:hmagarotto/Rocket.…

30c0e89

…Chat into livechat-messages-api

rodrigok reviewed Mar 15, 2018

View reviewed changes

hmagarotto added 3 commits March 26, 2018 22:29

Removed status endpoint and changed authentication method

1ee167d

Added name and status to user payload

57db7a3

Added visitors endpoint

5e0444b

renatobecker-zz self-requested a review March 27, 2018 18:00

renatobecker-zz approved these changes Mar 27, 2018

View reviewed changes

renatobecker-zz suggested changes Mar 27, 2018

View reviewed changes

Fixing endpoint to use require authentication

976b092

renatobecker-zz suggested changes Mar 27, 2018

View reviewed changes

renatobecker-zz approved these changes Mar 27, 2018

View reviewed changes

rodrigok added this to the 0.63.0 milestone Mar 27, 2018

rodrigok merged commit 04a6f3f into RocketChat:develop Mar 27, 2018

hmagarotto deleted the livechat-messages-api branch March 29, 2018 00:01

rodrigok mentioned this pull request Apr 4, 2018

Release 0.63.0 #10324

Merged

		@@ -0,0 +1,64 @@
		import LivechatVisitors from '../../../server/models/LivechatVisitors';

		RocketChat.API.v1.addRoute('livechat/messages', {

Conversation

hmagarotto commented Mar 7, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Proposal 1

Proposal 2

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hmagarotto commented Mar 27, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hmagarotto Mar 27, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

renatobecker-zz Mar 27, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

renatobecker-zz Mar 27, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ilyamsts commented Jun 12, 2018

Uh oh!

renatobecker-zz commented Jul 2, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

hmagarotto commented Mar 27, 2018 •

edited

Loading

hmagarotto Mar 27, 2018 •

edited

Loading

renatobecker-zz Mar 27, 2018 •

edited

Loading

renatobecker-zz Mar 27, 2018 •

edited

Loading