Query IP address with IP2Location API on New Conversation Started from Vapi API

Pipedream makes it easy to connect APIs for IP2Location, Vapi and 2,700+ other apps remarkably fast.

Trigger workflow on

New Conversation Started from the Vapi API

Next, do this

Query IP address with the IP2Location 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 Vapi trigger and IP2Location action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Conversation Started trigger
1. Connect your Vapi account
2. Configure timer
Configure the Query IP address action
1. Connect your IP2Location account
2. Configure IP Address
3. Select a Package
4. Optional- Select a Response Format
5. Optional- Select a Translation Language
6. Optional- Select one or more Addon
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 Conversation Started on Vapi

Description:Emit new event when a voicebot starts a conversation.

Version:0.0.1

Key:vapi-new-conversation

View on GitHub

Vapi Overview#

The Vapi API delivers voice automation capabilities, letting you build powerful voice response systems. With Vapi, you can automate calls, send voice messages, and create dynamic interactions through speech recognition and text-to-speech. Pipedream's serverless platform allows you to integrate Vapi's API with numerous other services to automate workflows, react to events, and orchestrate complex voice-enabled processes.

Trigger Code#

import common from "../common/base.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "vapi-new-conversation",
  name: "New Conversation Started",
  description: "Emit new event when a voicebot starts a conversation.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getFunction() {
      return this.vapi.listCalls;
    },
    getSummary(item) {
      return `New Conversation: ${item.id}`;
    },
  },
  sampleEmit,
};

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
Vapi	`vapi`	`app`	This component uses the Vapi app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

About Vapi#

Vapi is the platform to build, test and deploy voicebots in minutes rather than months.

Action#

Query IP address on IP2Location

Description:Query IP address using IP2Location API. [See the docs here](https://www.ip2location.com/web-service/ip2location) for how to use this API.

Version:0.0.2

Key:ip2location-query-ip-info

View on GitHub

IP2Location Overview#

The IP2Location API enables you to uncover valuable information about an IP address. With it, you can pinpoint a user's geographic location, such as country, region, city, and even latitude and longitude coordinates. This data is essential for various tasks like localizing content, analyzing traffic, or enhancing security by detecting potentially malicious activity. Using Pipedream, you can automate actions based on IP location data, integrating it with hundreds of other services without writing any code.

Action Code#

import ip2locationApp from "../../ip2location.app.mjs";
import constants from "../../common/constants.mjs";

export default {
  name: "Query IP address",
  description: "Query IP address using IP2Location API. [See the docs here](https://www.ip2location.com/web-service/ip2location) for how to use this API.",
  key: "ip2location-query-ip-info",
  version: "0.0.2",
  type: "action",
  props: {
    ip2locationApp,
    ipAddress: {
      type: "string",
      label: "IP Address",
      description: "IP address (IPv4 or IPv6) for reverse IP location lookup purposes.",
    },
    wsPackage: {
      type: "string",
      label: "Package",
      options: constants.PACKAGE_OPTIONS,
      description: "Web service package of different granularity of return information. Please refer to the pricing table in our [documentation](https://www.ip2location.com/web-service/ip2location) for the information returned.",
    },
    format: {
      type: "string",
      label: "Response Format",
      options: constants.FORMAT_OPTIONS,
      description: "Format of the response message. Available values are `json` or `xml`. If unspecified, json format will be used for the response message.",
      optional: true,
    },
    language: {
      type: "string",
      label: "Translation Language",
      options: constants.LANGUAGE_OPTIONS,
      description: "Translation information. The translation is only applicable for continent, country, region and city name for the **addon** package.",
      optional: true,
    },
    addon: {
      type: "string[]",
      label: "Addon",
      options: constants.ADDON_OPTIONS,
      description: "Extra information in addition to the above-selected package. Please refer to the pricing table in our [documentation](https://www.ip2location.com/web-service/ip2location) for the information returned. You can query for multiple addons by putting a comma at between of them, for example `continent,country`. Valid value: `continent`, `country`, `region`, `city`, `geotargeting`, `country_groupings`, `time_zone_info`",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      ipAddress,
      format,
      language,
      wsPackage,
      addon,
    } = this;
    var addon_formatted = "";
    for (let i = 0; i < addon.length; i++) {
      addon_formatted += addon[i] + ",";
    }
    const response =
      await this.ip2locationApp.queryIPInfo({
        $,
        params: {
          format: format ?? "json",
          language: language ?? "en",
          ip: ipAddress,
          package: wsPackage,
          addon: addon_formatted ?? "",
        },
      });
    $.export("$summary", "Successfully queried IP address information with IP2Location API.");
    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
IP2Location	`ip2locationApp`	`app`	This component uses the IP2Location app.
IP Address	`ipAddress`	`string`	IP address (IPv4 or IPv6) for reverse IP location lookup purposes.
Package	`wsPackage`	`string`	Select a value from the drop down menu:`WS1WS2WS3WS4WS5WS6WS7WS8WS9WS10WS11WS12WS13WS14WS15WS16WS17WS18WS19WS20WS21WS22WS23WS24WS25`
Response Format	`format`	`string`	Select a value from the drop down menu:`jsonxml`
Translation Language	`language`	`string`	Select a value from the drop down menu:`arcsdadeenesetfifrgaitjakomsnlptrusvtrvizh-cnzh-tw`
Addon	`addon`	`string[]`	Select a value from the drop down menu:`continentcountryregioncitygeotargetingcountry_groupingstime_zone_info`