Chat with OpenAI (ChatGPT) API on New Inbound SMS (Instant) from RingCentral API

Pipedream makes it easy to connect APIs for OpenAI (ChatGPT), RingCentral and 1200+ other apps remarkably fast.

Trigger workflow on

New Inbound SMS (Instant) from the RingCentral API

Next, do this

Chat with the OpenAI (ChatGPT) 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 RingCentral trigger and OpenAI (ChatGPT) action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Inbound SMS (Instant) trigger
1. Connect your RingCentral account
2. Select one or more Extensions
Configure the Chat action
1. Connect your OpenAI (ChatGPT) account
2. Select a Model
3. Configure User Message
4. Optional- Configure System Instructions
5. Optional- Configure Prior Message History
6. Optional- Configure Max Tokens
7. Optional- Configure Temperature
8. Optional- Configure Top P
9. Optional- Configure N
10. Optional- Configure Stop
11. Optional- Configure Presence Penalty
12. Optional- Configure Frequency Penalty
13. Optional- Configure User
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 Inbound SMS (Instant) on RingCentral

Description:Emit new event on each incoming SMS

Version:0.1.5

Key:ringcentral-new-inbound-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.

Trigger Code#

import common from "../common/http-based.mjs";

export default {
  ...common,
  key: "ringcentral-new-inbound-sms",
  name: "New Inbound SMS (Instant)",
  description: "Emit new event on each incoming SMS",
  version: "0.1.5",
  type: "source",
  props: {
    ...common.props,
    extensionId: {
      propDefinition: [
        common.props.ringcentral,
        "extensionId",
      ],
    },
  },
  methods: {
    ...common.methods,
    getSupportedNotificationTypes() {
      return new Set([
        "ringcentral-instant-message-event",
      ]);
    },
    getPropValues() {
      return {
        extensionId: this.extensionId,
      };
    },
    generateMeta(data) {
      const {
        uuid: id,
        body: eventDetails,
        timestamp,
      } = data;
      const ts = Date.parse(timestamp);

      const { from: { phoneNumber: senderPhoneNumber } } = eventDetails;
      const maskedCallerNumber = this.getMaskedNumber(senderPhoneNumber);
      const summary = `New inbound SMS from ${maskedCallerNumber}`;

      return {
        id,
        summary,
        ts,
      };
    },
    isEventRelevant(event) {
      const { body: eventDetails } = event.body;
      const { messageStatus } = eventDetails;
      return messageStatus === "Received";
    },
  },
};

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
RingCentral	`ringcentral`	`app`	This component uses the RingCentral app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.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.
Extensions	`extensionId`	`string[]`	Select a value from the drop down menu.

Trigger 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

Action#

Chat on OpenAI (ChatGPT)

Description:The Chat API, using the `gpt-3.5-turbo` or `gpt-4` model. [See docs here](https://platform.openai.com/docs/api-reference/chat)

Version:0.1.2

Key:openai-chat

View on GitHub

OpenAI (ChatGPT) Overview#

The OpenAI API is a powerful tool that provides access to a range of
high-powered machine learning models. With the OpenAI API, developers can
create products, services, and tools that enable humanizing AI experiences, and
build applications that extend the power of human language.

Using the OpenAI API, developers can create language-driven applications such
as:

Natural language understanding and sentiment analysis
Text-based search
Question answering
Dialogue systems and conversation agents
Intelligent text completion
Text summarization
Text classification
Machine translation
Language generation
Multi-factor authentication
Anomaly detection
Text analysis

Action Code#

import openai from "../../app/openai.app.mjs";
import common from "../common/common.mjs";

export default {
  ...common,
  name: "Chat",
  version: "0.1.2",
  key: "openai-chat",
  description: "The Chat API, using the `gpt-3.5-turbo` or `gpt-4` model. [See docs here](https://platform.openai.com/docs/api-reference/chat)",
  type: "action",
  props: {
    openai,
    modelId: {
      propDefinition: [
        openai,
        "chatCompletionModelId",
      ],
    },
    userMessage: {
      label: "User Message",
      type: "string",
      description: "The user messages provide instructions to the assistant. They can be generated by the end users of an application, or set by a developer as an instruction.",
    },
    systemInstructions: {
      label: "System Instructions",
      type: "string",
      description: "The system message helps set the behavior of the assistant. For example: \"You are a helpful assistant.\" [See these docs](https://platform.openai.com/docs/guides/chat/instructing-chat-models) for tips on writing good instructions.",
      optional: true,
    },
    messages: {
      label: "Prior Message History",
      type: "string[]",
      description: "_Advanced_. Because [the models have no memory of past chat requests](https://platform.openai.com/docs/guides/chat/introduction), all relevant information must be supplied via the conversation. You can provide [an array of messages](https://platform.openai.com/docs/guides/chat/introduction) from prior conversations here. If this param is set, the action ignores the values passed to **System Instructions** and **Assistant Response**, appends the new **User Message** to the end of this array, and sends it to the API.",
      optional: true,
    },
    ...common.props,
  },
  async run({ $ }) {
    const args = this._getChatArgs();
    const response = await this.openai.createChatCompletion({
      $,
      args,
    });

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

    const { messages } = args;
    return {
      original_messages: messages,
      original_messages_with_assistant_response: messages.concat(response.choices[0]?.message),
      ...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
OpenAI (ChatGPT)	`openai`	`app`	This component uses the OpenAI (ChatGPT) app.
Model	`modelId`	`string`	Select a value from the drop down menu.
User Message	`userMessage`	`string`	The user messages provide instructions to the assistant. They can be generated by the end users of an application, or set by a developer as an instruction.
System Instructions	`systemInstructions`	`string`	The system message helps set the behavior of the assistant. For example: "You are a helpful assistant." See these docs for tips on writing good instructions.
Prior Message History	`messages`	`string[]`	Advanced. Because the models have no memory of past chat requests, all relevant information must be supplied via the conversation. You can provide an array of messages from prior conversations here. If this param is set, the action ignores the values passed to System Instructions and Assistant Response, appends the new User Message to the end of this array, and sends it to the API.
Max Tokens	`maxTokens`	`integer`	The maximum number of tokens to generate in the completion.
Temperature	`temperature`	`string`	Optional. What sampling temperature to use. Higher values means the model will take more risks. Try 0.9 for more creative applications, and 0 (argmax sampling) for ones with a well-defined answer.
Top P	`topP`	`string`	An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both.
N	`n`	`integer`	How many completions to generate for each prompt
Stop	`stop`	`string[]`	Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.
Presence Penalty	`presencePenalty`	`string`	Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.
Frequency Penalty	`frequencyPenalty`	`string`	Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.
User	`user`	`string`	A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more here.

Chat with OpenAI (ChatGPT) API on New Inbound SMS (Instant) from RingCentral API

Pipedream makes it easy to connect APIs for OpenAI (ChatGPT), RingCentral 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