GITBOOK-1167: Omnichannel: Visitor endpoints set 2

RocketChat · Nov 20, 2023 · db22b1d · db22b1d
1 parent ddee3dc
commit db22b1d
Show file tree

Hide file tree

Showing 15 changed files with 178 additions and 350 deletions.
diff --git a/SUMMARY.md b/SUMMARY.md
@@ -408,10 +408,14 @@
             * [Send Livechat Offline Message](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/livechat-offline-message.md)
           * [Livechat Visitors](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/visitor/README.md)
             * [Register Livechat Visitor](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/visitor/register-a-new-livechat-visitor.md)
-            * [Get Visitor Data](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/visitor/retrieve-a-visitor-data.md)
-            * [Get Visitor Information](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/visitor/get-the-visitor-info.md)
+            * [Get Visitor Information](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/visitor/retrieve-a-visitor-data.md)
+            * [Get Visitor Information by ID](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/visitor/get-the-visitor-info.md)
             * [Get Open Conversation of a Visitor](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/visitor/get-open-conversation-of-a-visitor.md)
-            * [Search for Visitors](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/visitor/search-for-visitors.md)
+            * [Search Visitors by Term](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/visitor/search-visitors-by-term.md)
+            * [Get Pages Visited by Livechat Visitor](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/visitor/get-pages-visited-by-livechat-visitor.md)
+            * [Get Livechat Visitor Chat History](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/visitor/get-livechat-visitors-chat-history.md)
+            * [Search Visitor Chat](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/visitor/search-a-visitors-chat.md)
+            * [Visitor Autocomplete](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/visitor/visitor-autocomplete.md)
             * [Set Visitor Status](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/visitor/set-visitor-status.md)
             * [Delete Visitor](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/visitor/delete-a-visitor.md)
           * [Livechat Statistics](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/livechat-statistics/README.md)
@@ -503,13 +507,6 @@
             * [List Livechat Triggers](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/livechat-triggers/list-livechat-triggers.md)
             * [Get a Livechat Trigger](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/livechat-triggers/get-a-livechat-trigger.md)
           * [Livechat Upload](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/livechat-upload.md)
-          * [Livechat Visitors](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/livechat-visitors-1/README.md)
-            * [Visitor info by ID](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/livechat-visitors-1/visitor-info-by-id.md)
-            * [Get pages visited by livechat visitor](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/livechat-visitors-1/get-pages-visited-by-livechat-visitor.md)
-            * [Get livechat visitor's chat history](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/livechat-visitors-1/get-livechat-visitors-chat-history.md)
-            * [Search a visitors chat](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/livechat-visitors-1/search-a-visitors-chat.md)
-            * [Visitor Autocomplete](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/livechat-visitors-1/visitor-autocomplete.md)
-            * [Search Visitors by term](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/livechat-visitors-1/search-visitors-by-term.md)
           * [Livechat Monitors](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/livechat-monitors/README.md)
             * [Get Monitors](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/livechat-monitors/get-monitors.md)
             * [Get a Monitor](reference/api/rest-api/endpoints/omnichannel/livechat-endpoints/livechat-monitors/get-a-monitor.md)

diff --git a/reference/api/rest-api/endpoints/README.md b/reference/api/rest-api/endpoints/README.md
@@ -512,14 +512,14 @@ From version 0.50.0 and on, you can call the methods using `dm` instead of `im`.
 
 #### Livechat Visitors
 
-| Url                                                                    | Short Description                           | Details Page                                                                                        |
-| ---------------------------------------------------------------------- | ------------------------------------------- | --------------------------------------------------------------------------------------------------- |
-| `api/v1/livechat/visitors.info`                                        | Retrieves visitor info by ID                | [Link](omnichannel/livechat-endpoints/livechat-visitors-1/visitor-info-by-id.md)                    |
-| `api/v1/livechat/visitors.pagesVisited/:roomId`                        | Retrieves pages visited by livechat visitor | [Link](omnichannel/livechat-endpoints/livechat-visitors-1/get-pages-visited-by-livechat-visitor.md) |
-| `api/v1/livechat/visitors.chatHistory/room/:roomId/visitor/:visitorId` | Retrieves livechat visitor's chat history   | [Link](omnichannel/livechat-endpoints/livechat-visitors-1/get-livechat-visitors-chat-history.md)    |
-| `api/v1/livechat/visitors.searchChats/room/:roomId/visitor/:visitorId` | Searches a visitor's chat                   | [Link](omnichannel/livechat-endpoints/livechat-visitors-1/search-a-visitors-chat.md)                |
-| `api/v1/livechat/visitors.autocomplete`                                | Autocompletes visitor's name                | [Link](omnichannel/livechat-endpoints/livechat-visitors-1/visitor-autocomplete.md)                  |
-| `api/v1/livechat/visitors.search`                                      | Searches the visitor by the term            | [Link](omnichannel/livechat-endpoints/livechat-visitors-1/search-visitors-by-term.md)               |
+| Url                                                                    | Short Description                           | Details Page                                                                            |
+| ---------------------------------------------------------------------- | ------------------------------------------- | --------------------------------------------------------------------------------------- |
+| `api/v1/livechat/visitors.info`                                        | Retrieves visitor info by ID                | [Link](omnichannel/livechat-endpoints/visitor/get-the-visitor-info.md)                  |
+| `api/v1/livechat/visitors.pagesVisited/:roomId`                        | Retrieves pages visited by livechat visitor | [Link](omnichannel/livechat-endpoints/visitor/get-pages-visited-by-livechat-visitor.md) |
+| `api/v1/livechat/visitors.chatHistory/room/:roomId/visitor/:visitorId` | Retrieves livechat visitor's chat history   | [Link](omnichannel/livechat-endpoints/visitor/get-livechat-visitors-chat-history.md)    |
+| `api/v1/livechat/visitors.searchChats/room/:roomId/visitor/:visitorId` | Searches a visitor's chat                   | [Link](omnichannel/livechat-endpoints/visitor/search-a-visitors-chat.md)                |
+| `api/v1/livechat/visitors.autocomplete`                                | Autocompletes visitor's name                | [Link](omnichannel/livechat-endpoints/visitor/visitor-autocomplete.md)                  |
+| `api/v1/livechat/visitors.search`                                      | Searches the visitor by the term            | [Link](omnichannel/livechat-endpoints/visitor/search-visitors-by-term.md)               |
 
 #### Livechat Monitors
 

diff --git a/...rest-api/endpoints/omnichannel/livechat-endpoints/livechat-visitors-1/README.md b/...rest-api/endpoints/omnichannel/livechat-endpoints/livechat-visitors-1/README.md
diff --git a/...livechat-endpoints/livechat-visitors-1/get-pages-visited-by-livechat-visitor.md b/...livechat-endpoints/livechat-visitors-1/get-pages-visited-by-livechat-visitor.md
diff --git a/...ts/omnichannel/livechat-endpoints/livechat-visitors-1/search-a-visitors-chat.md b/...ts/omnichannel/livechat-endpoints/livechat-visitors-1/search-a-visitors-chat.md
diff --git a/...ints/omnichannel/livechat-endpoints/livechat-visitors-1/visitor-autocomplete.md b/...ints/omnichannel/livechat-endpoints/livechat-visitors-1/visitor-autocomplete.md
diff --git a/...points/omnichannel/livechat-endpoints/livechat-visitors-1/visitor-info-by-id.md b/...points/omnichannel/livechat-endpoints/livechat-visitors-1/visitor-info-by-id.md
diff --git a/...s-1/get-livechat-visitors-chat-history.md → ...tor/get-livechat-visitors-chat-history.md b/...s-1/get-livechat-visitors-chat-history.md → ...tor/get-livechat-visitors-chat-history.md
@@ -1,38 +1,30 @@
----
-description: Get livechat visitor's chat history
----
+# Get Livechat Visitor Chat History
 
-# Get livechat visitor's chat history
+Get the Livechat history of a visitor.
 
-| URL | Requires Auth | HTTP Method |
-| :--- | :--- | :--- |
-| `api/v1/livechat/visitors.chatHistory/room/:roomId/visitor/:visitorId` | `YES` | `GET` |
+<table><thead><tr><th width="163">HTTP Method</th><th width="318">URL</th><th>Requires Auth</th></tr></thead><tbody><tr><td><code>GET</code></td><td><code>/api/v1/livechat/visitors.chatHistory/room/:roomId/visitor/:visitorId</code></td><td><a href="../../../authentication-endpoints/"><code>yes</code></a></td></tr></tbody></table>
 
-## Headers
+## Query Parameters
 
-| Argument | Example | Required | Description |
-| :--- | :--- | :--- | :--- |
-| `X-User-Id` | `myuser-name` | Required | Your username hash \(returned after you log in through the API\) |
-| `X-Auth-Token` | `myauth-token` | Required | Your token \(returned after you log in through the API\) |
+This endpoint supports the [#pagination](../../../../#pagination "mention")query parameters.
 
-## URL Parameters
+## Path Variables
 
-| Argument | Example | Required | Description |
-| :--- | :--- | :--- | :--- |
-| `roomId` | `hhMKhHnnbY79mGs9K` | Required | Livechat room id |
-| `visitorId` | `QyBAKC5Wc8tcv6cco` | Required | Livechat visitor id |
+<table><thead><tr><th width="215.33333333333331">Key</th><th>Example Value</th><th>Description</th></tr></thead><tbody><tr><td><code>roomId</code><mark style="color:red;"><code>*</code></mark></td><td><code>hhMKhHnnbY79mGs9K</code></td><td>Livechat room ID.</td></tr><tr><td><code>visitorId</code><mark style="color:red;"><code>*</code></mark></td><td><code>QyBAKC5Wc8tcv6cco</code></td><td>Livechat visitor ID.</td></tr></tbody></table>
 
 ## Example Call
 
-```bash
+{% code overflow="wrap" %}
+```powershell
 curl --location --request GET 'http://localhost:3000/api/v1/livechat/visitors.chatHistory/room/:roomId/visitor/:visitorId \
 --header 'X-Auth-Token: myauth-token' \
 --header 'X-User-Id: myuser-name'
 ```
+{% endcode %}
 
-## Result
+## Example Response
 
-```javascript
+```json
 {
     "history": [
         {
@@ -114,4 +106,3 @@ curl --location --request GET 'http://localhost:3000/api/v1/livechat/visitors.ch
     "success": true
 }
 ```
-