Get Session Reports with Zoho Assist API on New Outgoing SMS from Bandwidth API

Pipedream makes it easy to connect APIs for Zoho Assist, Bandwidth and 2,700+ other apps remarkably fast.

Trigger workflow on

New Outgoing SMS from the Bandwidth API

Next, do this

Get Session Reports with the Zoho Assist 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 Bandwidth trigger and Zoho Assist action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Outgoing SMS trigger
1. Connect your Bandwidth account
Configure the Get Session Reports action
1. Connect your Zoho Assist account
2. Select a Type
3. Configure From Date
4. Configure To Date
5. Optional- Configure Email
6. Optional- Configure Index
7. Optional- Configure Count
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 Outgoing SMS on Bandwidth

Description:Emits an event each time an outbound message status event is received at the source url

Version:1.1.1

Key:bandwidth-new-outgoing-sms

View on GitHub

Bandwidth Overview#

The Bandwidth API opens up a world of possibilities for integrating telecom services into your applications. Bandwidth specializes in voice, messaging, and 911 access, making it possible to programmatically send and receive text messages, orchestrate calls, and implement emergency call routing. Linking the Bandwidth API with Pipedream allows you to automate these telecom features with various triggers and actions from other apps, creating seamless and powerful workflows.

Trigger Code#

const bandwidth = require("../../bandwidth.app");

module.exports = {
  name: "New Outgoing SMS",
  description:
    "Emits an event each time an outbound message status event is received at the source url",
  key: "bandwidth-new-outgoing-sms",
  version: "1.1.1",
  type: "source",
  props: {
    bandwidth,
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
  },

  async run(event) {
    const messageBody = event.body[0];
    this.http.respond({
      status: 204,
    });

    if (messageBody.message.direction == "out") {
      this.$emit(messageBody, {
        summary: messageBody.type,
        id: messageBody.message.id,
        ts: +new Date(messageBody.time),
      });
    }
  },
};

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
Bandwidth	`bandwidth`	`app`	This component uses the Bandwidth app.
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.

Trigger Authentication#

Bandwidth uses API keys for authentication. When you connect your Bandwidth account, Pipedream securely stores the keys so you can easily authenticate to Bandwidth APIs in both code and no-code steps.

Bandwidth.com requires the user's username:password pair to be encoded as part of the header. (docs)
The accountId is used as part of the url to make API requests. Ex: https://dashboard.bandwidth.com/api/accounts/{accountId}/

About Bandwidth#

Enterprise Grade Voice, Messaging, and 911 Access

Action#

Get Session Reports on Zoho Assist

Description:Fetch the reports of previously conducted sessions. [See the documentation](https://www.zoho.com/assist/api/getsessionreports.html)

Version:0.0.1

Key:zoho_assist-get-session-reports

View on GitHub

Zoho Assist Overview#

The Zoho Assist API provides remote support and access functionalities, enabling automated session management, customer support, and IT operations. By integrating it with Pipedream, you can craft serverless workflows that respond to various triggers and perform actions like creating support sessions, fetching session details, or managing users. The API's versatility in Pipedream allows for streamlined coordination between support requests and responses, facilitating seamless IT support and management tasks.

Action Code#

import { defineAction } from "@pipedream/types";
import app from "../../app/zoho_assist.app.mjs";
import { GET_SESSION_REPORTS_TYPE_OPTIONS } from "../../common/constants.mjs";
import { getValidDate } from "../../common/methods.mjs";
export default defineAction({
    name: "Get Session Reports",
    description: "Fetch the reports of previously conducted sessions. [See the documentation](https://www.zoho.com/assist/api/getsessionreports.html)",
    key: "zoho_assist-get-session-reports",
    version: "0.0.1",
    type: "action",
    props: {
        app,
        type: {
            propDefinition: [
                app,
                "type",
            ],
            options: GET_SESSION_REPORTS_TYPE_OPTIONS,
        },
        fromDate: {
            propDefinition: [
                app,
                "date",
            ],
            label: "From Date",
        },
        toDate: {
            propDefinition: [
                app,
                "date",
            ],
            label: "To Date",
        },
        email: {
            type: "string",
            label: "Email",
            description: "To fetch reports conducted by specific technician.",
            optional: true,
        },
        index: {
            type: "string",
            label: "Index",
            description: "Index of the record.",
            optional: true,
        },
        count: {
            type: "integer",
            label: "Count",
            description: "Number of rows per page.",
            optional: true,
        },
    },
    methods: {
        getValidDate,
    },
    async run({ $ }) {
        const { type, fromDate, toDate, email, index, count, } = this;
        const params = {
            $,
            params: {
                type,
                fromdate: this.getValidDate(fromDate, true),
                todate: this.getValidDate(toDate, true),
                email,
                index,
                count,
            },
        };
        const { representation } = await this.app.getSessionReports(params);
        $.export("$summary", `Successfully fetched ${representation.length} session reports`);
        return representation;
    },
});

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
Zoho Assist	`app`	`app`	This component uses the Zoho Assist app.
Type	`type`	`string`	Select a value from the drop down menu:`{ "label": "Remote Support", "value": "rs" }{ "label": "Unattended Remote Support", "value": "URS" }{ "label": "All", "value": "all" }`
From Date	`fromDate`	`string`	Timestamp in ISO 8601 format
To Date	`toDate`	`string`	Timestamp in ISO 8601 format
Email	`email`	`string`	To fetch reports conducted by specific technician.
Index	`index`	`string`	Index of the record.
Count	`count`	`integer`	Number of rows per page.

Action Authentication#

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

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

ZohoAssist.sessionapi.ALLZohoAssist.userapi.READZohoAssist.reportapi.READ