> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Plivo

> Plivo provides programmable voice, messaging, phone number, SIP, verification, and communications APIs.

![Plivo logo](https://mintcdn.com/composio-preview/HvfZXDijhFOaKyF5/images/toolkits/plivo.svg?fit=max\&auto=format\&n=HvfZXDijhFOaKyF5\&q=85\&s=44f89a98c1535a50716e70f639ddfa65)

* **Category:** communication
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 6
* **Triggers:** 0
* **Slug:** `PLIVO`
* **Version:** 00000000\_00

## Tools

> [accordion] Get Account Details
>
> **Slug:** `PLIVO_GET_ACCOUNT_DETAILS`
>
> Return billing, credit, timezone, and account-type details for the connected Plivo account. Use this to inspect account status and configuration before querying communication resources.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Message
>
> **Slug:** `PLIVO_GET_MESSAGE`
>
> Retrieve one existing Plivo message by its message UUID, including delivery, routing, timing, error, and billing details when available.
>
> #### Input Parameters
>
> **message\_uuid** `string` *required*
>
> Plivo message UUID, typically obtained from List Messages or a send response.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Usage Summary
>
> **Slug:** `PLIVO_GET_USAGE_SUMMARY`
>
> Return one page of Plivo spend and usage grouped by hour, day, month, or year for a required date range, with optional usage filters.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Continuation cursor returned by a previous call; omit for the first page.
>
> **product** `array`
>
> Filter by one or more products: message, voice, zentrunk, transcription, or other. Omit to include all products.
>
> **to\_date** `string` *required*
>
> Exclusive end of the usage range in YYYY-MM-DD format; rows at or after this date are excluded.
>
> **direction** `string ("inbound" | "outbound")`
>
> Filter by traffic direction: inbound or outbound.
>
> **from\_date** `string` *required*
>
> Inclusive start of the usage range in YYYY-MM-DD format.
>
> **page\_size** `integer`
>
> Maximum usage records in this page (1-1000).
>
> **error\_code** `string`
>
> Only include usage associated with this provider error code.
>
> **subaccount** `string`
>
> Only include usage for this Plivo subaccount Auth ID.
>
> **country\_iso** `string`
>
> Filter by destination country ISO code.
>
> **granularity** `string ("hour" | "day" | "month" | "year")` *required*
>
> Time grouping for usage records: hour (maximum 7-day window), day (92 days), month (24 months), or year (retention-limited).
>
> **hangup\_cause** `string`
>
> Only include voice usage associated with this hangup cause.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Calls
>
> **Slug:** `PLIVO_LIST_CALLS`
>
> Return one page of Plivo call history, optionally filtered by time, direction, status, participants, hangup details, parent call, or subaccount. This does not initiate or modify calls.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum calls in this page (1-20).
>
> **cursor** `string`
>
> Continuation cursor returned by a previous call; omit for the first page.
>
> **status** `string`
>
> Filter by the provider's call status value.
>
> **end\_time** `string`
>
> Inclusive upper bound for call end time, in a Plivo-supported timestamp format.
>
> **to\_number** `string`
>
> Only return calls placed to this number.
>
> **start\_time** `string`
>
> Inclusive lower bound for call end time, in a Plivo-supported timestamp format.
>
> **subaccount** `string`
>
> Only return calls belonging to this Plivo subaccount Auth ID.
>
> **from\_number** `string`
>
> Only return calls originating from this number.
>
> **hangup\_source** `string ("customer" | "carrier" | "zentrunk")`
>
> Filter by hangup source: customer, carrier, or zentrunk.
>
> **call\_direction** `string ("inbound" | "outbound")`
>
> Filter by call direction: inbound or outbound.
>
> **parent\_call\_uuid** `string`
>
> Only return child calls associated with this parent call UUID.
>
> **hangup\_cause\_code** `string`
>
> Filter calls by Plivo hangup cause code.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Messages
>
> **Slug:** `PLIVO_LIST_MESSAGES`
>
> Return one page of inbound and outbound Plivo message history, optionally filtered by time, direction, state, sender, recipient, type, or subaccount. This reads existing message records and does not send a message.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum messages in this page (1-20).
>
> **cursor** `string`
>
> Continuation cursor returned by a previous call; omit for the first page.
>
> **end\_time** `string`
>
> Inclusive upper bound for message time in Plivo's accepted timestamp format.
>
> **to\_number** `string`
>
> Only return messages sent to this phone number.
>
> **start\_time** `string`
>
> Inclusive lower bound for message time in Plivo's accepted timestamp format.
>
> **subaccount** `string`
>
> Only return messages belonging to this Plivo subaccount Auth ID.
>
> **from\_number** `string`
>
> Only return messages sent from this phone number.
>
> **message\_type** `string ("sms" | "mms" | "whatsapp")`
>
> Filter by message type: sms, mms, or whatsapp.
>
> **message\_state** `string ("queued" | "sent" | "delivered" | "undelivered" | "failed" | "received")`
>
> Filter by message state: queued, sent, delivered, undelivered, failed, or received.
>
> **message\_direction** `string ("inbound" | "outbound")`
>
> Filter by message direction: inbound or outbound.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Owned Numbers
>
> **Slug:** `PLIVO_LIST_OWNED_NUMBERS`
>
> Return one page of phone numbers currently owned by the connected Plivo account, optionally filtered by prefix, type, service, alias, or subaccount.
>
> #### Input Parameters
>
> **alias** `string`
>
> Filter by the number's configured alias.
>
> **limit** `integer`
>
> Maximum owned numbers in this page (1-20).
>
> **cursor** `string`
>
> Continuation cursor returned by a previous call; omit for the first page.
>
> **services** `string`
>
> Filter by enabled services using voice, sms, mms, or a provider-supported combination of those values.
>
> **subaccount** `string`
>
> Only return numbers associated with this Plivo subaccount Auth ID.
>
> **number\_type** `string ("local" | "mobile" | "fixed" | "national" | "tollfree")`
>
> Filter by number type: local, mobile, fixed, national, or tollfree.
>
> **number\_startswith** `string`
>
> Only return owned numbers beginning with this digit prefix.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
