The Plivo connector lets your AI agent work with Plivo. Scalekit handles authentication for every call, so your agent never handles credentials. It comes with 43 tools.
- Tools
- 43
- What they doRead · write · destructive
- 22 · 14 · 722 read14 write7 destructive
- Users sign in with
- Username and password
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Plivo connection
In AgentKit > Connections, create a Plivo connection. The name you give it is the
connection_nameyour code passes. See Configure connections.
Tools
Pass the exact name toexecute_toolplivo_account_getGet your Plivo account details and credit balance.Read-onlyGet Account
Get your Plivo account details and credit balance. Returns auth_id, name, account_type, billing_mode, cash_credits, auto_recharge, address, city, state and timezone. Use plivo_account_get to check the balance before large sends.
Inputs
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
plivo_application_getGet one Plivo application.Read-onlyGet Application
Get one Plivo application. Returns app_id, app_name, answer_url, answer_method, hangup_url, fallback_answer_url, message_url, sip_uri and default flags. Use plivo_application_get for one application. Use plivo_applications_list to browse.
Inputs
app_idstringrequired- ID of the application. Example: 77506472664956353
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
plivo_applications_listList the Plivo XML applications (answer, hangup and message URLs) on your account.Read-onlyList Applications
List the Plivo XML applications (answer, hangup and message URLs) on your account. Returns meta and objects with app_id, app_name, answer_url, hangup_url, message_url and default flags. Use plivo_applications_list to find an app_id to attach to numbers.
Inputs
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
app_namestring- Only the application with this name. Example: support-ivr
limitinteger- Results per page, 1 to 20. Defaults to 20. Example: 20
offsetinteger- Number of results to skip, for paging. Example: 0
subaccountstring- Only results for this subaccount Auth ID. Example: SAXXXXXXXXXXXXXXXXXX
plivo_call_getGet the detail record of one completed Plivo call.Read-onlyGet Call
Get the detail record of one completed Plivo call. Returns call_uuid, from_number, to_number, call_direction, answer_time, end_time, call_duration, bill_duration, hangup_cause_name and total_amount. Use plivo_call_get after a call ends. Use plivo_live_call_get while it is in progress.
Inputs
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
call_uuidstringrequired- UUID of the call. Example: eba53b9e-8fbd-45c1-9444-696d2172fbc8
plivo_calls_listList completed calls (call detail records) in your Plivo account.Read-onlyList Calls
List completed calls (call detail records) in your Plivo account. Returns meta and objects with call_uuid, from_number, to_number, call_direction, call_duration, bill_duration, hangup_cause_name and total_amount. Use plivo_calls_list for call history. Use plivo_live_calls_list for calls in progress.
Inputs
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
bill_duration_gtinteger- Only calls billed for more than this many seconds. Example: 60
call_directionstring- Only inbound or outbound calls. Example: outboundone of
inboundoutbound end_time_gtestring- Only calls that ended at or after this UTC time, YYYY-MM-DD HH:MM[:ss]. Example: 2026-11-01 00:00
end_time_ltestring- Only calls that ended at or before this UTC time, YYYY-MM-DD HH:MM[:ss]. Example: 2026-11-02 00:00
from_numberstring- Only calls from this number. Example: 14151234567
hangup_cause_codeinteger- Only calls with this hangup cause code. Example: 4000
hangup_sourcestring- Only calls hung up by this side. Example: customerone of
customercarrierzentrunk limitinteger- Results per page, 1 to 20. Defaults to 20. Example: 20
offsetinteger- Number of results to skip, for paging. Example: 0
to_numberstring- Only calls to this number. Example: 14157654321
plivo_conference_getGet a running Plivo conference and its members.Read-onlyGet Conference
Get a running Plivo conference and its members. Returns conference_name, conference_run_time, conference_member_count and members with member_id, call_uuid, muted and deaf. Use plivo_conference_get to see who is in a conference.
Inputs
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
conference_namestringrequired- Name of the conference. Example: standup
plivo_conferences_listList the conferences currently running on your Plivo account.Read-onlyList Conferences
List the conferences currently running on your Plivo account. Returns conferences, a list of conference names. Use plivo_conferences_list to find live conferences. Use plivo_conference_get for members.
Inputs
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
plivo_live_call_getGet the current state of a Plivo call that is in progress.Read-onlyGet Live Call
Get the current state of a Plivo call that is in progress. Returns call_uuid, direction, from, to, call_status, caller_name and session_start. Use plivo_live_call_get during a call. Use plivo_call_get once it has ended.
Inputs
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
call_uuidstringrequired- UUID of the live call. Example: eba53b9e-8fbd-45c1-9444-696d2172fbc8
plivo_live_calls_listList the calls currently in progress on your Plivo account.Read-onlyList Live Calls
List the calls currently in progress on your Plivo account. Returns calls, a list of call_uuid values. Use plivo_live_calls_list to find active calls. Use plivo_live_call_get for one call's details.
Inputs
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
plivo_message_getGet one Plivo message detail record by its UUID.Read-onlyGet Message
Get one Plivo message detail record by its UUID. Returns message_uuid, from_number, to_number, message_direction, message_state, message_type, units, total_amount, error_code and message_time. Use plivo_message_get to check delivery of a message sent with plivo_message_send.
Inputs
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
message_uuidstringrequired- UUID of the message, from plivo_message_send or plivo_messages_list. Example: b48d95dc-e3ac-11eb-a9c2-0242ac110005
plivo_message_media_listList the media files attached to a Plivo MMS message.Read-onlyList MMS Media
List the media files attached to a Plivo MMS message. Returns objects with media_id, content_type, size and media_url. Use plivo_message_media_list to read pictures or files received by MMS.
Inputs
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
message_uuidstringrequired- UUID of the MMS message. Example: b48d95dc-e3ac-11eb-a9c2-0242ac110005
plivo_messages_listList message detail records (sent and received SMS, MMS and WhatsApp) in your Plivo account, newest first.Read-onlyList Messages
List message detail records (sent and received SMS, MMS and WhatsApp) in your Plivo account, newest first. Returns meta (limit, offset, total_count) and objects with message_uuid, from_number, to_number, message_state, message_type, error_code and charges. Use plivo_messages_list to find messages by state, direction or time. Use plivo_message_get for one message.
Inputs
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
error_codeinteger- Only messages with this Plivo error code. Example: 30
limitinteger- Results per page, 1 to 20. Defaults to 20. Example: 20
message_directionstring- Only inbound or outbound messages. Example: outboundone of
inboundoutbound message_statestring- Only messages in this state. Example: deliveredone of
queuedsentdeliveredundeliveredfailedreceivedread message_time_gtstring- Only messages after this UTC time, yyyy-MM-dd HH:mm:ss. Example: 2026-11-01 00:00:00
message_time_ltstring- Only messages before this UTC time, yyyy-MM-dd HH:mm:ss. Example: 2026-11-02 00:00:00
message_typestring- Only this message type. Example: smsone of
smsmmswhatsapp offsetinteger- Number of results to skip, for paging. Example: 0
powerpack_idstring- Only messages sent through this Powerpack. Example: d7a8e9f0-1b2c-4d3e-8f9a-0b1c2d3e4f5a
subaccountstring- Only results for this subaccount Auth ID. Example: SAXXXXXXXXXXXXXXXXXX
plivo_number_getGet one phone number rented on your Plivo account.Read-onlyGet Account Number
Get one phone number rented on your Plivo account. Returns number, alias, application, number_type, capabilities, monthly_rental_rate, renewal_date and compliance and 10DLC details. Use plivo_number_get for one number. Use plivo_numbers_list to browse.
Inputs
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
numberstringrequired- The rented number in E.164 format without +. Example: 14155551234
plivo_numbers_listList the phone numbers rented on your Plivo account.Read-onlyList Account Numbers
List the phone numbers rented on your Plivo account. Returns meta and objects with number, alias, application, number_type, voice_enabled, sms_enabled, mms_enabled, renewal_date and 10DLC status. Use plivo_numbers_list to find your sender numbers. Use plivo_number_get for one number.
Inputs
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
aliasstring- Only the number with this exact alias. Example: support-line
limitinteger- Results per page, 1 to 20. Defaults to 20. Example: 20
number_startswithstring- Only numbers starting with these digits. Example: 1415
offsetinteger- Number of results to skip, for paging. Example: 0
servicesstring- Only numbers with these capabilities, for example sms or voice,sms. Example: sms
subaccountstring- Only results for this subaccount Auth ID. Example: SAXXXXXXXXXXXXXXXXXX
tendlc_registration_statusstring- Only numbers with this US 10DLC registration status. Example: registeredone of
unregisteredin_progressregistered typestring- Only this number type. Example: localone of
localmobilefixednationaltollfree
plivo_phone_numbers_searchSearch Plivo's inventory for phone numbers you can rent in a country.Read-onlySearch Phone Numbers
Search Plivo's inventory for phone numbers you can rent in a country. Returns meta and objects with number, type, region, voice_enabled, sms_enabled, mms_enabled, monthly_rental_rate and setup_rate. Use plivo_phone_numbers_search before plivo_phone_number_buy. Use plivo_numbers_list for numbers you already rent.
Inputs
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
country_isostringrequired- ISO 3166 alpha-2 country code. Example: US
citystring- City name (local numbers only). Example: San Francisco
limitinteger- Results per page, 1 to 20. Defaults to 20. Example: 20
npanxxinteger- US and Canada only: six-digit NPA-NXX prefix. Example: 415555
offsetinteger- Number of results to skip, for paging. Example: 0
patternstring- Digits the number starts with after the country code, for example 415. Example: 415
regionstring- Region name (fixed numbers only), for example Frankfurt. Example: Frankfurt
servicesstring- Required capabilities. Example: voice,smsone of
voicesmsmmsvoice,smsvoice,sms,mms typestring- Number type. Example: localone of
tollfreelocalmobilenationalfixed
plivo_powerpack_getGet one Plivo Powerpack and its settings.Read-onlyGet Powerpack
Get one Plivo Powerpack and its settings. Returns uuid, name, sticky_sender, local_connect, application_type, application_id, number_priority and number_pool. Use plivo_powerpack_get for one Powerpack. Use plivo_powerpacks_list to browse.
Inputs
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
powerpack_uuidstringrequired- UUID of the Powerpack. Example: d7a8e9f0-1b2c-4d3e-8f9a-0b1c2d3e4f5a
plivo_powerpacks_listList the Powerpacks (sender number pools) in your Plivo account.Read-onlyList Powerpacks
List the Powerpacks (sender number pools) in your Plivo account. Returns meta and objects with uuid, name, sticky_sender, local_connect and number_pool. Use plivo_powerpacks_list to find a powerpack_uuid for plivo_message_send.
Inputs
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
limitinteger- Results per page, 1 to 20. Defaults to 20. Example: 20
offsetinteger- Number of results to skip, for paging. Example: 0
plivo_queued_calls_listList outbound calls that are queued and not yet dialled on your Plivo account.Read-onlyList Queued Calls
List outbound calls that are queued and not yet dialled on your Plivo account. Returns calls, a list of call_uuid values. Use plivo_queued_calls_list to see calls waiting for capacity.
Inputs
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
plivo_recording_getGet one Plivo recording's details and download URL.Read-onlyGet Recording
Get one Plivo recording's details and download URL. Returns recording_id, call_uuid, recording_url, recording_format, recording_type, recording_duration_ms and add_time. Use plivo_recording_get to get the recording_url of a recording.
Inputs
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
recording_idstringrequired- ID of the recording. Example: c2186400-1c8c-11e4-a664-0026b945b52x
plivo_recordings_listList call and conference recordings in your Plivo account.Read-onlyList Recordings
List call and conference recordings in your Plivo account. Without a time filter Plivo searches the last 7 days. Returns meta and objects with recording_id, call_uuid, conference_name, recording_url, recording_duration_ms and add_time. Use plivo_recordings_list to find recordings of a call. Use plivo_recording_get for one recording.
Inputs
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
add_time_gtestring- Only recordings created at or after this UTC time, YYYY-MM-DD HH:MM. The window can be at most 30 days. Example: 2026-11-01 00:00
add_time_ltestring- Only recordings created at or before this UTC time, YYYY-MM-DD HH:MM. Example: 2026-11-02 00:00
call_uuidstring- Only recordings of this call. Example: eba53b9e-8fbd-45c1-9444-696d2172fbc8
conference_namestring- Only recordings of this conference. Example: standup
from_numberstring- Only recordings of calls from this number or SIP endpoint. Example: 14151234567
limitinteger- Results per page, 1 to 20. Defaults to 20. Example: 20
offsetinteger- Number of results to skip, for paging. Example: 0
subaccountstring- Only results for this subaccount Auth ID. Example: SAXXXXXXXXXXXXXXXXXX
to_numberstring- Only recordings of calls to this number or SIP endpoint. Example: 14157654321
plivo_verify_session_getGet a Plivo Verify session's status and delivery attempts.Read-onlyGet Verification Session
Get a Plivo Verify session's status and delivery attempts. Returns session_uuid, recipient, channel, status (in-progress, verified, expired), attempt_details and charges. Use plivo_verify_session_get to see whether a user completed verification.
Inputs
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
session_uuidstringrequired- UUID of the session. Example: 4124e518-a8c9-4feb-8cff-d86636ba9234
plivo_verify_sessions_listList Plivo Verify sessions, filtered by status, recipient, application or time.Read-onlyList Verification Sessions
List Plivo Verify sessions, filtered by status, recipient, application or time. Returns meta and sessions with session_uuid, recipient, channel, status and created_at. Use plivo_verify_sessions_list for verification history. Use plivo_verify_session_get for one session.
Inputs
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
app_uuidstring- Only sessions of this Verify application. Example: b6a4fe0e-2b4f-4c55-9a3c-1f5e3d7c9b2a
limitinteger- Results per page, 1 to 20. Defaults to 20. Example: 20
offsetinteger- Number of results to skip, for paging. Example: 0
recipientstring- Only sessions for this phone number. Example: 14157654321
session_time_gtestring- Only sessions started at or after this UTC time, YYYY-MM-DD HH:MM. Example: 2026-11-01 00:00
session_time_ltestring- Only sessions started at or before this UTC time, YYYY-MM-DD HH:MM. Example: 2026-11-02 00:00
statusstring- Only sessions in this state. Example: verifiedone of
in-progressverifiedexpired subaccountstring- Only results for this subaccount Auth ID. Example: SAXXXXXXXXXXXXXXXXXX
plivo_account_updateUpdate your Plivo account's name, address, city, state or timezone.WriteUpdate Account
Update your Plivo account's name, address, city, state or timezone. Returns api_id and message changed. Use plivo_account_update to change account profile details.
- Idempotent
Inputs
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
addressstring- Street address. Example: 1 Market St
citystring- City. Example: San Francisco
namestring- Account name. Example: Acme Inc
statestring- State or province. Example: CA
timezonestring- IANA time zone, for example America/Los_Angeles. Example: America/Los_Angeles
plivo_application_createCreate a Plivo application that tells Plivo which URLs to call for incoming calls, hangups and incoming messages on attached numbers.WriteCreate Application
Create a Plivo application that tells Plivo which URLs to call for incoming calls, hangups and incoming messages on attached numbers. Returns app_id and api_id. Use plivo_application_create, then attach numbers with plivo_number_update.
Inputs
answer_urlstringrequired- URL that returns Plivo XML for incoming calls. Example: https://example.com/plivo/answer.xml
app_namestringrequired- Unique name for the application. Example: support-ivr
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
answer_methodstring- HTTP method Plivo uses to call answer_url. Defaults to POST. Example: POSTone of
GETPOST default_endpoint_appboolean- Make this the default application for new SIP endpoints. Example: false
default_number_appboolean- Make this the default application for new numbers. Example: false
fallback_answer_urlstring- URL used if answer_url fails. Example: https://example.com/plivo/fallback.xml
hangup_urlstring- URL notified when a call ends. Example: https://example.com/plivo/hangup
log_incoming_messagesboolean- Log the content of incoming messages. Defaults to true. Example: true
message_methodstring- HTTP method Plivo uses to call message_url. Defaults to POST. Example: POSTone of
GETPOST message_urlstring- URL that receives incoming SMS, MMS and WhatsApp messages. Example: https://example.com/plivo/inbound-message
plivo_application_updateChange a Plivo application's answer, hangup, fallback or message URLs and default flags.WriteUpdate Application
Change a Plivo application's answer, hangup, fallback or message URLs and default flags. Returns api_id and message changed. Use plivo_application_update to point numbers at new webhook URLs.
- Idempotent
Inputs
app_idstringrequired- ID of the application. Example: 77506472664956353
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
answer_methodstring- HTTP method Plivo uses to call answer_url. Defaults to POST. Example: POSTone of
GETPOST answer_urlstring- URL that returns Plivo XML for incoming calls. Example: https://example.com/plivo/answer.xml
default_endpoint_appboolean- Make this the default application for new SIP endpoints. Example: false
default_number_appboolean- Make this the default application for new numbers. Example: false
fallback_answer_urlstring- URL used if answer_url fails. Example: https://example.com/plivo/fallback.xml
hangup_urlstring- URL notified when a call ends. Example: https://example.com/plivo/hangup
log_incoming_messagesboolean- Log the content of incoming messages. Example: true
message_methodstring- HTTP method Plivo uses to call message_url. Defaults to POST. Example: POSTone of
GETPOST message_urlstring- URL that receives incoming messages. Example: https://example.com/plivo/inbound-message
plivo_call_createPlace an outbound voice call from a Plivo number; when answered, Plivo fetches call instructions (Plivo XML) from your answer_url.WriteMake Call
Place an outbound voice call from a Plivo number; when answered, Plivo fetches call instructions (Plivo XML) from your answer_url. Returns request_uuid and api_id; the call_uuid arrives in your answer and hangup callbacks. Use plivo_call_create to start a call. Use plivo_live_calls_list or plivo_call_get to follow it, and plivo_request_cancel to cancel it before it is answered.
Inputs
answer_urlstringrequired- URL Plivo calls when the call is answered. It must return Plivo XML that tells Plivo what to do (for example <Speak> or <Play>). Example: https://example.com/plivo/answer.xml
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
fromstringrequired- Caller ID: a Plivo number in E.164 format without +. Example: 14151234567
tostringrequired- Destination phone number in E.164 format or a SIP URI. Separate several destinations with <. Example: 14157654321
answer_methodstring- HTTP method Plivo uses to call answer_url. Defaults to POST. Example: POSTone of
GETPOST caller_namestring- Caller name shown on SIP endpoints, up to 50 characters. Example: Acme Support
fallback_urlstring- URL used if answer_url fails. Example: https://example.com/plivo/fallback.xml
hangup_urlstring- URL notified when the call ends, with duration and hangup cause. Example: https://example.com/plivo/hangup
machine_detectionstring- Answering-machine detection: true to report it to machine_detection_url, hangup to hang up on machines. Example: trueone of
truehangup machine_detection_urlstring- URL that receives the asynchronous machine-detection result. Example: https://example.com/plivo/amd
ring_timeoutinteger- Seconds to ring before giving up. Example: 30
ring_urlstring- URL notified when the call starts ringing. Example: https://example.com/plivo/ring
send_digitsstring- DTMF digits to send once connected; w waits 0.5 s and W waits 1 s. Example: ww1234#
sip_headersstring- Custom SIP headers as key=value pairs separated by commas; sent with an X-PH- prefix. Example: ticket=1234,priority=high
time_limitinteger- Maximum call length in seconds. Defaults to 14400 (4 hours). Example: 600
plivo_call_dtmf_sendSend DTMF tones (keypad digits) on a live Plivo call, for example to navigate a phone menu.WriteSend DTMF
Send DTMF tones (keypad digits) on a live Plivo call, for example to navigate a phone menu. Returns api_id and message digits sent. Use plivo_call_dtmf_send while a call is in progress.
Inputs
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
call_uuidstringrequired- UUID of the live call. Example: eba53b9e-8fbd-45c1-9444-696d2172fbc8
digitsstringrequired- Digits to send: 0-9, *, #, and w (0.5 s pause) or W (1 s pause). Example: 1w2w3#
legstring- Leg to send the tones on: aleg (default) or bleg. Example: alegone of
alegbleg
plivo_call_transferRedirect one or both legs of a live Plivo call to new Plivo XML instructions, for example to move a caller to an agent.WriteTransfer Call
Redirect one or both legs of a live Plivo call to new Plivo XML instructions, for example to move a caller to an agent. Returns api_id and message call transferred. Use plivo_call_transfer to change what a live call does.
Inputs
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
call_uuidstringrequired- UUID of the live call. Example: eba53b9e-8fbd-45c1-9444-696d2172fbc8
aleg_methodstring- HTTP method Plivo uses to call aleg_url. Defaults to POST. Example: POSTone of
GETPOST aleg_urlstring- URL returning Plivo XML for the A leg. Required when legs is aleg or both. Example: https://example.com/plivo/transfer.xml
bleg_methodstring- HTTP method Plivo uses to call bleg_url. Defaults to POST. Example: POSTone of
GETPOST bleg_urlstring- URL returning Plivo XML for the B leg. Required when legs is bleg or both. Example: https://example.com/plivo/transfer-b.xml
legsstring- Which leg to transfer: aleg (the caller), bleg (the dialled party) or both. Example: alegone of
alegblegboth
plivo_message_sendSend an SMS, MMS or WhatsApp message (text, media, template, interactive or location) from a Plivo number, short code, sender ID or Powerpack.WriteSend Message
Send an SMS, MMS or WhatsApp message (text, media, template, interactive or location) from a Plivo number, short code, sender ID or Powerpack. Returns message_uuid (a list, one per destination) and api_id. Use plivo_message_send for every outbound message. Use plivo_message_get or plivo_messages_list to check delivery state.
Inputs
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
dststringrequired- Destination phone number in E.164 format. For several SMS recipients, separate numbers with < (for example 14156667777<14157778888). Example: 14157654321
interactiveobject- WhatsApp only: an interactive message (reply buttons, list or call-to-action URL button) in WhatsApp Cloud API format. Example: {"type": "button", "body": {"text": "Confirm your order?"}, "action": {"buttons": [{"title": "Yes", "id": "yes"}, {"title": "No", "id": "no"}]}}
locationobject- WhatsApp only: a location pin with latitude, longitude, name and address. Example: {"latitude": "37.7749", "longitude": "-122.4194", "name": "Store", "address": "1 Market St, San Francisco"}
logstring- Logging of content and numbers: true (default), false, content_only (hide numbers) or number_only (hide content). Example: trueone of
truefalsecontent_onlynumber_only media_urlsarray- Media URLs. MMS: up to 10 public URLs, under 5 MB in total. WhatsApp: a single media URL. Example: ["https://example.com/files/receipt.jpg"]
message_expiryinteger- Seconds the message may wait in Plivo's queue before it is dropped, 5 to 10799. Defaults to 10800 (3 hours). Example: 3600
methodstring- HTTP method Plivo uses to call the status url. Defaults to POST. Example: POSTone of
GETPOST powerpack_uuidstring- Send from a Powerpack number pool instead of src (SMS and MMS). Example: d7a8e9f0-1b2c-4d3e-8f9a-0b1c2d3e4f5a
srcstring- Sender: a Plivo number, short code or alphanumeric sender ID; for WhatsApp, your WhatsApp Business number. Use either src or powerpack_uuid. Example: 14151234567
templateobject- WhatsApp only: an approved template to send, with name, language and optional components carrying the parameter values. Needed to start a WhatsApp conversation outside the 24-hour window. Example: {"name": "order_update", "language": "en_US", "components": [{"type": "body", "parameters": [{"type": "text", "text": "1234"}]}]}
textstring- Message text. SMS: up to 1600 GSM or 737 Unicode characters. WhatsApp free-form: up to 4096 characters. Optional caption for MMS. Example: Your order 1234 has shipped.
trackableboolean- Set true for messages with a trackable action such as a one-time code, to report conversion. Defaults to false. Example: false
typestring- Message type: sms (default), mms or whatsapp. Example: smsone of
smsmmswhatsapp urlstring- Webhook URL that receives delivery status updates for this message. Example: https://example.com/plivo/status
plivo_number_lookupLook up a phone number's carrier, number type (mobile, fixed, voip, toll-free), country and E.164 format with the Plivo Lookup API.WriteLook Up Phone Number
Look up a phone number's carrier, number type (mobile, fixed, voip, toll-free), country and E.164 format with the Plivo Lookup API. Each lookup is charged. Returns phone_number, country, format (e164, national, international), carrier (name, type, mobile_country_code, mobile_network_code, ported) and resource_uri. Use plivo_number_lookup to validate a number or check if it is mobile before sending SMS.
- Idempotent
Inputs
numberstringrequired- Phone number in E.164 format with leading +. Example: +14151234567
plivo_number_updateChange a rented Plivo number's application, alias, subaccount, CNAM or compliance application.WriteUpdate Account Number
Change a rented Plivo number's application, alias, subaccount, CNAM or compliance application. Returns api_id and message changed. Use plivo_number_update to route a number to an application or rename it.
- Idempotent
Inputs
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
numberstringrequired- The rented number in E.164 format without +. Example: 14155551234
aliasstring- Your own name for the number. Example: support-line
app_idstring- Application that handles inbound calls and messages for this number. Example: 77506472664956353
cnamstring- US only: caller ID name shown on outbound calls. Example: ACME SUPPORT
cnam_lookupstring- US only: enable or disable caller-name lookup on inbound calls. Example: enabledone of
enableddisabled compliance_application_idstring- UUID of an accepted compliance application to link. Example: a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d
subaccountstring- Auth ID of the subaccount to move the number to. Example: SAXXXXXXXXXXXXXXXXXX
plivo_phone_number_buyRent a phone number from Plivo's inventory.WriteBuy Phone Number
Rent a phone number from Plivo's inventory. This charges your account the setup fee and monthly rental. Returns numbers with the rented number and its status, plus api_id. Use plivo_phone_number_buy with a number from plivo_phone_numbers_search. Some countries need an accepted compliance application first.
Inputs
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
numberstringrequired- The number to rent, from plivo_phone_numbers_search. Example: 14155551234
app_idstring- Application to attach for inbound calls and messages. Defaults to your default number application. Example: 77506472664956353
cnam_lookupstring- US only: enable or disable caller-name lookup on inbound calls. Example: enabledone of
enableddisabled compliance_application_idstring- UUID of an accepted compliance application for this country and number type. Example: a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d
subaccountstring- Auth ID of a subaccount to give the number to. Example: SAXXXXXXXXXXXXXXXXXX
plivo_powerpack_createCreate a Plivo Powerpack, a pool of sender numbers that Plivo picks from per destination.WriteCreate Powerpack
Create a Plivo Powerpack, a pool of sender numbers that Plivo picks from per destination. Returns the new Powerpack with its uuid. Use plivo_powerpack_create, then add numbers to the pool in the Plivo console, and send with powerpack_uuid.
Inputs
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
namestringrequired- Unique name for the Powerpack. Example: marketing-pool
application_idstring- ID of the application or PHLO that handles inbound messages to pool numbers. Example: 77506472664956353
application_typestring- Type of application handling inbound messages: xml or phlo. Example: xmlone of
xmlphlo local_connectboolean- Prefer a sender number local to the recipient. Defaults to true. Example: true
number_priorityarray- Per-country order of number types to send from, for example [{"country_iso": "US", "priority": {"priority1": "shortcode", "priority2": "tollfree", "priority3": "longcode"}}]. Example: [{"country_iso": "US", "priority": {"priority1": "tollfree", "priority2": "longcode"}}]
sticky_senderboolean- Keep using the same sender number for each recipient. Defaults to true. Example: true
plivo_powerpack_updateChange a Plivo Powerpack's name, sticky sender, local connect, inbound application or number priority.WriteUpdate Powerpack
Change a Plivo Powerpack's name, sticky sender, local connect, inbound application or number priority. Returns the updated Powerpack. Use plivo_powerpack_update to change pool behaviour.
- Idempotent
Inputs
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
powerpack_uuidstringrequired- UUID of the Powerpack. Example: d7a8e9f0-1b2c-4d3e-8f9a-0b1c2d3e4f5a
application_idstring- Application or PHLO ID for inbound messages. Example: 77506472664956353
application_typestring- xml or phlo. Example: xmlone of
xmlphlo local_connectboolean- Prefer a sender number local to the recipient. Example: false
namestring- New name. Example: marketing-pool-2
number_priorityarray- Per-country order of number types to send from. Example: [{"country_iso": "US", "priority": {"priority1": "tollfree", "priority2": "longcode"}}]
sticky_senderboolean- Keep using the same sender number for each recipient. Example: true
plivo_verify_session_createStart a Plivo Verify session that sends a one-time code to a phone number by SMS or voice.WriteSend Verification Code
Start a Plivo Verify session that sends a one-time code to a phone number by SMS or voice. Returns session_uuid and api_id. Use plivo_verify_session_create to begin phone verification. Use plivo_verify_session_validate with the code the user enters.
Inputs
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
recipientstringrequired- Phone number to verify, in E.164 format. Example: 14157654321
app_hashstring- Android app hash for the SMS Retriever API, so the app can read the code automatically. Example: FA+9qCX9VSu
app_uuidstring- UUID of the Verify application whose settings to use. Defaults to your default Verify application. Example: b6a4fe0e-2b4f-4c55-9a3c-1f5e3d7c9b2a
brand_namestring- Brand name that replaces ${brand_name} in the message template. Example: Acme
channelstring- How to send the code: sms (default) or voice. Example: smsone of
smsvoice code_lengthinteger- Number of digits in the code, 4 to 8. Example: 6
localestring- Language of the message, for example en, en_US, es or fr_FR. Defaults to en. Example: en_US
methodstring- HTTP method Plivo uses to call the status url. Defaults to POST. Example: POSTone of
GETPOST urlstring- Webhook URL that receives session status updates. Example: https://example.com/plivo/verify
plivo_verify_session_validateCheck the code a user entered against a Plivo Verify session.WriteCheck Verification Code
Check the code a user entered against a Plivo Verify session. Returns api_id and message session validated successfully, or an error for a wrong or expired code. Use plivo_verify_session_validate after plivo_verify_session_create.
Inputs
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
otpstringrequired- The code the user entered. Example: 482910
session_uuidstringrequired- session_uuid returned by plivo_verify_session_create. Example: 4124e518-a8c9-4feb-8cff-d86636ba9234
plivo_application_deleteDelete a Plivo application.DestructiveDelete Application
Delete a Plivo application. Numbers and endpoints using it move to the default application. Returns an empty 204 response on success. Use plivo_application_delete to remove an unused application.
- Idempotent
Inputs
app_idstringrequired- ID of the application. Example: 77506472664956353
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
cascadeboolean- Set true to also delete SIP endpoints that use this application. Defaults to true. Example: false
new_endpoint_applicationstring- ID of the application that endpoints move to when cascade is false. Example: 77506472664956354
plivo_call_hangupHang up a Plivo call that is in progress.DestructiveHang Up Call
Hang up a Plivo call that is in progress. Returns an empty 204 response on success. Use plivo_call_hangup to end a live call. Use plivo_request_cancel for a call that has not been answered yet.
- Idempotent
Inputs
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
call_uuidstringrequired- UUID of the live call. Example: eba53b9e-8fbd-45c1-9444-696d2172fbc8
plivo_conference_hangupEnd a running Plivo conference and disconnect every member.DestructiveEnd Conference
End a running Plivo conference and disconnect every member. Returns an empty 204 response on success. Use plivo_conference_hangup to close a conference.
- Idempotent
Inputs
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
conference_namestringrequired- Name of the conference. Example: standup
plivo_number_unrentRelease (unrent) a phone number from your Plivo account.DestructiveUnrent Number
Release (unrent) a phone number from your Plivo account. The number stops working and may be rented by someone else. Returns an empty 204 response on success. Use plivo_number_unrent to stop paying for a number.
- Idempotent
Inputs
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
numberstringrequired- The rented number in E.164 format without +. Example: 14155551234
plivo_powerpack_deleteDelete a Plivo Powerpack, optionally also releasing (unrenting) its numbers.DestructiveDelete Powerpack
Delete a Plivo Powerpack, optionally also releasing (unrenting) its numbers. Returns api_id and a confirmation message. Use plivo_powerpack_delete to remove a pool you no longer use.
- Idempotent
Inputs
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
powerpack_uuidstringrequired- UUID of the Powerpack. Example: d7a8e9f0-1b2c-4d3e-8f9a-0b1c2d3e4f5a
unrent_numbersboolean- Set true to also unrent every number in the pool. Defaults to false (numbers stay on your account). Example: false
plivo_recording_deletePermanently delete a Plivo recording and its audio file.DestructiveDelete Recording
Permanently delete a Plivo recording and its audio file. Returns an empty 204 response on success. Use plivo_recording_delete for data-removal requests.
- Idempotent
Inputs
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
recording_idstringrequired- ID of the recording. Example: c2186400-1c8c-11e4-a664-0026b945b52x
plivo_request_cancelCancel an outbound Plivo call that has not been answered yet, using the request_uuid from plivo_call_create.DestructiveCancel Call Request
Cancel an outbound Plivo call that has not been answered yet, using the request_uuid from plivo_call_create. Returns an empty 204 response on success. Use plivo_request_cancel before the call connects. Use plivo_call_hangup once it is live.
- Idempotent
Inputs
auth_idstringrequired- Your Plivo Auth ID: the same value you entered as Auth ID when connecting (it starts with MA or SA and is shown on the Plivo console overview page). Plivo puts it in every API path. Example: MAXXXXXXXXXXXXXXXXXX
request_uuidstringrequired- request_uuid returned by plivo_call_create. Example: 9834029e-58b6-11e1-b8b7-a5bd0e4e126f
No tools match.