Merge pull request #280 from PacoVu/main

Minor update
ringcentral · Oct 2, 2024 · a818caf · a818caf
2 parents 7faa5d9 + a7243d6
commit a818caf
Show file tree

Hide file tree

Showing 5 changed files with 100 additions and 15 deletions.
diff --git a/code-samples/events/rcv-ringsense-event.json → ...-samples/ai/ringsense/ringsense-data.json b/code-samples/events/rcv-ringsense-event.json → ...-samples/ai/ringsense/ringsense-data.json
diff --git a/code-samples/events/ringsense-event.json b/code-samples/events/ringsense-event.json
@@ -0,0 +1,91 @@
+{
+  "uuid": "4130446572007716222",
+  "event": "/ai/ringsense/v1/public/accounts/80964XXXX/domains/pbx/insights",
+  "timestamp": "2024-09-04T21:16:16.390Z",
+  "subscriptionId": "90e18302-3155-42ca-ba01-b05e8f863f24",
+  "ownerId": "6228832XXXX",
+  "body": {
+    "title": "Call from John Smith to Tracy Debolah",
+    "domain": "pbx",
+    "sourceSessionId": "s-a0e7b361acc0az191bec7e275z7cae070000",
+    "sourceRecordId": "2728084995017",
+    "callDirection": "Outbound",
+    "ownerExtensionId": "6228832XXXX",
+    "recordingDurationMs": 125963,
+    "recordingStartTime": "2024-09-04T20:44:16.390Z",
+    "creationTime": "2024-09-04T21:15:43.597Z",
+    "lastModifiedTime": "2024-09-04T21:15:43.591Z",
+    "speakerInfo": [
+      {
+        "speakerId": "p-a0e7b361acc0az191bec7e275z7cae070000-1",
+        "name": "John Smith",
+        "accountId": "809646XXX",
+        "extensionId": "6228832XXXX"
+      },
+      {
+        "speakerId": "p-a0e7b361acc0az191bec7e275z7cae070000-2",
+        "name": "Tracy Debolah",
+        "accountId": null,
+        "extensionId": null
+      }
+    ],
+    "insights": {
+      "Transcript": [
+        {
+          "end": 14.52,
+          "text": "Okay, I record this meeting so we will have the RingSense meeting insights.",
+          "start": 2.2,
+          "speakerId": "p-a0e7b361acc0az191bec7e275z7cae070000-1"
+        },
+        ...
+        {
+          "end": 40.44,
+          "text": "And I have some action items for myself.",
+          "start": 36.6,
+          "speakerId": "p-a0e7b361acc0az191bec7e275z7cae070000-1"
+        },
+        {
+          "end": 46.12,
+          "text": "As I have to complete the test.",
+          "start": 42.52,
+          "speakerId": "p-a0e7b361acc0az191bec7e275z7cae070000-1"
+        },
+        ...
+        {
+          "end": 125.88,
+          "text": "Goodbye.",
+          "start": 125.4,
+          "speakerId": "p-a0e7b361acc0az191bec7e275z7cae070000-1"
+        }
+      ],
+      "Summary": [
+        {
+          "start": 0,
+          "end": 1,
+          "value": "The call is about discussing the tasks and timeline for completing a project."
+        }
+      ],
+      "NextSteps": [
+        {
+          "start": 42.52,
+          "end": 53.32,
+          "value": "Complete the test with own code for the API.",
+          "speakerId": "p-a0e7b361acc0az191bec7e275z7cae070000-1"
+        },
+        {
+          "start": 56.04,
+          "end": 64.92,
+          "value": "Write a developer guide for the API.",
+          "speakerId": "p-a0e7b361acc0az191bec7e275z7cae070000-2"
+        },
+        ...
+        {
+          "start": 82.92,
+          "end": 99.56,
+          "value": "Publish the developer guide after review and editing.",
+          "speakerId": "p-a0e7b361acc0az191bec7e275z7cae070000-1"
+        }
+      ]
+    }
+  }
+}
diff --git a/docs/ai/ringsense4sales.md → docs/ai/ringsenseforsales.md b/docs/ai/ringsense4sales.md → docs/ai/ringsenseforsales.md
@@ -29,11 +29,9 @@ There are two methods to access RingSense for Sales data: through push notificat
 
 ### RingSense for Sales event notification
 
-You can get notified when a new voice call recording analysis is completed via [RingCentral push notification  service](https://developers.ringcentral.com/guide/notifications). The RingSense for Sales data is included in the event payload together with the event metadata.
+You can get notified when a new voice call recording analysis is completed via [RingCentral push notification  service](../notifications/index.md). The RingSense for Sales data is included in the event payload together with the event metadata.
 
-To get RingSense for Sales event notification for voice call recordings, subscribe for this event:
-
-`/ai/ringsense/v1/public/accounts/~/domains/pbx/insights`
+To get RingSense for Sales event notification for voice call recordings, [subscribe for this event](../notifications/event-filters/ringsenseforsales.md).
 
 Remember, the notification events are triggered only if a voice call was recorded by users who hold a RingSense for Sales license.
 
@@ -42,18 +40,18 @@ Remember, the notification events are triggered only if a voice call was recorde
 You can read the RingSense for Sales data of a voice call recording if you know the `sourceRecordId`. The `sourceRecordId` value of a recording is included in the RingSense for Sales event payload.
 
 !!! notes
-    * The `sourceRecordId` of a voice call recording is the recording ID of a recorded call. You can get the recording ID of a call from the [call log data](https://developers.ringcentral.com/guide/voice/call-log/details).
+    * The `sourceRecordId` of a voice call recording is the recording ID of a recorded call. You can get the recording ID of a call from the [call log data](../voice/call-log/details.md).
 
 ## Example of API Response
 
 ```json
-{!> code-samples/events/rcv-ringsense-event.json !}
+{!> code-samples/ai/ringsense/ringsense-data.json !}
 ```
 
 | Parameter	| Type | Description |
 |-----------|------|-------------|
 | `title` | string | For voice calls, the system uses the the caller and callee name to compose the title. |
-| `domains` | String | Name of the communication method. Currently only for voice calls ('pbx') are supported. |
+| `domain` | String | Name of the communication medium. Currently only for voice calls ('pbx') are supported. |
 | `sourceRecordId` | String | The value is the call recording ID (can be retrieved from the call log).  |
 | `sourceSessionId` | String | The value is the call telephony session id. |
 | `callDirection` | String | For voice calls only. The value is either `Inbound` or `Outbound`.  |

diff --git a/...ications/event-filters/ringsense4sales.md → ...ations/event-filters/ringsenseforsales.md b/...ications/event-filters/ringsense4sales.md → ...ations/event-filters/ringsenseforsales.md
@@ -11,7 +11,7 @@ This event is triggered whenever a new voice call analysis is completed by RingS
 | Parameter	| Type | Description |
 |-----------|------|-------------|
 | `title` | string | For voice calls, the system uses the the caller and callee name to compose the title. |
-| `domains` | String | Name of the communication method. Currently only for voice calls ('pbx') are supported. |
+| `domain` | String | Name of the communication method. Currently only for voice calls ('pbx') are supported. |
 | `sourceRecordId` | String | The value is the call recording ID (can be retrieved from the call log).  |
 | `sourceSessionId` | String | The value is the call telephony session id. |
 | `callDirection` | String | For voice calls only. The value is either `Inbound` or `Outbound`.  |
@@ -26,5 +26,5 @@ This event is triggered whenever a new voice call analysis is completed by RingS
 ## Examples
 
 ```json
-{!> code-samples/events/rcv-ringsense-event.json !}
+{!> code-samples/events/ringsense-event.json !}
 ```
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -132,10 +132,6 @@ nav:
       - 'A2P SMS Messaging': 'https://ringcentral-tutorials.github.io/a2p-sms-messaging-nodejs-demo/'
       - 'Two-factor Authentication': 'https://ringcentral-tutorials.github.io/sms-2fa-nodejs-demo/'
       - 'Custom Fax Cover Pages': 'https://ringcentral-tutorials.github.io/fax-cover-page-nodejs-demo/'
-  - 'Social Messaging':
-    - 'Overview': 'social-messaging/index.md'
-    - 'Getting started': 'social-messaging/quick-start.md'
-
   - 'Team Messaging':
     - 'Overview': 'team-messaging/index.md'
     - 'Getting Started': 'team-messaging/quick-start.md'
@@ -271,7 +267,7 @@ nav:
       - 'Conversation summaries': 'ai/text-summary.md'
       - 'Smart punctuation': 'ai/text-punctuation.md'
 
-    - 'RingSense for Sales': 'ai/ringsense4sales.md'
+    - 'RingSense for Sales': 'ai/ringsenseforsales.md'
 
   - 'Accounts and Users':
     - 'Overview': 'account/index.md'
@@ -397,7 +393,7 @@ nav:
         - "Post Message Event": 'notifications/event-filters/post.md'
         - "Chats Event": 'notifications/event-filters/chat.md'
       - "RingSense for Sales events":
-        - "Insights events": 'notifications/event-filters/ringsense4sales.md'
+        - "Insights events": 'notifications/event-filters/ringsenseforsales.md'
     - 'Webhooks':
       - 'Getting Started': 'notifications/webhooks/quick-start.md'
       - 'Subscribing to webhooks': 'notifications/webhooks/creating-webhooks.md'