[NEW] [PR- RocketChat/Rocket.Chat#18514] update Livechat Rest API docs (

#1774)
RocketChat · Aug 12, 2020 · b10b930 · b10b930
1 parent f7fc771
commit b10b930
Show file tree

Hide file tree

Showing 2 changed files with 55 additions and 0 deletions.
diff --git a/api/rest-api/methods/livechat/README.md b/api/rest-api/methods/livechat/README.md
@@ -46,6 +46,7 @@ Manage Livechat related data:
 | `/api/v1/livechat/visitor` | `POST` | Register a new Livechat visitor. | [info](visitor.md) |
 | `/api/v1/livechat/visitor/:token` | `GET` | Retrieve a visitor data. | [info](visitor.md) |
 | `/api/v1/livechat/visitors.info` | `GET` | Retrieve a visitor info. | [info](visitor.md) |
+| `/api/v1/livechat/visitors.search` | `GET` | Search for Visitors. | [info](visitor.md#search-for-visitors) |
 | `/api/v1/livechat/page.visited` | `POST` | Send visitor navigation history to Rocket.Chat. | [info](visitor.md#send-visitor-navigation-history) |
 | `/api/v1/livechat/appearance` | `GET` | Get the settings about Livechat Widget Appearance. | [info](appearance.md) |
 | `/api/v1/livechat/visitors.pagesVisited` | `GET` | Gets the visitor navigation history. | [info](visitor.md#get-the-visitor-navigation-history) |

diff --git a/api/rest-api/methods/livechat/visitor.md b/api/rest-api/methods/livechat/visitor.md
@@ -341,3 +341,57 @@ curl http://localhost:3000/api/v1/livechat/visitors.chatHistory/room/room-id/vis
 | :--- | :--- |
 | 2.4.0 | Added |
 
+## Search for Visitors
+
+Search for a Visitor using their name, username, email or phone. It supports the [Offset, Count, and Sort Query Parameters](../../offset-and-count-and-sort-info.md).
+
+| URL | Requires Auth | HTTP Method |
+| :--- | :--- | :--- |
+| `/api/v1/livechat/visitors.search` | `yes` | `GET` |
+
+## Query Parameter
+
+| Argument | Example | Required | Description |
+| :--- | :--- | :--- | :--- |
+| `term` | `guest-1@company.com` | Optional | The visitor's name, username, email or phone  |
+
+## Example Call
+
+```bash
+curl http://localhost:3000/api/v1/livechat/visitors.search?term=guest-1@company.com
+```
+
+## Example Result
+
+```javascript
+{
+  "visitors": [
+    {
+      "_id": "KQv3cHgvW7CDQtGap",
+      "username": "guest-1",
+      "visitorEmails": [
+        {
+          "address": "guest-1@company.com"
+        }
+      ],
+      "phone": [
+        {
+          "phoneNumber": "912235665456"
+        }
+      ],
+      "name": "joey"
+    }
+  ],
+  "count": 1,
+  "offset": 0,
+  "total": 1,
+  "success": true
+}
+```
+
+## Change Log
+
+| Version | Description |
+| :--- | :--- |
+| 3.6.0 | Added |
+