List call records

GET

platform

calls

List call records

curl --request GET \
  --url https://api.polymorfa.com/platform/calls \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

package main

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

func main() {

	url := "https://api.polymorfa.com/platform/calls"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

{
  "data": [
    {
      "callId": "<string>",
      "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sessionId": "<string>",
      "direction": "inbound",
      "upstream": "linked_device",
      "outcome": "answered",
      "state": "offered",
      "hasVideo": true,
      "peerRef": "<string>",
      "startedAt": "2023-11-07T05:31:56Z",
      "connectedAt": "2023-11-07T05:31:56Z",
      "endedAt": "2023-11-07T05:31:56Z",
      "durationSeconds": 1,
      "endReason": "user_hangup"
    }
  ],
  "page": {
    "nextCursor": "<string>",
    "hasMore": true
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

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.

Query Parameters

projectId

string

Project to read. Omit to total every project in the organization.

sessionId

string

Identifier of the connected Polymorfa session.

Value constraints

Constraint	Accepted input
String length	`1` through `128` characters
Session name of one number.

Required string length: 1 - 128

direction

enum<string>

Specifies direction for this query parameter.

Allowed values

Value	Meaning
`inbound`	Inbound.
`outbound`	Outbound.

Available options:

inbound,

outbound

upstream

enum<string>

Specifies upstream for this query parameter.

Allowed values

Value	Meaning
`linked_device`	Linked device.
`cloud_api`	Cloud api.
How the number connects to WhatsApp.

Available options:

linked_device,

cloud_api

outcome

enum<string>

Specifies outcome for this query parameter.

Allowed values

Value	Meaning
`answered`	Answered.
`missed`	Missed.
`declined`	Declined.
`failed`	Failed.
`in_progress`	In progress.
How the call went. `answered`: media connected, including answered calls still in progress. `declined`: declined by a participant or the other party, or the line was busy. `missed`: nobody answered before ringing stopped or the caller hung up. `failed`: ended before it connected for any other reason, such as a connection or capacity failure. `in_progress`: still ringing.

Available options:

answered,

missed,

declined,

failed,

in_progress

since

string<date-time>

Specifies since for this query parameter.

Value constraints

Constraint	Accepted input
Format	`date-time`
Include calls that started at or after this time.

until

string<date-time>

Specifies until for this query parameter.

Value constraints

Constraint	Accepted input
Format	`date-time`
Include calls that started before this time.

limit

integer

default:25

Specifies limit for this query parameter.

Value constraints

Constraint	Accepted input
Numeric value	`1` through `100` (inclusive)

Required range: 1 <= x <= 100

cursor

string

Specifies cursor for this query parameter.

Value constraints

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

Required string length: 1 - 256

Response

Success

data

object[]

required

Structured data carried by this object.

Value constraints

Constraint	Accepted input
Array size	At most `100` items

Maximum array length: 100

Show child attributes

page

object

required

Specifies page for this schema.

Show child attributes

List call records

curl --request GET \
  --url https://api.polymorfa.com/platform/calls \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

package main

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

func main() {

	url := "https://api.polymorfa.com/platform/calls"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

{
  "data": [
    {
      "callId": "<string>",
      "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sessionId": "<string>",
      "direction": "inbound",
      "upstream": "linked_device",
      "outcome": "answered",
      "state": "offered",
      "hasVideo": true,
      "peerRef": "<string>",
      "startedAt": "2023-11-07T05:31:56Z",
      "connectedAt": "2023-11-07T05:31:56Z",
      "endedAt": "2023-11-07T05:31:56Z",
      "durationSeconds": 1,
      "endReason": "user_hangup"
    }
  ],
  "page": {
    "nextCursor": "<string>",
    "hasMore": true
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

Overview

Messaging API

Platform API

Graph API

Webhook events

Authorizations

Query Parameters

Response