Calls

Place outbound call

Required scope: sessions:manage

Originates a WhatsApp call to to (an E.164 phone number or a user ID) from the named session. The call rings on the callee’s device: call.accepted follows when they pick up and call.ended when either side hangs up. Attach media like any other call — /offer for a browser, the SDK media socket for programmatic audio/video. Client tokens place from their bound session; server keys must name one. Outbound starts share a rate limit per organization and source session across server keys and client tokens; client-token rules also apply.

POST

messaging

voip

calls

Place outbound call

curl --request POST \
  --url https://api.polymorfa.com/messaging/voip/calls \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "to": "+15550100"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({to: '+15550100'})
};

fetch('https://api.polymorfa.com/messaging/voip/calls', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.polymorfa.com/messaging/voip/calls"

payload = { "to": "+15550100" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polymorfa.com/messaging/voip/calls"

	payload := strings.NewReader("{\n  \"to\": \"+15550100\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "success": true,
  "data": {
    "callId": "<string>",
    "session": "<string>",
    "video": true
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_parameter",
    "message": "Correct the invalid request field.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#invalid-parameter"
}

{
  "error": {
    "type": "authentication_error",
    "code": "invalid_credential",
    "message": "Supply a valid credential.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#invalid-credential"
}

{
  "error": {
    "type": "permission_error",
    "code": "permission_denied",
    "message": "The credential does not have access to this resource.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#permission-denied"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "resource_not_found",
    "message": "The resource is unavailable to this caller.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#resource-not-found"
}

{
  "error": {
    "type": "conflict_error",
    "code": "state_conflict",
    "message": "The request conflicts with the resource state.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#state-conflict"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "resource_gone",
    "message": "The requested retained resource has expired or was removed.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#resource-gone"
}

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "The request limit was reached. Follow Retry-After when supplied.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#rate-limit-exceeded"
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "An unexpected service failure occurred. Keep the request ID for support.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#internal-error"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "operation_not_supported",
    "message": "This operation is not supported.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#operation-not-supported"
}

{
  "error": {
    "type": "api_error",
    "code": "service_unavailable",
    "message": "A required service is unavailable. Check completion before repeating a write.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#service-unavailable"
}

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

string

required

Specifies to for this native voip place call request.

Value constraints

Constraint	Accepted input
Pattern	`^(?:\+[1-9]\d{1,14}\|pmfa_(?:lid\|botid)_[1-9]\d*)$`

Pattern: ^(?:\+[1-9]\d{1,14}|pmfa_(?:lid|botid)_[1-9]\d*)$

Example:

"+15550100"

session

string

Identifier of the connected Polymorfa session.

Value constraints

Constraint	Accepted input
String length	At least `1` characters

Minimum string length: 1

Example:

"support"

video

boolean

Whether video.

Response

Call placed and ringing

success

enum<boolean>

required

Whether the request succeeded.

Allowed values

Value	Meaning
`true`	True.

Available options:

true

data

object

required

Structured data carried by this object.

Show child attributes

⌘I

Place outbound call

curl --request POST \
  --url https://api.polymorfa.com/messaging/voip/calls \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "to": "+15550100"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({to: '+15550100'})
};

fetch('https://api.polymorfa.com/messaging/voip/calls', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.polymorfa.com/messaging/voip/calls"

payload = { "to": "+15550100" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polymorfa.com/messaging/voip/calls"

	payload := strings.NewReader("{\n  \"to\": \"+15550100\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "success": true,
  "data": {
    "callId": "<string>",
    "session": "<string>",
    "video": true
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_parameter",
    "message": "Correct the invalid request field.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#invalid-parameter"
}

{
  "error": {
    "type": "authentication_error",
    "code": "invalid_credential",
    "message": "Supply a valid credential.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#invalid-credential"
}

{
  "error": {
    "type": "permission_error",
    "code": "permission_denied",
    "message": "The credential does not have access to this resource.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#permission-denied"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "resource_not_found",
    "message": "The resource is unavailable to this caller.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#resource-not-found"
}

{
  "error": {
    "type": "conflict_error",
    "code": "state_conflict",
    "message": "The request conflicts with the resource state.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#state-conflict"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "resource_gone",
    "message": "The requested retained resource has expired or was removed.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#resource-gone"
}

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "The request limit was reached. Follow Retry-After when supplied.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#rate-limit-exceeded"
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "An unexpected service failure occurred. Keep the request ID for support.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#internal-error"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "operation_not_supported",
    "message": "This operation is not supported.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#operation-not-supported"
}

{
  "error": {
    "type": "api_error",
    "code": "service_unavailable",
    "message": "A required service is unavailable. Check completion before repeating a write.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#service-unavailable"
}

Overview

Messaging API

Platform API

Graph API

Webhook events

Place outbound call

Authorizations

Body

Response