• Documentation >
• Apps >
• Communication >
• RingCentral

RingCentral

Getting Started with RingCentral

The RingCentral modules allow you to monitor SMS messages, voice messages, calls, and missed calls, and send messages, as well as list calls and messages or make ringout calls in your RingCentral account.

Prerequisites

• A RingCentral account

In order to use RingCentral with Ibexa Connect, it is necessary to have a RingCentral account. If you do not have one, you can create a RingCentral account at https://www.ringcentral.com/office/plansandpricing.html (paid plan)

Note

The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!

Connecting RingCentral to Ibexa Connect

To connect your RingCentral account to Ibexa Connect follow the general instructions for Connecting to services.

After you click the Continue button, Ibexa Connect will redirect you to the RingCentral website where you will be prompted to grant Ibexa Connect access to your account.

Confirm the dialog by clicking the Authorize button.

Calls

Watch Answered Calls

Triggers when a new incoming call has been picked up.

Webhook name	Enter the desired webhook name. E.g. Answered Call webhook

Watch Calls

Triggers when there is a new incoming or outgoing call.

Limit	Set the maximum number of calls Ibexa Connect will return during one cycle.

Watch Missed Calls

Triggers when a new missed call is received.

Webhook name	Enter the desired webhook name. E.g. Missed Call webhook

Get Call Details

Returns call log records by ID.

Call record ID

Enter (map) the call record ID.

View

Select whether you want to return the simple view or detailed view of the call log. Simple View: Type This indicates whether the log is a phone call or a fax message. It also shows the Direction of the Call (inbound or outbound). Phone Number This shows phone numbers of callers and recipients of the calls. Name Presents the name of the caller. Date/Time of Call Displays when and what time the call was made. Recording Reflects the recorded calls. Action Indicates the type of action performed. Result Shows the end result for the log. Length This reflects the duration of time between when the Caller calls and when the call is connected to the RingCentral system and not the duration of the call after it was answered. The length of time will still display even if the call was not answered. Quality Implies the reported quality of the call. Customize Columns Display columns and descriptions, which can be customized by checking the box beside every column. Detailed View: The detailed view includes all the simple view information with 4 additional columns for: Included This is the cost per minute used that is included in your RingCentral Plan. Purchased This is the cost per minute used that is not included in your RingCentral Plan, e.g. international calls. From Shows the originating phone number. To Displays the dialed phone number.

Make a Call

Makes a RingOut call.

From phone	Select the phone number (in E.164 format) you want to make a RingOut call from.
Forwarding phone	Enter the ID of the forwarding number. Can be specified instead of the phone number.
To phone	The phone number of the called party. This number corresponds to the 2nd leg of a RingOut call. Use E.164 format. E.g. +14155551234
Caller ID	Enter the number that will be displayed to the called party.
Play prompt	Select Yes to play the audio prompt that the calling party hears when the call is connected.
Country	The dialing plan country's data. If not specified, then the home country is applied by default.

List Calls

Lists all calls based on the specified filter settings.

Extension number	The extension number of a user. If specified, returns the call log for a particular extension only.
Show blocked	If set to Yes then calls from/to blocked numbers are returned.
Phone number	The phone number of a caller/callee. If specified, returns all calls (both incoming and outgoing) with the phone number specified.
Direction	The direction for the resulting records. If not specified, both inbound and outbound records are returned.
Session ID	The internal identifier of a session.
Type	The call type of a record. It is allowed to specify more than one type. If not specified, all call types are returned.
Transport	Call transport type. 'PSTN' specifies that a call leg is initiated from the PSTN network provider; 'VoIP' - from an RC phone. By default this filter is disabled.
View	The view of call records.
With Recording	Deprecated. Supported for compatibility reasons. True if only recorded calls are returned. If both withRecording and recordingType are specified, then withRecording is ignored
Recording type	The type of call recording. If not specified, then calls without recordings are also returned.
From	The start datetime for resulting records. ISO 8601 format including timezone, for example, 2016-03-10T18:07:52.534Z. Supported date formats.
To	The end datetime for resulting records. ISO 8601 format including timezone, for example, 2016-03-10T18:07:52.534Z. The default value is the current time. Supported date formats.
Show deleted	If the Yes option is selected then deleted calls are returned.
Limit	The maximum number of calls Ibexa Connect will return during one cycle.

Messages

Watch Voice Messages

Triggers when a new voice message is received.

Webhook name	Enter the desired webhook name. E.g. New Voice Message webhook

Watch Faxes

Triggers when a new fax is received.

Webhook name	Enter the desired webhook name. E.g. New Fax webhook

Watch Incoming SMS Messages

Triggers when a new incoming message is received and retrieves the SMS message details.

Webhook name	Enter the desired webhook name. E.g. New SMS message webhook

Get Message Details

Returns individual message details.

Message ID	Enter (map) the message ID of the message you want to retrieve details about.

List Messages

Availability	Specifies the availability status for the resulting messages.
Conversation ID	Specifies the conversation identifier for the resulting messages.
From	The start datetime for resulting messages. ISO 8601 format including timezone, for example, 2016-03-10T18:07:52.534Z. Supported date formats.
To	The end datetime for resulting messages. ISO 8601 format including timezone, for example, 2016-03-10T18:07:52.534Z. The default value is the current time. Supported date formats.
Direction	The direction for the resulting messages. If not specified, both inbound and outbound messages are returned.
Distinct conversations	If the Yes option is selected, then the latest messages per every conversation ID are returned.
Message type	The type of the resulting messages. If not specified, all messages without message type filtering are returned.
Read status	The read status for the resulting messages.
Phone number	The phone number. If specified, messages are returned for this particular phone number only.
Limit	The maximum number of messages Ibexa Connect will return during one cycle.

Send an SMS/MMS

Creates and sends a new SMS message. Sending SMS messages simultaneously to different recipients is limited up to 50 requests per minute; relevant for all client applications.

From phone	Select the phone number (in E.164 format) you want to send the SMS from.
To phone	Enter the receiver's phone number in E.164 format. E.g. +14155551234
Text	Enter the text of a message. Max length is 1000 symbols (2-byte UTF-16 encoded). If a character is encoded in 4 bytes in UTF-16 it is treated as 2 characters, thus restricting the maximum message length to 500 symbols

Watch Messages

Watches for new internal messages from an extension mailbox.

Limit	Set the maximum number of messages Ibexa Connect will return during one cycle.

Other

Remove Webhook

Deletes the webhook.

Webhook ID	Select or map the webhook you want to remove.

Make an API Call

Allows you to perform a custom API call.

URL

Enter a path relative to /restapi/v1.0 e.g. /restapi/v1.0/subscription OR full URL for attachment e.g. https://media.ringcentral.com/restapi/v1.0/account/2399830036/extension/2399830036/message-store/1041024330037/content/5486959037

For the list of available endpoints, refer to the RingCentral API Documentation.

Method

Select the HTTP method you want to use:

GET

to retrieve information for an entry.

POST

to create a new entry.

PUT

to update/replace an existing entry.

PATCH

to make a partial entry update.

DELETE

to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.