Place outbound call
Required scope: sessions:manage
Originates a WhatsApp call to to, an ad-hoc group call to participants (2 to 31 distinct E.164 phone numbers or public user IDs), or every remote member of groupId (a public group ID). Group rosters must contain 2 to 31 remote members; a membership change during placement refuses the call. Provide exactly one destination form. Group calls require a Linked Device number and check every recipient against the team policy and number restrictions before dialing. The call is owned by the placing participant and rings on the callee’s device: call.accepted follows when they pick up and call.ended when either side hangs up. Carry its audio and video with a Polymorfa Calls SDK. exclusive: true claims the call for the placing participant. Client tokens place from their bound session; server credentials must name one. Outbound starts share a rate limit per organization and source session across server credentials and client tokens; client-token rules also apply.
Authorizations
Polymorfa organization key (pmfa_ prefix), project token (pmfa_pt_ prefix) where supported, or short-lived client token (pmfa_ct_ prefix). Organization and project keys may be personal or service-account owned and enforce selected action scopes. Organization keys cover the team and its projects; project tokens stay inside one project. Client tokens stay inside their live project and session and enforce their client rules.
Body
- Option 1
- Option 2
- Option 3
Provide exactly one of to, participants or groupId. Group calls require a Linked Device number and 2 to 31 remote recipients.
Specifies to for this native voip place call request.
Value constraints
^(?:\+[1-9]\d{1,14}|[1-9][0-9]{0,18})$"+15550100"
Identifier of the connected Polymorfa session.
Value constraints
1"support"
Identifier for the group.
Value constraints
^[1-9][0-9]{0,18}$Participants associated with the group or conversation.
Value constraints
2 - 31 elements^(?:\+[1-9]\d{1,14}|[1-9][0-9]{0,18})$Whether video.
Claim the call for the placing participant.
Server credentials only: the participant acting in the call. Defaults to default. Client tokens act as their own participant and must omit this field.
Value constraints
^[A-Za-z0-9._:@-]{1,128}$"agent-7"