polymorfa calls
Place and manage calls, check consent, carry audio, and report on past calls.
polymorfa calls accept
Answer or join a call.
Answer a ringing call, or join a call another participant answered without a claim. --exclusive claims the call: other participants then get call_claimed and their connections close. Exits with code 4 when another participant claimed the call (call_claimed). Accepting does not attach media; use calls media or a browser client for that.
Usage
polymorfa calls accept CALLID [flags]Examples
polymorfa calls accept call_123polymorfa calls accept call_123 --exclusive --participant agent-7 --jsonArguments
CALLIDrequiredCall ID.
Flags
--exclusivebooleanClaim the call so no other participant can answer or join.
--participant <value>takes a valueServer API keys only: participant that answers (default "default").
--videobooleanAnswer with video, or --no-video for audio only.
Also accepts the global flags.
polymorfa calls check
Check whether a call can be placed.
Run the checks a call placement runs, without calling: the session’s calling switch, the team’s do-not-call list and blocked country codes, and on Cloud API numbers the person’s call permission and WhatsApp’s call limits. Prints allowed and the first refusal: calls_disabled, call_recipient_opted_out, call_destination_blocked, call_permission_required or call_limit_reached. The command exits with code 0 either way; read allowed from the output. Requires a server API key.
Usage
polymorfa calls check TO [flags]Examples
polymorfa calls check +14155550123 --session supportpolymorfa calls check +14155550123 --session support --jsonArguments
TOrequiredPhone number in E.164 form or a numeric WhatsApp user ID.
Flags
--session <value>takes a valuerequiredSession (number) that would place the call.
Also accepts the global flags.
polymorfa calls end
End a call for everyone.
End a call for every participant and close every connection. Repeating the command succeeds.
Usage
polymorfa calls end CALLID [flags]Example
polymorfa calls end call_123Arguments
CALLIDrequiredCall ID.
Flags
Also accepts the global flags.
polymorfa calls export
Export call detail records.
Export call detail records as CSV or newline-delimited JSON, newest first.
Each record has callId, projectId, sessionId, direction, upstream, outcome, state, hasVideo, peerRef, startedAt, connectedAt, endedAt, durationSeconds, and endReason. peerRef is a team-specific pseudonym of the other party, never a phone number.
The command requests every page until no records remain and writes one CSV header. Records go to standard output, or to --output. Progress and the next cursor go to standard error, as JSON lines with --json. --max-pages stops early; resume with --cursor and the same filters. When a page fails, the command reports the cursor that resumes from that page and exits non-zero.
Pass --project to read one project. Without it, a team API key reads every project in the team. A project token reads only its own project and requires --project. Credentials need the sessions:read scope.
Usage
polymorfa calls export [flags]Examples
polymorfa calls export --since 2026-09-01T00:00:00Z --output calls.csvpolymorfa calls export --project 018f0000-0000-7000-8000-000000000002 --format ndjson > calls.ndjsonpolymorfa calls export --outcome missed --max-pages 1 --limit 100polymorfa calls export --since 2026-09-01T00:00:00Z --cursor <cursor> --output rest.csvFlags
--cursor <value>takes a valueContinue from this cursor, reported by an earlier export. Pass the same filters.
--direction <value>takes a valueInclude only inbound or outbound calls.
Allowed valuesinboundoutbound--forcebooleanOverwrite an existing --output file.
--format <value>takes a valueWrite CSV (one header row) or newline-delimited JSON.
Allowed valuescsvndjsonDefaultcsv--limit <value>takes a valueRequest this many records per page.
Default1000--max-pages <value>takes a valueStop after this many pages and report the cursor for the rest.
--outcome <value>takes a valueInclude only calls with this outcome. answered includes answered calls still in progress; in_progress means still ringing.
Allowed valuesansweredmisseddeclinedfailedin_progress-o, --output <value>takes a valueWrite records to this file instead of standard output. Use - for standard output.
--session <value>takes a valueInclude only calls on this session (number).
--since <value>takes a valueInclude calls that started at or after this RFC 3339 time.
--until <value>takes a valueInclude calls that started before this RFC 3339 time.
--upstream <value>takes a valueInclude only numbers that connect this way.
Allowed valueslinked_devicecloud_api
Also accepts the global flags.
polymorfa calls hand
Raise or lower a call hand.
Raise or lower the Number’s hand. The Number has one hand state shared across its application connections.
Usage
polymorfa calls hand CALLID [flags]Example
polymorfa calls hand call_123 --connection-id conn_0123456789 --raisedArguments
CALLIDrequiredCall ID.
Flags
--connection-id <value>takes a valuerequiredConnection to close: 8 to 64 letters, digits, underscores, or hyphens.
--participant <value>takes a valueServer API keys only: participant that owns the connection (default "default").
--raisedbooleanRaise the hand; omit to lower it.
Also accepts the global flags.
polymorfa calls invite
Invite a participant into a call.
Ring another WhatsApp user into a call, turning a 1:1 call into a group call. The call must have a live leg. While WhatsApp restricts the number to people it has already chatted with, inviting anyone else exits with code 3 and number_restricted.
Usage
polymorfa calls invite CALLID TARGET [flags]Example
polymorfa calls invite call_123 +15550101Arguments
CALLIDrequiredCall ID.
TARGETrequiredPhone number in E.164 form or a numeric WhatsApp user ID.
Flags
Also accepts the global flags.
polymorfa calls leave
Close one call connection.
Close one media connection. The call and the participant’s other connections continue. Use calls end to end the call for everyone.
Usage
polymorfa calls leave CALLID [flags]Example
polymorfa calls leave call_123 --connection-id conn_0123456789Arguments
CALLIDrequiredCall ID.
Flags
--connection-id <value>takes a valuerequiredConnection to close: 8 to 64 letters, digits, underscores, or hyphens.
--participant <value>takes a valueServer API keys only: participant that owns the connection (default "default").
Also accepts the global flags.
polymorfa calls link create
Create a WhatsApp call link.
Create a WhatsApp call link from a Linked Device Number. It does not place or join a call. Requires a server API key or project token and calling enabled for the Number; client tokens and Cloud API-only Numbers are refused. The request is never retried: if the outcome is unknown, check before creating another link. Keep the link private.
Usage
polymorfa calls link create [flags]Examples
polymorfa calls link create --session supportpolymorfa calls link create --session support --video --jsonFlags
--session <value>takes a valuerequiredLinked Device session that owns the link.
--videobooleanCreate a video link.
Also accepts the global flags.
polymorfa calls link preview
Preview a WhatsApp call link.
Read a WhatsApp call link through a Linked Device Number without joining the call. Pipe the link, or its token, on standard input so it stays out of shell history and process listings. A full link sets voice or video; pass --video with a bare video-link token. Requires a server API key or project token.
Usage
polymorfa calls link preview [flags]Examples
printf '%s' "$CALL_LINK" | polymorfa calls link preview --session supportprintf '%s' "$TOKEN" | polymorfa calls link preview --session support --video --jsonFlags
--session <value>takes a valuerequiredLinked Device session that reads the link.
--videobooleanThe token belongs to a video link. Not needed with a full link.
Also accepts the global flags.
polymorfa calls list
List one page of stored call records, newest first. Requires sessions:read and a server credential. Project tokens read only their original owning project. Reuse the same filters with --cursor.
Usage
polymorfa calls list [flags]Examples
polymorfa calls list --outcome missed --limit 25polymorfa calls list --project PROJECT_ID --jsonFlags
--cursor <value>takes a valueCursor from the previous page; reuse the same filters.
--direction <value>takes a valueInclude only inbound or outbound calls.
Allowed valuesinboundoutbound--limit <value>takes a valueRecords per page.
Default25--outcome <value>takes a valueInclude only calls with this outcome. answered includes answered calls still in progress; in_progress means still ringing.
Allowed valuesansweredmisseddeclinedfailedin_progress--session <value>takes a valueInclude only calls on this session (number).
--since <value>takes a valueInclude calls that started at or after this RFC 3339 time.
--until <value>takes a valueInclude calls that started before this RFC 3339 time.
--upstream <value>takes a valueInclude only numbers that connect this way.
Allowed valueslinked_devicecloud_api
Also accepts the global flags.
polymorfa calls media
Send and receive call audio as raw PCM.
Carry one call’s audio as raw PCM (signed 16-bit little-endian, mono, at the sample rate the call reports; 16 kHz by default). Without --place, the command waits for an inbound call that rings after it starts, then answers it, or joins it when another participant answered without a claim. Audio from --input is sent in real time; received audio is written to --output. Status goes to standard error, as JSON lines with --json. Ctrl-C leaves the call, or ends a call you placed that is still ringing. Exits with code 4 when another participant claimed the call.
Usage
polymorfa calls media [CALLID] [flags]Examples
polymorfa calls media --session support --output call.pcmpolymorfa calls media --session support --place +15550100 --input prompt.pcm --leave-on-eof --output reply.pcmsox in.wav -t raw -r 16000 -e signed -b 16 -c 1 - | polymorfa calls media call_123 --session support --input - --exclusive > out.pcmArguments
CALLIDoptionalInbound call to answer when it rings. Omit it to answer the next inbound call.
Flags
--exclusivebooleanClaim the call so no other participant can answer or join it.
--input <value>takes a valueRaw PCM file to send, or - for standard input.
--leave-on-eofbooleanLeave the call after all input audio is sent.
--mutedbooleanMute this connection while receiving call audio. Requires media-control support.
--output <value>takes a valueFile for received PCM, or - for standard output.
Default---participant <value>takes a valueServer API keys only: participant that carries the audio (default "default").
--place <value>takes a valuePlace a call to this E.164 number or user ID instead of answering one.
--session <value>takes a valueSession of the call. Required with a server API key; client tokens use their bound session.
--videobooleanRequest video for the call. This command carries audio only.
Also accepts the global flags.
polymorfa calls opt-outs add
Add a person to the do-not-call list.
Add a person to the team’s do-not-call list by phone number or BSUID. From then on, calls to them are refused with call_recipient_opted_out, including calls your PBX places through a SIP trunk. Adding a person already on the list changes nothing and returns their entry (metadata.status 200 instead of 201). The list holds up to 100,000 entries; a full list fails with call_opt_out_limit (exit code 4). Requires a team API key.
Usage
polymorfa calls opt-outs add [flags]Examples
polymorfa calls opt-outs add --phone-number +14155550123 --note "Asked by phone on 2026-09-19"polymorfa calls opt-outs add --bsuid US.13491208655302741918Flags
--bsuid <value>takes a valueWhatsApp business-scoped user ID.
--note <value>takes a valueWhy the person asked not to be called, 1 to 500 characters.
--phone-number <value>takes a valuePhone number in E.164 format.
Also accepts the global flags.
polymorfa calls opt-outs import
Import entries into the do-not-call list.
Add many people to the team’s do-not-call list from a file of up to 10 MiB. CSV needs a header row naming phoneNumber, bsuid and optionally note; each row names a phone number (E.164) or a BSUID. JSON is an array of {"phoneNumber" | "bsuid", "note"} objects, or an object with that array as "entries". The CLI sends 5,000 entries per request and reports the entries added, already listed and rejected, with each rejected entry's zero-based position (and CSV line). Running an import again is safe: entries already on the list are counted as already listed. Exit codes: 0 when every entry is listed; 12 when some entries were rejected, or when a later request failed after earlier batches were stored (run the import again); the request's own exit code when nothing was stored. Requires a team API key.
Usage
polymorfa calls opt-outs import FILE [flags]Examples
polymorfa calls opt-outs import do-not-call.csvpolymorfa calls opt-outs import entries.json --jsoncat do-not-call.csv | polymorfa calls opt-outs import - --format csvArguments
FILErequiredCSV or JSON file, or - for standard input with --format.
Flags
--format <value>takes a valueFile format; required for standard input. Defaults to the file extension.
Allowed valuescsvjson
Also accepts the global flags.
polymorfa calls opt-outs list
List the do-not-call list.
List the team’s do-not-call list, newest first. One page is returned unless --paginate follows page.nextCursor up to --max-items entries; human output ends with the --cursor for the next page. --phone-number or --bsuid returns only that person’s entry, if any. Requires a team API key.
Usage
polymorfa calls opt-outs list [flags]Examples
polymorfa calls opt-outs listpolymorfa calls opt-outs list --phone-number +14155550123polymorfa calls opt-outs list --paginate --max-items 100000 --jsonFlags
--bsuid <value>takes a valueReturn only the entry for this BSUID.
--cursor <value>takes a valueContinue from page.nextCursor of an earlier page.
--limit <value>takes a valueEntries per page, 1 to 500 (default 100).
--max-items <value>takes a valueStop --paginate after this many entries.
--paginatebooleanRequest consecutive pages until --max-items entries are collected or no pages remain. Requires --max-items.
--phone-number <value>takes a valueReturn only the entry for this E.164 phone number.
Also accepts the global flags.
polymorfa calls opt-outs remove
Remove a person from the do-not-call list.
Remove one entry from the team’s do-not-call list. The person can be called again at once. Requires --yes and a team API key; an unknown ID fails with exit code 4.
Usage
polymorfa calls opt-outs remove OPTOUTID [flags]Example
polymorfa calls opt-outs remove 0b9f6a52-8f0e-4a44-9d51-3c1f9d6f2a10 --yesArguments
OPTOUTIDrequiredEntry ID from
calls opt-outs list.
Flags
--yesbooleanrequiredConfirm that the person can be called again.
Also accepts the global flags.
polymorfa calls permission get
Show a person’s call permission.
Show whether a person allows a Cloud API number to call them: none, temporary (until expiresAt), permanent, or revoked. WhatsApp is asked on every request, and the answer includes its limits on permission requests and calls. When WhatsApp cannot be reached, the stored state is shown with fresh false. Linked-device numbers fail with unsupported_for_connection (exit code 4). Requires a server API key.
Usage
polymorfa calls permission get TO [flags]Examples
polymorfa calls permission get +14155550123 --session supportpolymorfa calls permission get +14155550123 --session support --jsonArguments
TOrequiredPhone number in E.164 form or a numeric WhatsApp user ID.
Flags
--session <value>takes a valuerequiredCloud API session (number) that would call.
Also accepts the global flags.
polymorfa calls permission request
Ask a person for permission to call them.
Send a message that asks a person for permission to call them from a Cloud API number. WhatsApp shows --body above its allow and decline buttons, and the reply arrives as a call.permission_changed event. WhatsApp limits how often a number can ask the same person; when the limit is reached the command fails with call_permission_request_limited (exit code 5) and prints the Retry-After wait when WhatsApp gives one. A person who already granted permanent permission fails with call_permission_granted, and linked-device numbers with unsupported_for_connection (exit code 4).
Usage
polymorfa calls permission request TO [flags]Example
polymorfa calls permission request +14155550123 --session support --body "We would like to call you about your order."Arguments
TOrequiredConversation ID, E.164 phone number, or BSUID.
Flags
--body <value>takes a valuerequiredWhy you want to call, 1 to 1,024 characters.
--idempotency-key <value>takes a valueSafely identify retries of this send operation.
--session <value>takes a valuerequiredCloud API session (number) that asks.
Also accepts the global flags.
polymorfa calls place
Place a call.
Place a WhatsApp call from a session. The placing participant owns the call. Server API keys name the session with --session; client tokens place from the session they are bound to. While WhatsApp restricts the number to people it has already chatted with, a call to anyone else exits with code 3 and number_restricted.
Usage
polymorfa calls place TO [flags]Examples
polymorfa calls place +15550100 --session supportpolymorfa calls place +15550100 --session support --video --exclusive --participant agent-7 --jsonArguments
TOrequiredPhone number in E.164 form or a numeric WhatsApp user ID.
Flags
--exclusivebooleanClaim the call for the placing participant; other participants cannot join it.
--participant <value>takes a valueServer API keys only: participant that places the call (default "default").
--session <value>takes a valueSession that places the call. Required with a server API key.
--videobooleanPlace a video call.
Also accepts the global flags.
polymorfa calls place-group
Place a WhatsApp group call.
Place one WhatsApp group call by public group ID or to 2 to 31 distinct recipients from a Linked Device number. Each recipient must pass the number’s calling restrictions and your team’s destination policy. Cloud API numbers refuse this operation.
Usage
polymorfa calls place-group [flags]Examples
polymorfa calls place-group --to +15550100 --to +15550101 --session supportpolymorfa calls place-group --group-id 9007199254740996 --session supportFlags
--exclusivebooleanClaim the call for the placing participant; other participants cannot join it.
--group-id <value>takes a valuePublic group ID. Calls its 2 to 31 remote members after live consent checks.
--participant <value>takes a valueServer API keys only: participant that places the call (default "default").
--session <value>takes a valueSession that places the call. Required with a server API key.
--to <value>takes a valuerepeatableE.164 phone number or public user ID. Repeat for each recipient.
--videobooleanPlace a video call.
Also accepts the global flags.
polymorfa calls policy get
Read the team call policy.
Read the team call policy: the blocked country codes, the number of entries on the do-not-call list, and the revision to pass to calls policy set --expected-revision. The revision is 0 before the codes are first saved. Requires a team API key: a project token used as the API key is refused by the API (exit code 3), and a client token is not accepted for this command (exit code 2).
Usage
polymorfa calls policy get [flags]Example
polymorfa calls policy getFlags
Also accepts the global flags.
polymorfa calls policy set
Replace the blocked country codes.
Replace the team’s blocked country codes. Calls to phone numbers that start with a blocked code are refused with call_destination_blocked, and while any code is blocked, calls to a person whose phone number is not known are refused too. The list you pass replaces the stored list; --clear allows every country. Codes are country calling codes or longer dialing prefixes of 1 to 4 digits (44, 1876), at most 300. New calls use the new list at once; calls in progress continue. --expected-revision applies the change only if the policy still has that revision (see calls policy get); otherwise the command fails with state_conflict (exit code 4) and changes nothing. Requires a team API key.
Usage
polymorfa calls policy set [flags]Examples
polymorfa calls policy set --blocked-country-codes 44,1876polymorfa calls policy set --blocked-country-codes 44,1876 --expected-revision 3polymorfa calls policy set --clear --expected-revision 4Flags
--blocked-country-codes <value>takes a valuerepeatableComma-separated country codes to block, replacing the stored list.
--clearbooleanRemove every blocked country code.
--expected-revision <value>takes a valueApply the change only if the policy still has this revision.
Also accepts the global flags.
polymorfa calls react
Send or clear a call reaction.
Send a transient call reaction, or clear it. The connection must belong to the acting participant.
Usage
polymorfa calls react CALLID [flags]Example
polymorfa calls react call_123 --connection-id conn_0123456789 --emoji 👍Arguments
CALLIDrequiredCall ID.
Flags
--clearbooleanClear the previous reaction.
--connection-id <value>takes a valuerequiredConnection to close: 8 to 64 letters, digits, underscores, or hyphens.
--emoji <value>takes a valueReaction emoji; omit with --clear.
--participant <value>takes a valueServer API keys only: participant that owns the connection (default "default").
Also accepts the global flags.
polymorfa calls reject
Decline a ringing call.
Decline a ringing call through the unified Calls API. Declining ends the call for every participant. Exits with code 4 when the call is no longer ringing (call_not_ringing). To reject a call through the Linked Device session route with the caller ID, use call reject.
Usage
polymorfa calls reject CALLID [flags]Examples
polymorfa calls reject call_123polymorfa calls reject call_123 --participant agent-7 --jsonArguments
CALLIDrequiredCall ID.
Flags
--participant <value>takes a valueServer API keys only: participant that declines (default "default").
Also accepts the global flags.
polymorfa calls retention get
Read team call data retention.
Read how long Polymorfa keeps your team’s call data from the Platform API. Deletion of call data older than the period starts on a date Polymorfa announces in its changelog; until then the setting records a choice and nothing is deleted. Teams without a saved setting return the default (extended, 90 days) at revision 0. Pass the revision to calls retention set --expected-revision so a change cannot overwrite another one. Requires a team API key or a project token with the sessions:read scope; client tokens are refused.
Usage
polymorfa calls retention get [flags]Example
polymorfa calls retention getFlags
Also accepts the global flags.
polymorfa calls retention set
Change team call data retention.
Change how long Polymorfa keeps your team’s call data through the Platform API. --policy short, standard, extended, or compliance keeps call data for 7, 30, 90, or 365 days; --policy custom keeps it for --days (1 to 2555). Deletion of call data older than the period starts on a date Polymorfa announces in its changelog; until then saving a period deletes nothing. Once deletion runs, a shorter period also applies to call data already stored, and deleted call data cannot be recovered, so the command asks you to confirm a shorter period; pass --yes to confirm without a prompt (required when standard input or error is not a terminal). --expected-revision is required: the command reads the setting first and changes it only if it still has that revision (see calls retention get); otherwise it fails with state_conflict (exit code 4) and changes nothing. Requires a team API key with the sessions:read and sessions:manage scopes, because the command reads the setting before it changes it; the API refuses project tokens (exit code 3).
Usage
polymorfa calls retention set [flags]Examples
polymorfa calls retention set --policy compliance --expected-revision 0polymorfa calls retention set --policy custom --days 180 --expected-revision 2polymorfa calls retention set --policy short --expected-revision 3 --yesFlags
--days <value>takes a valueDays to keep call data (1 to 2555). Required with --policy custom; with a named policy, omit it or pass that policy’s period.
--expected-revision <value>takes a valuerequiredApply the change only if the setting still has this revision (0 while your team uses the default).
--policy <value>takes a valuerequiredRetention policy: short (7 days), standard (30), extended (90), compliance (365), or custom (--days).
Allowed valuesshortstandardextendedcompliancecustom--yesbooleanConfirm a shorter period, which permanently deletes stored call data older than it, without prompting.
Also accepts the global flags.
polymorfa calls ring
Ring an existing call participant again.
Ring a non-connected WhatsApp participant already in the call roster. Re-ring applies the same destination permissions and restrictions as an invitation. It does not add a participant or mark them connected.
Usage
polymorfa calls ring CALLID TARGET [flags]Example
polymorfa calls ring call_123 +15550100Arguments
CALLIDrequiredCall ID.
TARGETrequiredE.164 phone number or public user ID already in the call roster.
Flags
Also accepts the global flags.
polymorfa calls settings get
Read session call settings.
Read a session’s call settings from the Platform API. Sessions without saved settings return the defaults at revision 0. Pass the revision to calls settings set --expected-revision so a change cannot overwrite another one. After simultaneous calls are turned off, it also prints when the Ban Insurance exclusion ends (simultaneousCallsCoverageExcludedUntil), until that time passes. Ban Insurance excludes a ban when simultaneous calls were on during the 30 days before it; this timestamp is the cutoff for a new ban from that period. No end is printed while simultaneous calls are on, and a missing end does not mean the number is covered. Requires a server API key.
Usage
polymorfa calls settings get [flags]Example
polymorfa calls settings get --session supportFlags
--session <value>takes a valuerequiredSession ID.
Also accepts the global flags.
polymorfa calls settings set
Change session call settings.
Change a session’s call settings through the Platform API. Settings you do not pass keep their current values; --inbound-route sip_trunk without --sip-trunk keeps the stored trunk. --calls-enabled=false turns calling off for the session: placing, answering and joining calls fail, incoming calls are declined and SIP trunks cannot call through it, while calls in progress continue. --expected-revision applies the change only if the settings still have that revision (see calls settings get); otherwise the command fails with state_conflict (exit code 4) and changes nothing. --conference-mode (on by default) lets every participant you connect to a call (apps, bots and SIP trunk callers) hear the WhatsApp party and each other; --no-conference-mode lets each hear only the WhatsApp party. The WhatsApp party always hears all of your participants, and nobody hears their own audio. --inbound-route sip_trunk also sends incoming calls to --sip-trunk, and --sip-claim controls whether the trunk’s answer claims the call. --host-cloud-api-calls=true has Polymorfa Calls answer a Cloud API session’s incoming calls instead of your Graph API integration. --simultaneous-calls=true lets a linked-device number hold any number of calls at once (incoming, placed and campaign calls); Cloud API numbers ignore it. WhatsApp’s own apps never hold two calls at once, and while it is on, and for 30 days after you turn it off, Ban Insurance does not cover a ban of the number. Turning it on therefore requires --acknowledge-risk, and the command exits with code 2 without changing anything when that flag is missing. After --simultaneous-calls=false, the output shows when the Ban Insurance exclusion ends, from the server’s response. Only a team API key can turn it on; --simultaneous-calls=false needs no acknowledgment. Requires a server API key.
Usage
polymorfa calls settings set [flags]Examples
polymorfa calls settings set --session support --calls-enabled=falsepolymorfa calls settings set --session support --no-conference-modepolymorfa calls settings set --session support --calls-enabled=false --expected-revision 3polymorfa calls settings set --session support --inbound-route sip_trunk --sip-trunk 6f1c2f0e-1d5b-4d8e-9a55-0d4b8a6c1f10polymorfa calls settings set --session support --inbound-route clientspolymorfa calls settings set --session support --simultaneous-calls=true --acknowledge-riskpolymorfa calls settings set --session support --simultaneous-calls=falseFlags
--acknowledge-riskbooleanConfirm that turning simultaneous calls on removes Ban Insurance cover for the number. Required with --simultaneous-calls=true.
--calls-enabled <value>takes a valueAllow calls on the session (false turns calling off).
Allowed valuestruefalse--conference-modebooleanLet your participants hear each other as well as the WhatsApp party (--no-conference-mode: only the WhatsApp party).
--expected-revision <value>takes a valueApply the change only if the settings still have this revision.
--host-cloud-api-calls <value>takes a valueOn a Cloud API session, answer incoming calls with Polymorfa Calls (false leaves them to your Graph API integration).
Allowed valuestruefalse--inbound-route <value>takes a valueWhere incoming calls ring: clients, or sip_trunk to also send them to a SIP trunk.
Allowed valuesclientssip_trunk--session <value>takes a valuerequiredSession ID.
--simultaneous-calls <value>takes a valueLet a linked-device number hold any number of calls at once (true requires --acknowledge-risk; false turns it off).
Allowed valuestruefalse--sip-claim <value>takes a valueWhether an answer from the SIP trunk claims the call and stops other clients ringing.
Allowed valuestruefalse--sip-trunk <value>takes a valueSIP trunk ID that receives incoming calls.
Also accepts the global flags.
polymorfa calls stats
Summarize call volume, outcomes, and duration.
Summarize calls: counts by outcome, answer rate, and connected time, grouped by day, hour, session, or outcome.
The range defaults to the last 7 days. --group-by day covers at most 366 days and --group-by hour at most 31. Day and hour buckets, and the heatmap, use --timezone (UTC by default).
Pass --project to read one project. Without it, a team API key reads every project in the team. A project token reads only its own project and requires --project. Credentials need the sessions:read scope.
Usage
polymorfa calls stats [flags]Examples
polymorfa calls statspolymorfa calls stats --project 018f0000-0000-7000-8000-000000000002 --group-by sessionpolymorfa calls stats --since 2026-09-01T00:00:00Z --until 2026-09-02T00:00:00Z --group-by hour --timezone Europe/Lisbonpolymorfa calls stats --direction inbound --outcome missed --heatmappolymorfa calls stats --jsonFlags
--direction <value>takes a valueInclude only inbound or outbound calls.
Allowed valuesinboundoutbound--group-by <value>takes a valueGroup the results by day, hour, session, or outcome.
Allowed valuesdayhoursessionoutcomeDefaultday--heatmapbooleanAlso print calls by day of week and hour. --json always includes the heatmap.
--outcome <value>takes a valueInclude only calls with this outcome. answered includes answered calls still in progress; in_progress means still ringing.
Allowed valuesansweredmisseddeclinedfailedin_progress--session <value>takes a valueInclude only calls on this session (number).
--since <value>takes a valueInclude calls that started at or after this RFC 3339 time.
--timezone <value>takes a valueIANA time zone for day and hour groups and the heatmap, such as Europe/Lisbon. UTC offsets are not accepted.
--until <value>takes a valueInclude calls that started before this RFC 3339 time.
--upstream <value>takes a valueInclude only numbers that connect this way.
Allowed valueslinked_devicecloud_api
Also accepts the global flags.
polymorfa calls view
Read one stored call and its bounded metadata history. Requires sessions:read and a server credential. Use --json for participants, connections and reported diagnostics. No audio, video, event payload or webhook delivery data is returned.
Usage
polymorfa calls view ID [flags]Example
polymorfa calls view CALL_ID --jsonArguments
IDrequiredCall ID from calls list.
Flags
Also accepts the global flags.
polymorfa calls watch
Stream call updates for a session.
Stream a session’s inbound calls and their progress: ringing, claims, state and participant changes, and endings. Watching never answers or declines a call. With --json, each line is one JSON object. Press Ctrl-C to stop. Exits with code 3 when the API stops authorizing the credential.
Usage
polymorfa calls watch [flags]Examples
polymorfa calls watch --session supportpolymorfa calls watch --session support --participant agent-7 --jsonPOLYMORFA_CLIENT_TOKEN=... polymorfa calls watch --count 1 --jsonFlags
--count <value>takes a valueExit after this many call updates.
--participant <value>takes a valueServer API keys only: participant that watches (default "default").
--session <value>takes a valueSession to watch. Required with a server API key; client tokens watch their bound session.
Also accepts the global flags.