Skip to content

Commit 841afa1

Browse files
committed
Merge branch 'feat/rcint-45496' into 'main'
feat(Zapier): [RCINT-45496] Add docs for New Call Log and New Cal Recording triggers See merge request integration/ringcentral-integration-docs!31
2 parents 46e03a9 + 32deacb commit 841afa1

16 files changed

Lines changed: 337 additions & 0 deletions

docs/zapier/call-log.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+
# Call Log
8+
9+
## Overview
10+
11+
Use this trigger to monitor and respond to new call log entries in your RingCentral account. This polling-based trigger checks for new call logs at regular intervals and triggers your Zap when new calls are detected.
12+
13+
The trigger simplifies call log data for easy use in Zapier workflows while also providing raw JSON output for advanced users who need access to additional fields. Administrative users can access company-wide call logs with appropriate permissions.
14+
15+
![Call Log Trigger](./img/call-log.png)
16+
17+
## Configure
18+
19+
1. **Call Log Type**: Choose between `User Call Log` and `Company Call Log`.
20+
21+
- **User Call Log**: Retrieves call logs for the connected user only
22+
- **Company Call Log**: Retrieves call logs for the entire company (requires `ReadAccountCallLog` permission or admin access)
23+
24+
Warning messages will be displayed if the required permissions are not met or if additional features like RingSense transcripts are unavailable.
25+
26+
![Company Call Log Warning](./img/call-log-company-warning.png)
27+
28+
2. **View**: Choose the level of detail for call log records. The default is `Simple` view.
29+
30+
- **Simple**: Provides basic call information
31+
- **Detailed**: Includes additional data fields (reflected in the raw output only)
32+
33+
![Simple View](./img/call-log-view.png)
34+
35+
3. **Phone Number Filter** (Optional): Filter calls by a specific phone number. Enter the phone number in E.164 format without the leading `+` (digits only, including country code). This will only include calls to or from the specified number. Leave blank to include all calls.
36+
37+
![Phone Number Filter](./img/call-log-phone-number.png)
38+
39+
4. **Extension Number Filter** (Optional): Filter calls by a specific extension number. This only includes internal calls between the specified extension and other extensions. Note that calls routed through PSTN (involving external phone numbers) will not appear with this filter. Leave blank to include all calls.
40+
41+
![Extension Number Filter](./img/call-log-extension-number.png)
42+
43+
5. **Call Direction Filter** (Optional): Filter calls by their direction.
44+
45+
- **Both** (default): Include calls in any direction
46+
- **Inbound**: Include only incoming calls
47+
- **Outbound**: Include only outgoing calls
48+
49+
![Call Direction Filter](./img/call-log-direction.png)
50+
51+
6. **Recording Type Filter** (Optional): Filter calls based on recording status.
52+
53+
- **Do Not Filter** (default): Include all calls regardless of recording status
54+
- **All**: Include only recorded calls (any recording type)
55+
- **Automatic**: Include only automatically recorded calls
56+
- **On Demand**: Include only manually recorded calls
57+
58+
![Call Recording Type Filter](./img/call-log-recording-type.png)
59+
60+
7. **Missed Calls Filter** (Optional): Filter calls based on whether they were missed.
61+
62+
- **All Calls** (default): Include all calls regardless of missed status
63+
- **Missed Calls Only**: Include only missed calls
64+
- **Exclude Missed Calls**: Include only calls that were answered
65+
66+
![Call Missed Filter](./img/call-log-missed.png)
67+
68+
8. **Call Results Filter** (Optional): Filter calls by their outcome or result. This is a multi-select field where you can choose specific call results from the dropdown menu (e.g., Call Connected, Voicemail, Busy, No Answer). Leave blank to include all call results.
69+
70+
![Call Results Filter](./img/call-log-result.png)
71+
72+
9. **Delay By** (Optional): Set a processing delay to ensure recording files are ready for download. There is typically a delay between when call log data becomes available and when recording files are fully processed. Choose a delay based on your average call length:
73+
74+
- **5 minutes**: For short calls
75+
- **15 minutes**: For typical business calls
76+
- **30 minutes**: For longer calls (recommended minimum)
77+
- **1-2 hours**: For very long calls or recordings
78+
79+
Most recordings are ready within 30 minutes, but longer delays may be needed for exceptionally long calls.
80+
81+
![Call Delay Time](./img/call-log-delay-by.png)
82+
83+
## Output
84+
85+
The Call Log trigger provides comprehensive information about each call log record. The output includes simplified fields optimized for Zapier workflows, plus a complete raw JSON response for advanced users requiring additional data.
86+
87+
### Basic Call Information
88+
89+
- **URI**: Unique URI identifier for the call log record
90+
- **ID**: Unique identifier for the call log record
91+
- **Session ID**: Session identifier for the call
92+
- **Telephony Session ID**: Telephony session identifier
93+
94+
### Call Details
95+
96+
- **Start Time**: Date and time when the call started (datetime format)
97+
- **Duration**: Call length in seconds
98+
- **Type**: Type of call (e.g., Voice, Fax)
99+
- **Direction**: Call direction (Inbound or Outbound)
100+
- **Action**: Action performed during the call
101+
- **Result**: Call outcome (e.g., Call Connected, Voicemail, Busy, No Answer)
102+
- **Transport**: Transport method used for the call
103+
104+
### Recording Information
105+
106+
When a call has been recorded, the following fields will be populated:
107+
108+
- **Recording ID**: Unique identifier for the call recording
109+
- **Recording URI**: API URI to access recording metadata
110+
- **Recording Content URI**: Direct URI to download the recording file
111+
- **Recording Type**: Type of recording (Automatic or On Demand)
112+
- **Recording Content Type**: MIME type of the recording file (e.g., audio/mpeg)
113+
- **Recording File**: Actual audio file attachment (available for download)
114+
- **Recording Player URL**: Shareable URL providing access to a web-based recording player
115+
116+
!!! note "Recording File Availability"
117+
Recording files may not be immediately available after a call ends. The system needs time to process and prepare the files. Use the "Delay By" option to ensure recording files are ready when your Zap triggers. Longer calls typically require more processing time.
118+
119+
!!! warning "Recording Player URL Access"
120+
The Recording Player URL requires recipients to have a RingCentral account and appropriate permissions to view the recording. This URL is only valid while the recording remains in the RingCentral system according to the [data retention policy](https://support.ringcentral.com/article-v2/RingCentral-data-retention-policies.html?brand=RingCentral&product=RingEX&language=en_US).
121+
122+
### Participant Information
123+
124+
The trigger provides detailed information about call participants:
125+
126+
#### To (Recipient) Information
127+
- **To Name**: Name of the person or entity being called
128+
- **To Phone Number**: Phone number of the recipient
129+
- **To Extension Number**: Extension number (for internal calls)
130+
- **To Location**: Geographic location information (when available)
131+
132+
#### From (Caller) Information
133+
- **From Name**: Name of the person initiating the call
134+
- **From Phone Number**: Phone number of the caller
135+
- **From Extension Number**: Extension number (for internal calls)
136+
- **From Location**: Geographic location information (when available)
137+
138+
### Transcript Information
139+
140+
- **Transcripts**: A text transcript of what was said during the call. This field is only available when call transcription is enabled and you have a RingSense license assigned.
141+
142+
!!! note "RingSense Transcript Requirements"
143+
To access call transcripts, the connected user extension requires the RingSense license assigned. For Company Call Log records, the individual user extensions that made the calls also need RingSense licenses assigned. If these requirements are not met, warning messages will be displayed during configuration.
144+
145+
### Raw Data
146+
147+
- **Raw**: Complete, unprocessed JSON response from the RingCentral API containing all available data for advanced users who need access to additional fields not included in the simplified output.
148+
149+
### Sample Output
150+
151+
```json
152+
{
153+
"id": "call-log-1758068132637",
154+
"sessionId": "session-1758068132637",
155+
"telephonySessionId": "telephony-session-1758068132637",
156+
"startTime": "2025-09-17T00:15:32.637Z",
157+
"duration": 1580,
158+
"type": "Voice",
159+
"direction": "Outbound",
160+
"action": "VoIP Call",
161+
"result": "Accepted",
162+
"transport": "PSTN",
163+
"from": "+1234567890 (John Doe)",
164+
"to": "+1234567891 (Jane Doe)",
165+
"toExtensionNumber": "No Data",
166+
"toName": "Jane Doe",
167+
"toPhoneNumber": "+1234567891",
168+
"fromExtensionNumber": "No Data",
169+
"fromName": "John Doe",
170+
"fromPhoneNumber": "+1234567890",
171+
"recordingId": "recording-1758068132637",
172+
"recordingUri": "https://api-rcapps.ringcentral.com/restapi/v1.0/account/account-1758068132637/recording/recording-1758068132637",
173+
"recordingContentUri": "https://api-rcapps.ringcentral.com/restapi/v1.0/account/account-1758068132637/recording/recording-1758068132637/content",
174+
"recordingType": "Automatic",
175+
"recordingContentType": "audio/mp3",
176+
"recordingFile": "Sample File",
177+
"transcript": "Sample Transcripts",
178+
"raw": "{\"uri\":\"https://api-rcapps.ringcentral.com/restapi/v1.0/account/~/extension/~/call-log/call-log-1758068132637\",\"id\":\"call-log-1758068132637\",\"sessionId\":\"session-1758068132637\",\"telephonySessionId\":\"telephony-session-1758068132637\",\"startTime\":\"2025-09-17T00:15:32.637Z\",\"duration\":1580,\"type\":\"Voice\",\"direction\":\"Outbound\",\"action\":\"VoIP Call\",\"result\":\"Accepted\",\"transport\":\"PSTN\",\"from\":{\"name\":\"John Doe\",\"phoneNumber\":\"+1234567890\",\"location\":\"Belmont, CA\"},\"to\":{\"name\":\"Jane Doe\",\"phoneNumber\":\"+1234567891\",\"location\":\"Belmont, CA\"},\"recording\":{\"id\":\"recording-1758068132637\",\"uri\":\"https://api-rcapps.ringcentral.com/restapi/v1.0/account/account-1758068132637/recording/recording-1758068132637\",\"type\":\"Automatic\",\"contentUri\":\"https://api-rcapps.ringcentral.com/restapi/v1.0/account/account-1758068132637/recording/recording-1758068132637/content\"},\"extension\":{\"uri\":\"https://api-rcapps.ringcentral.com/restapi/v1.0/account/~/extension/extension-1758068132637\",\"id\":\"extension-1758068132637\"}}"
179+
}
180+
```
181+
182+
!!! info "Output Variations"
183+
The output format may vary depending on the selected view (Simple or Detailed) and whether the call was recorded. Not all fields will be present for every call log record, depending on the call type and available data.
18.6 KB
Loading
81 KB
Loading
43.3 KB
Loading
33.6 KB
Loading
66.2 KB
Loading
30.9 KB
Loading
49.7 KB
Loading
58.8 KB
Loading

docs/zapier/img/call-log-view.png

61.4 KB
Loading

0 commit comments

Comments
 (0)