Skip to content

Commit 09e5691

Browse files
u9520107u9520107
committed
Merge branch 'zapier-26-1-3/docs' into 'main'
feat(zapier-26.1.3): [misc] update docs with guides with 26.1.3 changes See merge request integration/ringcentral-integration-docs!42
2 parents 95f5f51 + ef5958a commit 09e5691

25 files changed

Lines changed: 895 additions & 31 deletions

‎docs/extra.css‎

Lines changed: 58 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -993,4 +993,61 @@ body.has-archiver-nav .md-content {
993993
transform: none;
994994
max-width: 85vw;
995995
}
996-
}
996+
}
997+
998+
/* Zapier release notes */
999+
.md-typeset .zapier-release {
1000+
margin: 2rem 0 0;
1001+
padding: 1.4rem 0 0;
1002+
border-top: 2px solid rgba(0, 39, 85, 0.18);
1003+
}
1004+
1005+
.md-typeset .zapier-release:first-of-type {
1006+
margin-top: 1.4rem;
1007+
}
1008+
1009+
.md-typeset .zapier-release h2 {
1010+
margin: 0 0 0.35rem;
1011+
font-size: 1.45rem;
1012+
font-weight: 700;
1013+
line-height: 1.2;
1014+
}
1015+
1016+
.md-typeset .zapier-release h3 {
1017+
margin-top: 1.2rem;
1018+
font-size: 1rem;
1019+
font-weight: 700;
1020+
}
1021+
1022+
.md-typeset .zapier-release-meta {
1023+
margin: 0.15rem 0 0.9rem;
1024+
padding: 0;
1025+
color: var(--md-default-fg-color--light);
1026+
font-size: 0.72rem;
1027+
line-height: 1.4;
1028+
}
1029+
1030+
.md-typeset .zapier-release-meta p {
1031+
margin: 0;
1032+
}
1033+
1034+
.md-typeset .zapier-release-meta strong {
1035+
color: var(--md-default-fg-color--light);
1036+
font-weight: 600;
1037+
}
1038+
1039+
.md-typeset .zapier-release > :last-child {
1040+
margin-bottom: 0;
1041+
}
1042+
1043+
[data-md-color-scheme="slate"] .md-typeset .zapier-release {
1044+
border-top-color: rgba(255, 255, 255, 0.18);
1045+
}
1046+
1047+
[data-md-color-scheme="slate"] .md-typeset .zapier-release-meta {
1048+
color: rgba(255, 255, 255, 0.82);
1049+
}
1050+
1051+
[data-md-color-scheme="slate"] .md-typeset .zapier-release-meta strong {
1052+
color: rgba(255, 255, 255, 0.82);
1053+
}

‎docs/zapier/ace-processed-recording.md‎

Lines changed: 183 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,183 @@
1+
---
2+
hide:
3+
- path
4+
- toc
5+
---
6+
7+
# ACE Processed Recording
8+
9+
## Overview
10+
11+
Use this instant trigger when ACE (formerly RingSense) finishes processing a call recording and produces transcript, summary, and insight data. The trigger fires from the ACE insights webhook and returns formatted fields that are ready to map into later Zap steps.
12+
13+
This trigger is designed for workflows that need AI-generated conversation output, such as saving transcripts, routing follow-up tasks, sending summaries to a CRM, or storing sentiment and next-step data.
14+
15+
## Requirements
16+
17+
The connected RingCentral account needs an ACE license (formerly RingSense) with access to processed recording insights.
18+
19+
!!! note "Feature Warning"
20+
During Zap setup, warning messages are displayed if the connected account is missing the required ACE license or features. Some setup messages may still use the former RingSense name.
21+
22+
## Configure
23+
24+
1. **Duration Unit**: Choose the unit for the `Recording Duration` output field.
25+
26+
- **Milliseconds**: Keeps the duration closest to the original ACE event value.
27+
- **Seconds**: Useful for most workflow calculations.
28+
- **Minutes**: Useful for reports and summaries.
29+
- **Hours**: Useful for long-call reporting.
30+
31+
![Duration Unit](./img/ace-input-duration-unit.png){style="max-width: 796px; width: 100%; height: auto;"}
32+
33+
2. **Time Format**: Choose how formatted durations and transcript timestamps are displayed.
34+
35+
- **HH:MM:SS**: Shows hours, minutes, and seconds.
36+
- **HH:MM**: Shows hours and minutes only.
37+
38+
![Time Format](./img/ace-input-time-format.png){style="max-width: 787px; width: 100%; height: auto;"}
39+
40+
3. **Format**: Choose how transcript, summary, and insight text should be formatted.
41+
42+
- **Multi Line**: Easier for people to read in emails, notes, tasks, and documents.
43+
- **Single Line**: Easier for conditional steps, Looping by Zapier, spreadsheets, or apps that expect one item per line.
44+
45+
![Format](./img/ace-input-format.png){style="max-width: 790px; width: 100%; height: auto;"}
46+
47+
4. **Include recording file outputs** (Optional): Turn this on only when the Zap needs the actual call recording file or recording metadata.
48+
49+
When enabled, the trigger fetches recording metadata and exposes:
50+
51+
- **Recording URI**
52+
- **Recording Content URI**
53+
- **Recording Content Type**
54+
- **Recording File**
55+
56+
Leave this off when the Zap only needs transcript, summary, sentiment, next steps, or other insight fields. Keeping it off avoids extra RingCentral API calls.
57+
58+
![Include Recording File Outputs](./img/ace-input-recording-file.png){style="max-width: 424px; width: 100%; height: auto;"}
59+
60+
5. **Generate text file output** (Optional): Turn this on when the Zap needs one downloadable `.txt` file with selected insight sections.
61+
62+
![Generate Text File Output](./img/ace-input-text-file.png){style="max-width: 481px; width: 100%; height: auto;"}
63+
64+
The text file can include:
65+
66+
- Summary
67+
- Bulleted summary
68+
- Transcript
69+
- Next steps
70+
- Highlights
71+
- Call notes
72+
- Sentiment
73+
- AI score
74+
- Speaker list
75+
76+
![Text File Section Inclusions](./img/ace-input-text-inclusions.png){style="max-width: 418px; width: 100%; height: auto;"}
77+
78+
Choose **Formatted** for section titles and dividers, or **Plain text only** when a downstream app needs minimal text without headings.
79+
80+
![Text File Layout](./img/ace-input-file-layout.png){style="max-width: 769px; width: 100%; height: auto;"}
81+
82+
!!! tip "When to Enable Optional Files"
83+
Leave optional file outputs off unless a later Zap step needs a file field. Turn on **Include recording file outputs** for the call audio file, and turn on **Generate text file output** for one combined transcript and insights text file.
84+
85+
## Output
86+
87+
The trigger includes identifiers, timing fields, participants, insight text, and raw event data.
88+
89+
### Recording and Call Fields
90+
91+
- **ID**: The source recording record ID.
92+
- **Event Type**: The ACE event type, such as `Create`.
93+
- **Title**: Title generated for the processed recording.
94+
- **Domain**: ACE domain, typically `pbx`.
95+
- **ACE URI**: URI for the ACE record.
96+
- **Source Session ID**: Source call session ID.
97+
- **Source Record ID**: Source recording record ID.
98+
- **Call Direction**: Direction of the call, such as inbound or outbound.
99+
- **Owner Extension ID**: RingCentral extension ID associated with the recording owner.
100+
- **Recording Duration (ms)**: Original recording duration in milliseconds.
101+
- **Recording Duration**: Duration converted to the selected **Duration Unit**.
102+
- **Recording Duration Formatted**: Duration formatted according to **Time Format**.
103+
- **Recording Start Time**: Date and time when the recording started.
104+
- **Creation Time**: Date and time when ACE created the insight record.
105+
- **Last Modified Time**: Date and time when ACE last modified the insight record.
106+
107+
### Optional Recording File Fields
108+
109+
These fields are populated only when **Include recording file outputs** is enabled and the recording is available:
110+
111+
- **Recording URI**: RingCentral API URI for recording metadata.
112+
- **Recording Content URI**: URI used to download the recording content.
113+
- **Recording Content Type**: MIME type for the recording file.
114+
- **Recording File**: Downloadable recording file for later Zap steps.
115+
116+
### Insight Fields
117+
118+
- **Transcript**: Formatted transcript text.
119+
- **Summary**: ACE-generated call summary.
120+
- **Highlights**: Formatted highlights text.
121+
- **Highlights List**: Highlights as a list of individual items.
122+
- **Next Steps**: Formatted next steps text.
123+
- **Next Steps List**: Next steps as a list of individual items.
124+
- **Speaker Info**: Formatted speaker list.
125+
- **Host Name**: Name of the host or owner-side participant, when identified.
126+
- **Host Phone Number**: Phone number for the host or owner-side participant, when identified.
127+
- **Customer Names**: Customer-side participant names, when identified.
128+
- **Customer Phone Numbers**: Customer-side participant phone numbers, when identified.
129+
- **Bulleted Summary List**: Summary bullets as a list of individual items.
130+
- **Event Origin**: Origin of the event. This trigger processes recording-origin events.
131+
- **Call Notes**: ACE call notes, when available.
132+
- **Sentiment**: ACE sentiment value, when available.
133+
- **Raw**: Raw ACE event JSON.
134+
135+
### Combined Text File
136+
137+
- **Combined Insights (Text File)**: A downloadable `.txt` file containing the selected insight sections. This field is populated when **Generate text file output** is enabled.
138+
139+
## Sample Output
140+
141+
```json
142+
{
143+
"id": "recording-1758068132637",
144+
"eventType": "Create",
145+
"title": "Call from John Doe to Jane Doe",
146+
"domain": "pbx",
147+
"ringsenseUri": "https://api-rcapps.ringcentral.com/ai/ringsense/v1/accounts/~/domains/pbx/recordings/recording-1758068132637",
148+
"sourceSessionId": "session-1758068132637",
149+
"sourceRecordId": "recording-1758068132637",
150+
"callDirection": "Outbound",
151+
"ownerExtensionId": "extension-1758068132637",
152+
"recordingDurationMs": 60000,
153+
"recordingDuration": 60,
154+
"recordingDurationFormatted": "00:01:00",
155+
"recordingStartTime": "2025-09-17T00:14:32.637Z",
156+
"creationTime": "2025-09-17T00:16:32.637Z",
157+
"lastModifiedTime": "2025-09-17T00:17:32.637Z",
158+
"transcript": "John Doe (+18883770028) | 00:00:05\nThanks for calling today.",
159+
"summary": "The customer asked about next steps and pricing.",
160+
"highlights": "Jane Doe (+16508783254) | 00:00:20\nRequested a follow-up email.",
161+
"highlightsList": ["Jane Doe (+16508783254) | 00:00:20\nRequested a follow-up email."],
162+
"nextSteps": "John Doe (+18883770028) | 00:00:45\nSend pricing details.",
163+
"nextStepsList": ["John Doe (+18883770028) | 00:00:45\nSend pricing details."],
164+
"speakerInfo": "John Doe (+18883770028)\nJane Doe (+16508783254)",
165+
"hostName": "John Doe",
166+
"hostPhoneNumber": "+18883770028",
167+
"customerNames": ["Jane Doe"],
168+
"customerPhoneNumbers": ["+16508783254"],
169+
"bulletedSummaryList": ["Customer asked about pricing."],
170+
"eventOrigin": "Recording",
171+
"callNotes": "Sample call note.",
172+
"sentiment": "Positive",
173+
"recordingUri": "https://api-rcapps.ringcentral.com/restapi/v1.0/account/400371259008/recording/recording-1758068132637",
174+
"recordingContentUri": "https://api-rcapps.ringcentral.com/restapi/v1.0/account/400371259008/recording/recording-1758068132637/content",
175+
"recordingContentType": "audio/mpeg",
176+
"recordingFile": "Sample Recording File",
177+
"insightsTextFile": "Sample Combined Insights Text File",
178+
"raw": "{\"event\":\"/ai/ringsense/v1/public/accounts/~/domains/pbx/insights\",\"body\":{\"eventType\":\"Create\"}}"
179+
}
180+
```
181+
182+
!!! info "Output Variations"
183+
Optional recording file fields are only populated when **Include recording file outputs** is enabled and the file is available. **Combined Insights (Text File)** is only populated when **Generate text file output** is enabled. Some insight fields may be empty if ACE did not produce that section for the recording.

0 commit comments

Comments
 (0)