Skip to main content
Plivo logo
  • Category: communication
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 6
  • Triggers: 0
  • Slug: PLIVO
  • Version: 00000000_00

Tools

Slug: PLIVO_GET_ACCOUNT_DETAILSReturn 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLIVO_GET_MESSAGERetrieve one existing Plivo message by its message UUID, including delivery, routing, timing, error, and billing details when available.

Input Parameters

string
required
Plivo message UUID, typically obtained from List Messages or a send response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLIVO_GET_USAGE_SUMMARYReturn 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

string
Continuation cursor returned by a previous call; omit for the first page.
array
Filter by one or more products: message, voice, zentrunk, transcription, or other. Omit to include all products.
string
required
Exclusive end of the usage range in YYYY-MM-DD format; rows at or after this date are excluded.
string ("inbound" | "outbound")
Filter by traffic direction: inbound or outbound.
string
required
Inclusive start of the usage range in YYYY-MM-DD format.
integer
Maximum usage records in this page (1-1000).
string
Only include usage associated with this provider error code.
string
Only include usage for this Plivo subaccount Auth ID.
string
Filter by destination country ISO code.
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).
string
Only include voice usage associated with this hangup cause.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLIVO_LIST_CALLSReturn 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

integer
Maximum calls in this page (1-20).
string
Continuation cursor returned by a previous call; omit for the first page.
string
Filter by the provider’s call status value.
string
Inclusive upper bound for call end time, in a Plivo-supported timestamp format.
string
Only return calls placed to this number.
string
Inclusive lower bound for call end time, in a Plivo-supported timestamp format.
string
Only return calls belonging to this Plivo subaccount Auth ID.
string
Only return calls originating from this number.
string ("customer" | "carrier" | "zentrunk")
Filter by hangup source: customer, carrier, or zentrunk.
string ("inbound" | "outbound")
Filter by call direction: inbound or outbound.
string
Only return child calls associated with this parent call UUID.
string
Filter calls by Plivo hangup cause code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLIVO_LIST_MESSAGESReturn 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

integer
Maximum messages in this page (1-20).
string
Continuation cursor returned by a previous call; omit for the first page.
string
Inclusive upper bound for message time in Plivo’s accepted timestamp format.
string
Only return messages sent to this phone number.
string
Inclusive lower bound for message time in Plivo’s accepted timestamp format.
string
Only return messages belonging to this Plivo subaccount Auth ID.
string
Only return messages sent from this phone number.
string ("sms" | "mms" | "whatsapp")
Filter by message type: sms, mms, or whatsapp.
string ("queued" | "sent" | "delivered" | "undelivered" | "failed" | "received")
Filter by message state: queued, sent, delivered, undelivered, failed, or received.
string ("inbound" | "outbound")
Filter by message direction: inbound or outbound.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLIVO_LIST_OWNED_NUMBERSReturn one page of phone numbers currently owned by the connected Plivo account, optionally filtered by prefix, type, service, alias, or subaccount.

Input Parameters

string
Filter by the number’s configured alias.
integer
Maximum owned numbers in this page (1-20).
string
Continuation cursor returned by a previous call; omit for the first page.
string
Filter by enabled services using voice, sms, mms, or a provider-supported combination of those values.
string
Only return numbers associated with this Plivo subaccount Auth ID.
string ("local" | "mobile" | "fixed" | "national" | "tollfree")
Filter by number type: local, mobile, fixed, national, or tollfree.
string
Only return owned numbers beginning with this digit prefix.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not