Send SMS with RingCentral API on New Requests (Payload Only) from HTTP / Webhook API

Pipedream makes it easy to connect APIs for RingCentral, HTTP / Webhook and 1200+ other apps remarkably fast.

Trigger workflow on

New Requests (Payload Only) from the HTTP / Webhook API

Next, do this

Send SMS with the RingCentral API

No credit card required

▶

Watch us build a workflow

7 min

Watch now ➜

Trusted by 500,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a HTTP / Webhook trigger and RingCentral action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Requests (Payload Only) trigger
1. Connect your HTTP / Webhook account
Configure the Send SMS action
1. Connect your RingCentral account
2. Configure Account ID
3. Select one or more Extensions
4. Configure Phone Number
5. Configure To Phone Numbers
6. Configure text
7. Optional- Select a Country ID
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

New Requests (Payload Only) on HTTP / Webhook

Description:Get a URL and emit the HTTP body as an event on every request

Version:0.1.1

Key:http-new-requests-payload-only

View on GitHub

Trigger Code#

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

// Core HTTP component
// Returns a 200 OK response, emits the HTTP payload as an event
export default {
  key: "http-new-requests-payload-only",
  name: "New Requests (Payload Only)",
  // eslint-disable-next-line
  description: "Get a URL and emit the HTTP body as an event on every request",
  version: "0.1.1",
  type: "source",
  props: {
    // eslint-disable-next-line
    httpInterface: {
      type: "$.interface.http",
      customResponse: true,
    },
    http,
  },
  async run(event) {
    const { body } = event;
    this.httpInterface.respond({
      status: 200,
      body,
    });
    // Emit the HTTP payload
    this.$emit({
      body,
    });
  },
};

Trigger 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.

Label	Prop	Type	Description
N/A	`httpInterface`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
HTTP / Webhook	`http`	`app`	This component uses the HTTP / Webhook app.

Trigger Authentication#

The HTTP / Webhook API does not require authentication.

About HTTP / Webhook#

Get a unique URL where you can send HTTP or webhook requests

Action#

Send SMS on RingCentral

Description:Creates and sends a new text message. See the API docs [here](https://developers.ringcentral.com/api-reference/SMS/createSMSMessage)

Version:0.5.1

Key:ringcentral-send-sms

View on GitHub

RingCentral Overview#

RingCentral API is a powerful tool that allows users to build applications and
solutions that make communication easier and more convenient. With RingCentral
API, developers can build communication solutions that include voice and video,
SMS/MMS, Fax, and other features.

With RingCentral API, developers can build:

Voice and Video calls with advanced interactions, such as ringback tones,
call screening, call forwarding, call recording and conference calling.
Rich messaging applications leveraging SMS, MMS, and chat functionality.
Fax solutions, such as sending and receiving faxes through a web application.
Presence and availability services, allowing users to set their status and
view the status of other users.
Automated voice solutions such as voice recognition, voice menus and more.
Voice analytics and call quality monitoring.
Contact center solutions with the ability to monitor and manage queues.

Action Code#

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

export default {
  key: "ringcentral-send-sms",
  name: "Send SMS",
  description: "Creates and sends a new text message. See the API docs [here](https://developers.ringcentral.com/api-reference/SMS/createSMSMessage)",
  version: "0.5.1",
  type: "action",
  props: {
    ringcentral,
    accountId: {
      propDefinition: [
        ringcentral,
        "accountId",
      ],
    },
    extensionId: {
      propDefinition: [
        ringcentral,
        "extensionId",
      ],
      description: "Internal identifier of an extension.",
    },
    fromPhoneNumber: {
      type: "string",
      label: "Phone Number",
      description: "The phoneNumber for the sender of an SMS message. Property must be filled to correspond to one of the account phone numbers which is allowed to send SMS. Phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164#Numbering_formats) e.g. `+16502223366`.",
    },
    toPhoneNumbers: {
      type: "string[]",
      label: "To Phone Numbers",
      description: "Phone number of receiver(s) of an SMS message. Phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164#Numbering_formats) e.g. `+16502223366`.",
    },
    text: {
      type: "string",
      description: "Text of a message. Max length is 1000 symbols (2-byte [UTF-16](https://en.wikipedia.org/wiki/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.",
    },
    countryId: {
      propDefinition: [
        ringcentral,
        "countryId",
      ],
    },
  },
  async run({ $ }) {
    const {
      accountId,
      extensionId,
      fromPhoneNumber,
      text,
      countryId,
    } = this;

    const toPhoneNumbers = utils.parse(this.toPhoneNumbers);
    const to = toPhoneNumbers.map((phoneNumber) => ({
      phoneNumber,
    }));

    const response =
      await this.ringcentral.sendSMS({
        $,
        accountId,
        extensionId,
        data: {
          from: {
            phoneNumber: fromPhoneNumber,
          },
          to,
          text,
          country: utils.emptyObjectToUndefined({
            id: countryId,
          }),
        },
      });

    $.export("$summary", `Successfully sent SMS with ID ${response.id}`);

    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
RingCentral	`ringcentral`	`app`	This component uses the RingCentral app.
Account ID	`accountId`	`string`	Internal identifier of a RingCentral account or tilde (`~`) to indicate the account logged-in within the current session.
Extensions	`extensionId`	`string[]`	Select a value from the drop down menu.
Phone Number	`fromPhoneNumber`	`string`	The phoneNumber for the sender of an SMS message. Property must be filled to correspond to one of the account phone numbers which is allowed to send SMS. Phone number in E.164 format e.g. `+16502223366`.
To Phone Numbers	`toPhoneNumbers`	`string[]`	Phone number of receiver(s) of an SMS message. Phone number in E.164 format e.g. `+16502223366`.
text	`text`	`string`	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.
Country ID	`countryId`	`string`	Select a value from the drop down menu.

Action 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

More Ways to Connect RingCentral + HTTP / Webhook#

Other Popular Integrations#

Create Meeting with Ringcentral API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + RingCentral

Send SMS with RingCentral API on New Requests (Payload Only) from HTTP / Webhook API

Pipedream makes it easy to connect APIs for RingCentral, HTTP / Webhook and 1200+ other apps remarkably fast.

Trusted by 500,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-12of1200+apps by most popular

1
-
12
of
1200+
apps by most popular