Skip to main content
Sending spends money, so send commands need --yes; --dry-run shows the request without sending.

​
SMS

Send SMS (requires --yes; --dry-run previews), list and fetch messages, and manage US 10DLC brands, campaigns, and number links, and Powerpacks. SMS: A2P / P2P short-message-service (incl. 10DLC, powerpacks, toll-free)
Command:
Command:
Flags
  • --direction <string>: inbound|outbound
  • --from <string>: filter by from_number
  • --limit <int>: results per page (default 20)
  • --offset <int>: pagination offset
  • --state <string>: queued|sent|delivered|undelivered|failed|received
  • --to <string>: filter by to_number
Command:
Command:
Flags
  • --dst <string>: destination, separate multiple with < (required)
  • --method <string>: callback method GET|POST (default “POST”)
  • --src <string>: sender (E.164, shortcode, or sender ID) (required)
  • --text <string>: message body (required)
  • --url <string>: callback URL for delivery status
Command:
Command:
Command:
Command:
Flags
  • --application-id <string>: application uuid (when application-type=xml_application)
  • --application-type <string>: default_message|xml_application
  • --local-connect: use a local-prefix-matching number
  • --name <string>: powerpack name (required)
  • --number-priority <string>: ordered priority list (e.g. “local,tollfree”)
  • --sticky-sender: send from same number to same recipient
Command:
Command:
Command:
Flags
  • --limit <int>: results per page (default 20)
  • --offset <int>: pagination offset
Command:
Command:
Flags
  • --local-connect <string>: true|false
  • --name <string>: new name
  • --sticky-sender <string>: true|false
Command:
Command:
Flags
  • --limit <int>: results per page (default 20)
  • --offset <int>: pagination offset
  • --status <string>: filter by status: SUBMITTED|IN_REVIEW|APPROVED|REJECTED
Command:
Flags
  • --business-name <string>: business name (required)
  • --business-website <string>: business website URL
  • --message-volume <string>: expected volume: LOW|MEDIUM|HIGH
  • --numbers <string>: comma-separated toll-free numbers to verify
  • --opt-in-workflow <string>: describe how recipients opt in
  • --production-message-content <string>: sample message content
  • --use-case <string>: use case category (required)
  • --use-case-summary <string>: free-text use case summary
Command:
Flags
  • --alias <string>: human-friendly alias (required)
  • --brand-type <string>: STANDARD|LOW_VOLUME_STANDARD|SOLE_PROPRIETOR (default “STANDARD”)
  • --ein <string>: tax ID / EIN
  • --ein-issuing-country <string>: ISO-2 country issuing the EIN (default “US”)
  • --email <string>: support email
  • --entity-type <string>: PRIVATE_PROFIT|PUBLIC_PROFIT|NON_PROFIT|GOVERNMENT|SOLE_PROPRIETOR (default “PRIVATE_PROFIT”)
  • --legal-name <string>: legal entity name (required)
  • --phone <string>: support phone E.164
  • --stock-exchange <string>: exchange code (PUBLIC_PROFIT only)
  • --stock-symbol <string>: ticker (PUBLIC_PROFIT only)
  • --vertical <string>: industry vertical (e.g. TECHNOLOGY, RETAIL)
  • --website <string>: primary website URL
Command:
Command:
Flags
  • --limit <int>: results per page (default 20)
  • --offset <int>: pagination offset
Command:
Flags
  • --email <string>: support email
  • --phone <string>: support phone
  • --website <string>: website URL
Command:
Flags
  • --affiliate-marketing: affiliate marketing campaign
  • --age-gated: campaign targets adult content
  • --alias <string>: human-friendly alias (required)
  • --brand-id <string>: brand to register under (required)
  • --description <string>: what this campaign does (required)
  • --direct-lending: direct-lending arrangements
  • --embedded-link: messages contain links
  • --embedded-phone: messages contain phone numbers
  • --help-keywords <string>: comma-separated help keywords (default “HELP”)
  • --help-message <string>: auto-reply to HELP
  • --message-flow <string>: describe how recipients opt in (required)
  • --number-pool: campaign uses a number pool
  • --opt-in-keywords <string>: opt-in keywords (default “START”)
  • --opt-in-message <string>: opt-in confirmation message
  • --opt-out-keywords <string>: opt-out keywords (default “STOP”)
  • --opt-out-message <string>: opt-out confirmation message
  • --sample-message-1 <string>: sample message (required)
  • --sample-message-2 <string>: second sample message
  • --sub-usecases <string>: comma-separated sub use cases
  • --usecase <string>: primary use case, e.g. MARKETING, MIXED (required)
Command:
Command:
Flags
  • --brand-id <string>: filter by brand_id
  • --limit <int>: results per page (default 20)
  • --offset <int>: pagination offset
Command:
Flags
  • --description <string>: new description
  • --message-flow <string>: new message flow
  • --sample-message-1 <string>: new sample 1
  • --sample-message-2 <string>: new sample 2
Command:
Command:
Flags
  • --limit <int>: results per page (default 20)
  • --offset <int>: pagination offset
Command:

​
MMS

Send MMS with one or more --media-url attachments (requires --yes), and list or fetch messages. MMS: multimedia messages (US/Canada)
Command:
Flags
  • --direction <string>: inbound|outbound
  • --from <string>: filter by from_number
  • --limit <int>: results per page (default 20)
  • --offset <int>: pagination offset
  • --state <string>: queued|sent|delivered|undelivered|failed|received
  • --to <string>: filter by to_number
Command:
Flags
  • --dst <string>: destination, separate multiple with < (required)
  • --media-url <stringArray>: URL of a hosted image/media file to attach (repeatable, up to 10)
  • --method <string>: callback method GET|POST (default “POST”)
  • --src <string>: sender (E.164, shortcode, or sender ID) (required)
  • --text <string>: message body (required)
  • --url <string>: callback URL for delivery status

​
WhatsApp

Send WhatsApp messages (requires --yes) and list or fetch them. WhatsApp: Plivo’s WhatsApp Business API surface
Command:
Flags
  • --direction <string>: inbound|outbound
  • --from <string>: filter by from_number
  • --limit <int>: results per page (default 20)
  • --offset <int>: pagination offset
  • --state <string>: queued|sent|delivered|undelivered|failed|received
  • --to <string>: filter by to_number
Command:
Flags
  • --dst <string>: destination, separate multiple with < (required)
  • --method <string>: callback method GET|POST (default “POST”)
  • --src <string>: sender (E.164, shortcode, or sender ID) (required)
  • --text <string>: message body (required)
  • --url <string>: callback URL for delivery status

​
Get any message

Fetch a single message regardless of channel.
Command: