Skip to main content
POST
Place outbound call

Authorizations

Authorization
string
header
required

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

application/json

Provide exactly one of to, participants or groupId. Group calls require a Linked Device number and 2 to 31 remote recipients.

to
string
required

Specifies to for this native voip place call request.

Value constraints

Pattern: ^(?:\+[1-9]\d{1,14}|[1-9][0-9]{0,18})$
Example:

"+15550100"

session
string

Identifier of the connected Polymorfa session.

Value constraints

Minimum string length: 1
Example:

"support"

groupId
string

Identifier for the group.

Value constraints

Pattern: ^[1-9][0-9]{0,18}$
participants
string[]

Participants associated with the group or conversation.

Value constraints

Required array length: 2 - 31 elements
Pattern: ^(?:\+[1-9]\d{1,14}|[1-9][0-9]{0,18})$
video
boolean

Whether video.

exclusive
boolean

Claim the call for the placing participant.

participant
string

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

Pattern: ^[A-Za-z0-9._:@-]{1,128}$
Example:

"agent-7"

Response

Call placed and ringing

success
enum<boolean>
required

Whether the request succeeded.

Allowed values

Available options:
true
data
object
required

Structured data carried by this object.