> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/plivo.md).

# Plivo

Connect to Plivo to place voice calls, look up phone numbers, and inspect your message and call history.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Plivo     | Credentials    |

#### Plivo

Connect to Plivo, a cloud communications platform, using your Auth ID and Auth Token to place voice calls, look up phone numbers, and inspect your message and call history.

**Set up in Plivo**

1. Prepare the Plivo account or service that the workflow will access. Grant access to the required resources and operations.
2. **Auth ID:** Your Plivo Auth ID from the overview page of the Plivo console. It starts with 'MA' for a main account or 'SA' for a subaccount.
3. **Auth Token:** Your Plivo Auth Token, shown next to the Auth ID in the Plivo console.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Plivo**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                                                                                   |
| ------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Auth ID       | Yes      | Your Plivo Auth ID from the overview page of the Plivo console. It starts with 'MA' for a main account or 'SA' for a subaccount. [Provider instructions](https://console.plivo.com/dashboard/). |
| Auth Token    | Yes      | Your Plivo Auth Token, shown next to the Auth ID in the Plivo console. [Provider instructions](https://console.plivo.com/dashboard/).                                                           |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Plivo** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Lookup Number

Look up formatting and carrier details for a phone number with Plivo.

**Inputs**

| Field                | Type    | Required | Description                                                                     |
| -------------------- | ------- | -------- | ------------------------------------------------------------------------------- |
| Phone Number         | string  | Yes      | The phone number to look up.                                                    |
| Include Carrier Info | boolean | No       | Whether to include carrier details (may incur an extra charge). Default: false. |

**Outputs**

| Field        | Type   | Description                                                           |
| ------------ | ------ | --------------------------------------------------------------------- |
| Phone Number | string | The looked-up phone number in E.164 format.                           |
| Country      | object | Country details for the number.                                       |
| Carrier      | object | Carrier details for the number (only when carrier info is requested). |
| Format       | object | Formatting variants of the number (national, international, E.164).   |

#### Place Call

Place an outbound voice call through Plivo.

**Inputs**

| Field         | Type   | Required | Description                                                          |
| ------------- | ------ | -------- | -------------------------------------------------------------------- |
| From          | string | Yes      | The Plivo phone number to place the call from (caller ID).           |
| To            | string | Yes      | The destination phone number to call.                                |
| Answer URL    | string | Yes      | A publicly reachable URL that returns Plivo XML to control the call. |
| Answer Method | string | No       | The HTTP method Plivo uses to fetch the answer URL. Default: POST.   |

**Outputs**

| Field        | Type   | Description                                 |
| ------------ | ------ | ------------------------------------------- |
| Request UUID | string | The unique ID of the outbound call request. |
| API ID       | string | The Plivo API request ID.                   |
| Status       | string | The status message returned by Plivo.       |

#### List Messages

List SMS, MMS, and WhatsApp messages sent and received on the Plivo account, newest first.

**Inputs**

| Field     | Type    | Required | Description                                                                 |
| --------- | ------- | -------- | --------------------------------------------------------------------------- |
| Direction | string  | No       | Only return messages in this direction (inbound or outbound).               |
| State     | string  | No       | Only return messages in this delivery state.                                |
| Type      | string  | No       | Only return messages of this type (sms, mms, or whatsapp).                  |
| Limit     | integer | No       | Number of messages per page (1-20). Minimum: 1. Maximum: 20. Default: 20.   |
| Offset    | integer | No       | Number of messages to skip before the first result. Minimum: 0. Default: 0. |

**Outputs**

| Field    | Type          | Description                                           |
| -------- | ------------- | ----------------------------------------------------- |
| Messages | object\_array | The messages in the requested page, newest first.     |
| Has More | boolean       | Whether more messages are available beyond this page. |

#### Get Message

Fetch a message's details and delivery state from Plivo by its UUID.

**Inputs**

| Field        | Type   | Required | Description                       |
| ------------ | ------ | -------- | --------------------------------- |
| Message UUID | string | Yes      | The UUID of the message to fetch. |

**Outputs**

| Field        | Type    | Description                                    |
| ------------ | ------- | ---------------------------------------------- |
| Message UUID | string  | The unique ID of the message.                  |
| State        | string  | The delivery state of the message.             |
| Direction    | string  | Whether the message was sent or received.      |
| Type         | string  | The type of the message.                       |
| From         | string  | The sender phone number or sender ID.          |
| To           | string  | The recipient phone number.                    |
| Time         | string  | When the message was sent or received.         |
| Units        | integer | The number of message units (segments) billed. |
| Total Amount | string  | The total amount charged for the message.      |
| Error Code   | string  | The Plivo error code if delivery failed.       |

#### List Calls

List call detail records on the Plivo account, newest first, with optional filters.

**Inputs**

| Field     | Type    | Required | Description                                                  |
| --------- | ------- | -------- | ------------------------------------------------------------ |
| Direction | string  | No       | Only return calls in this direction.                         |
| From      | string  | No       | Only return calls placed from this number.                   |
| To        | string  | No       | Only return calls placed to this number.                     |
| Limit     | integer | No       | Number of calls to return per page (1-20). Default: 20.      |
| Offset    | integer | No       | Number of calls to skip before the first result. Default: 0. |

**Outputs**

| Field    | Type          | Description                                                 |
| -------- | ------------- | ----------------------------------------------------------- |
| Calls    | object\_array | The call detail records matching the filters, newest first. |
| Has More | boolean       | Whether more calls are available on the next page.          |

#### Get Call

Fetch the detail record of a Plivo call by its call UUID.

**Inputs**

| Field     | Type   | Required | Description                         |
| --------- | ------ | -------- | ----------------------------------- |
| Call UUID | string | Yes      | The unique ID of the call to fetch. |

**Outputs**

| Field           | Type    | Description                               |
| --------------- | ------- | ----------------------------------------- |
| Call UUID       | string  | The unique ID of the call.                |
| Direction       | string  | Whether the call was inbound or outbound. |
| From            | string  | The number the call was placed from.      |
| To              | string  | The number the call was placed to.        |
| Duration        | integer | The call duration in seconds.             |
| Billed Duration | integer | The billed duration in seconds.           |
| Total Amount    | string  | The total cost of the call.               |
| Initiated At    | string  | When the call was initiated.              |
| Answered At     | string  | When the call was answered.               |
| Ended At        | string  | When the call ended.                      |
| Hangup Cause    | string  | Why the call ended.                       |
| Hangup Source   | string  | Who ended the call.                       |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/plivo.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
