Numbers

Buying a number spends money and needs --yes. In India a number can only be rented (and used for calls) once a compliance application is accepted; see the compliance commands below.

Phone numbers

Search available numbers, buy one (requires --yes), attach it to an application, set CNAM, or release it. Manage account phone numbers

Command	What it does
`plivo numbers buy`	Rent a phone number (requires —yes; spends money)
`plivo numbers cnam`	Caller-ID Name (CNAM) lookup for a US/CA number (spends money: requires —yes)
`plivo numbers get`	Get details of a rented number
`plivo numbers list`	List numbers rented to your account
`plivo numbers release`	Release a rented number (requires —yes; stops monthly billing)
`plivo numbers search`	Search available numbers to rent
`plivo numbers update`	Update settings on a rented number

plivo numbers buy

Command:

plivo numbers buy <number> [flags]

Flags

--app-id <string>: auto-attach to this application after purchase

plivo numbers cnam

Command:

plivo numbers cnam <number>

plivo numbers get

Command:

plivo numbers get <number>

plivo numbers list

Command:

plivo numbers list [flags]

Flags

--alias <string>: filter by alias
--limit <int>: results per page (max 20) (default 20)
--offset <int>: pagination offset
--services <string>: filter by services: voice|sms|mms|voice,sms …
--starts-with <string>: prefix filter on E.164
--subaccount <string>: filter by subaccount auth_id
--type <string>: filter by type: local|tollfree|mobile|fixed

plivo numbers release

Command:

plivo numbers release <number>

plivo numbers search

Command:

plivo numbers search [flags]

Flags

--country <string>: ISO country code, e.g. US (required)
--limit <int>: results per page (default 20)
--offset <int>: pagination offset
--pattern <string>: digit pattern
--region <string>: region filter
--type <string>: local|tollfree|mobile|fixed

plivo numbers update

Command:

plivo numbers update <number> [flags]

Flags

--alias <string>: set alias
--app-id <string>: associate an application
--subaccount <string>: move under subaccount

Number compliance

Look up what documents a country and number type require, create and manage compliance applications (with document upload), and link numbers to them. Regulatory compliance for phone numbers (requirements, applications, linking)

Command	What it does
`plivo numbers compliance create`	Create + submit a compliance application (multipart; auto-submits)
`plivo numbers compliance delete`	Delete a compliance application (requires —yes)
`plivo numbers compliance get`	Get a compliance application by ID
`plivo numbers compliance link`	Bulk-link numbers to accepted compliance applications
`plivo numbers compliance list`	List compliance applications
`plivo numbers compliance requirements`	List documents/fields required to activate a regulated number
`plivo numbers compliance update`	Update a rejected compliance application (multipart; auto-resubmits)

plivo numbers compliance create

Command:

plivo numbers compliance create [flags]

Flags

--data <string>: application JSON; inline or @file.json (required)
--file <stringArray>: document upload as field=path, e.g. documents[0].file=@id.pdf (repeatable)

Examples

  plivo numbers compliance create \
    --data @app.json \
    --file documents[0].file=@passport.pdf \
    --file documents[1].file=@address-proof.pdf

plivo numbers compliance delete

Command:

plivo numbers compliance delete <compliance_id>

plivo numbers compliance get

Command:

plivo numbers compliance get <compliance_id> [flags]

Flags

--expand <string>: comma-separated: end_user,documents,linked_numbers

Examples

  plivo numbers compliance get <compliance_id> --expand end_user,documents,linked_numbers

plivo numbers compliance link

Command:

plivo numbers compliance link [flags]

Flags

--data <string>: full link JSON body; inline or @file.json (alternative to —link)
--link <stringArray>: number=compliance_application_id (repeatable)

Examples

  plivo numbers compliance link --link +14155551234=<compliance_id> --link +14155556789=<compliance_id>

plivo numbers compliance list

Command:

plivo numbers compliance list [flags]

Flags

--alias <string>: filter by alias
--country <string>: filter by ISO country code
--limit <int>: results per page (default 20)
--number-type <string>: filter by number type
--offset <int>: pagination offset
--status <string>: filter by status
--user-type <string>: filter by user type

plivo numbers compliance requirements

Command:

plivo numbers compliance requirements [flags]

Flags

--country <string>: ISO country code, e.g. US (required)
--number-type <string>: local|mobile|tollfree (required)
--user-type <string>: individual|business (required)

Examples

  plivo numbers compliance requirements --country US --number-type local --user-type business

plivo numbers compliance update

Command:

plivo numbers compliance update <compliance_id> [flags]

Flags

--data <string>: updated application JSON; inline or @file.json (required)
--file <stringArray>: document upload as field=path (repeatable; replaces all documents)

Examples

  plivo numbers compliance update <compliance_id> --data @fixed.json --file documents[0].file=@passport.pdf

Number masking

Create, list, fetch, and delete number-masking sessions. Number-Masking sessions (privacy-preserving call/SMS bridge)

Command	What it does
`plivo numbers masking sessions`	Manage number-masking sessions
`plivo numbers masking sessions create`	Create a masking session (spends money: requires —yes)
`plivo numbers masking sessions delete`	End a masking session (requires —yes)
`plivo numbers masking sessions get`	Get a masking session by uuid
`plivo numbers masking sessions list`	List masking sessions

plivo numbers masking sessions

Command:

plivo numbers masking sessions

plivo numbers masking sessions create

Command:

plivo numbers masking sessions create [flags]

Flags

--call-time-limit <int>: max per-call duration in seconds
--first-party <string>: first party E.164 (required)
--mode <string>: voice|sms|both (default “both”)
--record: record calls in this session
--second-party <string>: second party E.164 (required)
--session-expiry <int>: session lifetime in seconds
--virtual-number <string>: virtual number to use (else allocates from pool)

plivo numbers masking sessions delete

Command:

plivo numbers masking sessions delete <session_uuid>

plivo numbers masking sessions get

Command:

plivo numbers masking sessions get <session_uuid>

plivo numbers masking sessions list

Command:

plivo numbers masking sessions list [flags]

Flags

--limit <int>: results per page (default 20)
--offset <int>: pagination offset

Getting started

Voice agents with Audio Streaming

Plivo APIs

Phone numbers

Number compliance

Number masking

​Phone numbers

​Number compliance

​Number masking

Phone numbers

Number compliance

Number masking