Update call settings

PUT

platform

sessions

{session}

call-settings

Update call settings

curl --request PUT \
  --url https://api.polymorfa.com/platform/sessions/{session}/call-settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "callsEnabled": true,
  "conferenceMode": true,
  "sipTrunkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sipClaim": true,
  "hostCloudApiCalls": true,
  "expectedRevision": 1
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    callsEnabled: true,
    conferenceMode: true,
    sipTrunkId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    sipClaim: true,
    hostCloudApiCalls: true,
    expectedRevision: 1
  })
};

fetch('https://api.polymorfa.com/platform/sessions/{session}/call-settings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.polymorfa.com/platform/sessions/{session}/call-settings"

payload = {
    "callsEnabled": True,
    "conferenceMode": True,
    "sipTrunkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sipClaim": True,
    "hostCloudApiCalls": True,
    "expectedRevision": 1
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

package main

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

func main() {

	url := "https://api.polymorfa.com/platform/sessions/{session}/call-settings"

	payload := strings.NewReader("{\n  \"callsEnabled\": true,\n  \"conferenceMode\": true,\n  \"sipTrunkId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"sipClaim\": true,\n  \"hostCloudApiCalls\": true,\n  \"expectedRevision\": 1\n}")

	req, _ := http.NewRequest("PUT", 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": {
    "callsEnabled": true,
    "conferenceMode": true,
    "inboundRoute": "clients",
    "sipTrunkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sipClaim": true,
    "hostCloudApiCalls": true,
    "revision": 1,
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_parameter",
    "message": "Correct the invalid request field.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "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,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "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,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "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,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "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,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#state-conflict"
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "An unexpected service failure occurred. Keep the request ID for support.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#internal-error"
}

Authorizations

Authorization

string

header

required

Send your team API key or project token as Authorization: Bearer <token>. The credential must have the required permissions. Project tokens can access only their own project.

Path Parameters

session

string

required

Identifier of the connected Polymorfa session.

Value constraints

Constraint	Accepted input
String length	`1` through `128` characters

Required string length: 1 - 128

Body

application/json

callsEnabled

boolean

Set to false to refuse new and incoming calls on the session; true allows them again.

conferenceMode

boolean

Set to true so that the participants you connect to a call hear each other as well as the WhatsApp party, or false so that each hears only the WhatsApp party.

inboundRoute

enum<string>

Specifies inbound route for this management platform access update call settings request.

Allowed values

Value	Meaning
`clients`	Clients.
`sip_trunk`	Sip trunk.

Available options:

clients,

sip_trunk

sipTrunkId

string<uuid> | null

The SIP trunk for sip_trunk: a trunk in the session's project whose direction is outbound or both. Required when switching the route to sip_trunk; omit it to keep the stored trunk. With clients send null or omit it: a trunk ID is refused, and clients clears the stored trunk.

Accepted alternatives

Alternative	Accepted input
Alternative 1	Type: `string`; Format: `uuid`
Alternative 2	`null`

Value constraints

Constraint	Accepted input
Format	`uuid`

sipClaim

boolean

Whether an answer from the SIP trunk claims the call.

hostCloudApiCalls

boolean

Set to true to have Polymorfa Calls answer the session's Cloud API calls instead of your Graph API integration. Applies to calls that arrive after the change.

expectedRevision

integer

Apply the update only if the settings still have this revision (0 for a session using the defaults). Otherwise the update fails with 409 state_conflict.

Value constraints

Constraint	Accepted input
Numeric value	`0` or greater

Required range: x >= 0

Response

Call settings saved. Audio settings apply to a call the next time a participant answers or connects to it, including calls in progress. Routing settings apply to calls that arrive after the change.

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

Update call settings

curl --request PUT \
  --url https://api.polymorfa.com/platform/sessions/{session}/call-settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "callsEnabled": true,
  "conferenceMode": true,
  "sipTrunkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sipClaim": true,
  "hostCloudApiCalls": true,
  "expectedRevision": 1
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    callsEnabled: true,
    conferenceMode: true,
    sipTrunkId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    sipClaim: true,
    hostCloudApiCalls: true,
    expectedRevision: 1
  })
};

fetch('https://api.polymorfa.com/platform/sessions/{session}/call-settings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.polymorfa.com/platform/sessions/{session}/call-settings"

payload = {
    "callsEnabled": True,
    "conferenceMode": True,
    "sipTrunkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sipClaim": True,
    "hostCloudApiCalls": True,
    "expectedRevision": 1
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

package main

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

func main() {

	url := "https://api.polymorfa.com/platform/sessions/{session}/call-settings"

	payload := strings.NewReader("{\n  \"callsEnabled\": true,\n  \"conferenceMode\": true,\n  \"sipTrunkId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"sipClaim\": true,\n  \"hostCloudApiCalls\": true,\n  \"expectedRevision\": 1\n}")

	req, _ := http.NewRequest("PUT", 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": {
    "callsEnabled": true,
    "conferenceMode": true,
    "inboundRoute": "clients",
    "sipTrunkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sipClaim": true,
    "hostCloudApiCalls": true,
    "revision": 1,
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_parameter",
    "message": "Correct the invalid request field.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "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,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "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,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "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,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "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,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#state-conflict"
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "An unexpected service failure occurred. Keep the request ID for support.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#internal-error"
}

Overview

Messaging API

Platform API

Graph API

Webhook events

Update call settings

Authorizations

Path Parameters

Body

Response