Skip to main content
Applications (the webhook URLs a number points at) are documented under Connect a number.

Account

Inspect the active account, its balance, and settings. Inspect and update the active Plivo account
Command:
Command:
Flags
  • --address <string>: billing address
  • --city <string>: city
  • --name <string>: account name
  • --timezone <string>: IANA timezone (e.g. Asia/Kolkata)

Subaccounts

Create, list, update, and delete subaccounts. Manage subaccounts under the master account
Command:
Flags
  • --enabled: enable on creation (default true)
  • --name <string>: subaccount name (required)
Command:
Command:
Command:
Flags
  • --limit <int>: results per page (default 20)
  • --offset <int>: pagination offset
Command:
Flags
  • --enabled <string>: true|false
  • --name <string>: new name

Verify

Create OTP sessions and check their status. Requires the Verify service to be enabled on the account. Plivo Verify: OTP / phone-number verification sessions Manage Verify sessions
Command:
Flags
  • --alpha-sender <string>: alphanumeric sender id
  • --app-uuid <string>: Verify application uuid (required)
  • --channel <string>: delivery channel: sms|voice|whatsapp (default “sms”)
  • --locale <string>: BCP-47 locale, e.g. en-US
  • --method <string>: HTTP method for callback URL
  • --recipient <string>: E.164 destination number (required)
  • --url <string>: callback URL for session status events
Command:
Command:
Flags
  • --limit <int>: results per page (default 20)
  • --offset <int>: pagination offset
  • --status <string>: filter by status: pending|verified|expired
Command:
Flags
  • --otp <string>: OTP code received by the recipient (required)

Lookup

Look up the carrier, number type, and formatting for an E.164 number.
Command:
Flags
  • --type <string>: lookup type (currently only ‘carrier’ is supported by Plivo) (default “carrier”)