← RingCentral

Make CallOut with RingCentral API

Pipedream makes it easy to connect APIs for RingCentral and 800+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Make CallOut with the RingCentral API
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

Create a workflow to Make CallOut with the RingCentral API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Make CallOut action
    1. Connect your RingCentral account
    2. Configure Account ID
    3. Select a Device
    4. Optional- Configure Phone Number
    5. Optional- Configure Extension Number
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Details

This is a pre-built, open source component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Make CallOut on RingCentral
Description:Creates a new outbound call out session. See the API docs [here](https://developers.ringcentral.com/api-reference/Call-Control/createCallOutCallSession)
Version:0.4.0
Key:ringcentral-make-callout

Code

import ringcentral from "../../ringcentral.app.mjs";

export default {
  key: "ringcentral-make-callout",
  name: "Make  CallOut",
  description: "Creates a new outbound call out session. See the API docs [here](https://developers.ringcentral.com/api-reference/Call-Control/createCallOutCallSession)",
  version: "0.4.0",
  type: "action",
  props: {
    ringcentral,
    accountId: {
      propDefinition: [
        ringcentral,
        "accountId",
      ],
    },
    deviceId: {
      propDefinition: [
        ringcentral,
        "deviceId",
      ],
      description: "Instance id of the caller. It corresponds to the 1st leg of the CallOut call.",
    },
    phoneNumber: {
      type: "string",
      label: "Phone Number",
      description: "Phone number of the called party. This number corresponds to the 2nd leg of a CallOut call. Phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164#Numbering_formats). e.g. `+16502223366`. If you set a **Phone Number** then don't set an **Extension Number**.",
      optional: true,
    },
    extensionNumber: {
      type: "string",
      label: "Extension Number",
      description: "Extension number of the called party. e.g. (`103`). If you set an **Extension Number** then don't set a **Phone Number**.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      accountId,
      deviceId,
      phoneNumber,
      extensionNumber,
    } = this;

    const response =
      await this.ringcentral.makeCallOut({
        $,
        accountId,
        data: {
          from: {
            deviceId,
          },
          to: {
            phoneNumber,
            extensionNumber,
          },
        },
      });

    $.export("$summary", `CallOut successfully created with ID ${response.id}`);

    return response;
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
RingCentralringcentralappThis component uses the RingCentral app.
Account IDaccountIdstring

Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session.

DevicedeviceIdstringSelect a value from the drop down menu.
Phone NumberphoneNumberstring

Phone number of the called party. This number corresponds to the 2nd leg of a CallOut call. Phone number in E.164 format. e.g. +16502223366. If you set a Phone Number then don't set an Extension Number.

Extension NumberextensionNumberstring

Extension number of the called party. e.g. (103). If you set an Extension Number then don't set a Phone Number.

Authentication

RingCentral uses OAuth authentication. When you connect your RingCentral account, Pipedream will open a popup window where you can sign into RingCentral and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any RingCentral API.

Pipedream requests the following authorization scopes when you connect your account:

About RingCentral

Business communications platform