Calls

Report call diagnostics

Required scope: sessions:manage

Records quality figures or an error that your app measured for one of its connections. The Console shows the latest quality report and the reported errors of each connection on the call. Reports are optional and are accepted while the call is live and for 10 minutes after it ends. Each connection can send one quality report every 5 seconds and 20 error reports per minute. At most 200 reports are kept per call: at that limit a quality report replaces the same connection’s oldest quality report. A quality report from a connection with no stored quality report, and every error report, is accepted but not stored.

POST

messaging

voip

calls

{id}

reports

Report call diagnostics

curl --request POST \
  --url https://api.polymorfa.com/messaging/voip/calls/{id}/reports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "kind": "quality",
  "connectionId": "conn_0123456789",
  "quality": {
    "rttMs": 84,
    "jitterMs": 6,
    "packetsLost": 12,
    "packetsReceived": 4810,
    "audioCodec": "audio/opus",
    "videoCodec": "video/VP8",
    "reconnects": 0
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    kind: 'quality',
    connectionId: 'conn_0123456789',
    quality: {
      rttMs: 84,
      jitterMs: 6,
      packetsLost: 12,
      packetsReceived: 4810,
      audioCodec: 'audio/opus',
      videoCodec: 'video/VP8',
      reconnects: 0
    }
  })
};

fetch('https://api.polymorfa.com/messaging/voip/calls/{id}/reports', 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/{id}/reports"

payload = {
    "kind": "quality",
    "connectionId": "conn_0123456789",
    "quality": {
        "rttMs": 84,
        "jitterMs": 6,
        "packetsLost": 12,
        "packetsReceived": 4810,
        "audioCodec": "audio/opus",
        "videoCodec": "video/VP8",
        "reconnects": 0
    }
}
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/{id}/reports"

	payload := strings.NewReader("{\n  \"kind\": \"quality\",\n  \"connectionId\": \"conn_0123456789\",\n  \"quality\": {\n    \"rttMs\": 84,\n    \"jitterMs\": 6,\n    \"packetsLost\": 12,\n    \"packetsReceived\": 4810,\n    \"audioCodec\": \"audio/opus\",\n    \"videoCodec\": \"video/VP8\",\n    \"reconnects\": 0\n  }\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,
  "message": "<string>"
}

{
  "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": "invalid_request_error",
    "code": "resource_gone",
    "message": "The requested retained resource has expired or was removed.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "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,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "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,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#internal-error"
}

{
  "error": {
    "type": "api_error",
    "code": "service_unavailable",
    "message": "A required service is unavailable. Check completion before repeating a write.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "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.

Path Parameters

string

required

Identifier for this resource.

Value constraints

Constraint	Accepted input
String length	At least `1` characters

Minimum string length: 1

Example:

"call-123"

Body

application/json

Option 1
Option 2

kind

enum<string>

required

Kind discriminator for this object.

Allowed values

Value	Meaning
`quality`	Quality.

Available options:

quality

connectionId

string

required

Client-chosen identifier of one media connection. Reusing it replaces that connection.

Value constraints

Constraint	Accepted input
Pattern	`^[A-Za-z0-9_-]{8,64}$`

Pattern: ^[A-Za-z0-9_-]{8,64}$

Example:

"conn_0123456789"

quality

object

required

Specifies quality for this native voip call quality report.

Value constraints

Constraint	Accepted input
Object size	At least `1` properties

Show child attributes

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

Constraint	Accepted input
Pattern	`^[A-Za-z0-9._:@-]{1,128}$`

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

Example:

"agent-7"

client

object

Specifies client for this native voip call quality report.

Show child attributes

Response

Report accepted

success

boolean

required

Whether the request succeeded.

message

string

Human-readable message associated with this result.

Report call diagnostics

curl --request POST \
  --url https://api.polymorfa.com/messaging/voip/calls/{id}/reports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "kind": "quality",
  "connectionId": "conn_0123456789",
  "quality": {
    "rttMs": 84,
    "jitterMs": 6,
    "packetsLost": 12,
    "packetsReceived": 4810,
    "audioCodec": "audio/opus",
    "videoCodec": "video/VP8",
    "reconnects": 0
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    kind: 'quality',
    connectionId: 'conn_0123456789',
    quality: {
      rttMs: 84,
      jitterMs: 6,
      packetsLost: 12,
      packetsReceived: 4810,
      audioCodec: 'audio/opus',
      videoCodec: 'video/VP8',
      reconnects: 0
    }
  })
};

fetch('https://api.polymorfa.com/messaging/voip/calls/{id}/reports', 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/{id}/reports"

payload = {
    "kind": "quality",
    "connectionId": "conn_0123456789",
    "quality": {
        "rttMs": 84,
        "jitterMs": 6,
        "packetsLost": 12,
        "packetsReceived": 4810,
        "audioCodec": "audio/opus",
        "videoCodec": "video/VP8",
        "reconnects": 0
    }
}
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/{id}/reports"

	payload := strings.NewReader("{\n  \"kind\": \"quality\",\n  \"connectionId\": \"conn_0123456789\",\n  \"quality\": {\n    \"rttMs\": 84,\n    \"jitterMs\": 6,\n    \"packetsLost\": 12,\n    \"packetsReceived\": 4810,\n    \"audioCodec\": \"audio/opus\",\n    \"videoCodec\": \"video/VP8\",\n    \"reconnects\": 0\n  }\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,
  "message": "<string>"
}

{
  "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": "invalid_request_error",
    "code": "resource_gone",
    "message": "The requested retained resource has expired or was removed.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "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,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "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,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#internal-error"
}

{
  "error": {
    "type": "api_error",
    "code": "service_unavailable",
    "message": "A required service is unavailable. Check completion before repeating a write.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#service-unavailable"
}

Overview

Messaging API

Platform API

Graph API

Webhook events

Report call diagnostics

Authorizations

Path Parameters

Body

Response