Score Scripted Recording with Speechace API on Meeting Started from Zoom Admin API

Pipedream makes it easy to connect APIs for Speechace, Zoom Admin and 2,700+ other apps remarkably fast.

Trigger workflow on

Meeting Started from the Zoom Admin API

Next, do this

Score Scripted Recording with the Speechace API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

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

Select this integration
Configure the Meeting Started trigger
1. Connect your Zoom Admin account
2. Configure zoomApphook
Configure the Score Scripted Recording action
1. Connect your Speechace account
2. Configure File Path or URL
3. Configure Text
4. Optional- Configure Question Info
5. Optional- Select a Dialect
6. Optional- Configure User ID
7. Optional- Configure syncDir
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#

Meeting Started on Zoom Admin

Description:Emits an event each time a meeting starts in your Zoom account

Version:0.1.6

Key:zoom_admin-meeting-started

View on GitHub

Zoom Admin Overview#

The Zoom Admin API lets you harness the extensive capabilities of Zoom for automation and integration, right within Pipedream. Automate user management, track Zoom rooms, monitor webinars and meetings, and customize your workflow to respond dynamically to events like new participants or ended meetings. With these APIs and the power of Pipedream, you can streamline administrative tasks, extract valuable insights, and sync Zoom activities with other services.

Trigger Code#

import { v4 as uuidv4 } from "uuid";
import zoomAdmin from "../../zoom_admin.app.mjs";

export default {
  key: "zoom_admin-meeting-started",
  type: "source",
  name: "Meeting Started",
  description: "Emits an event each time a meeting starts in your Zoom account",
  version: "0.1.6",
  dedupe: "unique", // Dedupe based on meeting ID
  props: {
    zoomAdmin,
    zoomApphook: {
      type: "$.interface.apphook",
      appProp: "zoomAdmin",
      eventNames: [
        "meeting.started",
      ],
    },
  },
  async run(event) {
    const { payload } = event;
    this.$emit(event, {
      summary: payload?.object?.topic
        ? `Meeting ${payload?.object?.topic} started`
        : "Meeting started",
      id: payload?.object?.uuid ?? uuidv4(),
      ts: payload?.object?.start_time
        ? +new Date(payload.object.start_time)
        : new Date(),
    });
  },
};

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
Zoom Admin	`zoomAdmin`	`app`	This component uses the Zoom Admin app.
	`zoomApphook`	`$.interface.apphook`

Trigger Authentication#

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

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

About Zoom Admin#

Video conferencing (includes account-level scopes) for Zoom Admins.

Action#

Score Scripted Recording on Speechace

Description:Scores a scripted recording based on fluency and pronunciation. [See the documentation](https://docs.speechace.com/#c34b11dd-8172-441a-bc27-223339d48d8e)

Version:0.0.3

Key:speechace-score-scripted-recording

View on GitHub

Speechace Overview#

The Speechace API offers capabilities for detailed speech analysis, particularly useful for language learning applications. With this API, you can assess users' pronunciation and fluency in English by analyzing audio inputs. In Pipedream, you can leverage this API to craft workflows that trigger on various events, process audio data, and perform actions based on the analysis—such as storing results, providing feedback, or integrating with other services for enhanced functionality.

Action Code#

import speechace from "../../speechace.app.mjs";
import FormData from "form-data";
import {
  getFileStreamAndMetadata, ConfigurationError,
} from "@pipedream/platform";

export default {
  key: "speechace-score-scripted-recording",
  name: "Score Scripted Recording",
  description: "Scores a scripted recording based on fluency and pronunciation. [See the documentation](https://docs.speechace.com/#c34b11dd-8172-441a-bc27-223339d48d8e)",
  version: "0.0.3",
  type: "action",
  props: {
    speechace,
    filePath: {
      propDefinition: [
        speechace,
        "filePath",
      ],
    },
    text: {
      type: "string",
      label: "Text",
      description: "A word, phrase, or sentence to score",
    },
    questionInfo: {
      type: "string",
      label: "Question Info",
      description: "A unique identifier for the activity or question this user audio is answering",
      optional: true,
    },
    dialect: {
      propDefinition: [
        speechace,
        "dialect",
      ],
    },
    userId: {
      propDefinition: [
        speechace,
        "userId",
      ],
    },
    syncDir: {
      type: "dir",
      accessMode: "read",
      sync: true,
      optional: true,
    },
  },
  async run({ $ }) {
    const data = new FormData();
    const {
      stream, metadata,
    } = await getFileStreamAndMetadata(this.filePath);
    data.append("user_audio_file", stream, {
      contentType: metadata.contentType,
      knownLength: metadata.size,
      filename: metadata.name,
    });
    if (this.text) {
      data.append("text", this.text);
    }
    if (this.questionInfo) {
      data.append("question_info", this.questionInfo);
    }

    const response = await this.speechace.scoreScript({
      $,
      params: {
        dialect: this.dialect,
        user_id: this.userId,
      },
      data,
      headers: data.getHeaders(),
    });
    if (response.status === "error") {
      throw new ConfigurationError(response.detail_message);
    }
    $.export("$summary", `Scored scripted recording for audio file: ${this.filePath}`);
    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
Speechace	`speechace`	`app`	This component uses the Speechace app.
File Path or URL	`filePath`	`string`	Provide either a file URL or a path to a file in the /tmp directory (for example, /tmp/myFile.pdf).
Text	`text`	`string`	A word, phrase, or sentence to score
Question Info	`questionInfo`	`string`	A unique identifier for the activity or question this user audio is answering
Dialect	`dialect`	`string`	Select a value from the drop down menu:`{ "label": "US English", "value": "en-us" }{ "label": "UK English", "value": "en-gb" }`
User ID	`userId`	`string`	A unique anonymized identifier for the end-user who spoke the audio
syncDir	`syncDir`	`dir`

Score Scripted Recording with Speechace API on Meeting Started from Zoom Admin API

Pipedream makes it easy to connect APIs for Speechace, Zoom Admin and 2,700+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,700+apps by most popular

1
-
24
of
2,700+
apps by most popular