Find calls

curl --request GET \
  --url https://web-api.clerk.chat/public/calls \
  --header 'apiKey: <api-key>'

const options = {method: 'GET', headers: {apiKey: '<api-key>'}};

fetch('https://web-api.clerk.chat/public/calls', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://web-api.clerk.chat/public/calls",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "apiKey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://web-api.clerk.chat/public/calls"

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

	req.Header.Add("apiKey", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://web-api.clerk.chat/public/calls")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["apiKey"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "conversationId": "00000000-0000-0000-0000-000000000000",
      "userId": "00000000-0000-0000-0000-000000000000",
      "callerNumber": "+14155550123",
      "direction": "inbound",
      "callStatus": "completed",
      "callStatusReason": "hangup_participant",
      "callStartTime": "2021-01-01T00:00:00.000Z",
      "callEndTime": "2021-01-01T00:05:00.000Z",
      "summary": "<string>",
      "createdAt": "2021-01-01T00:00:00.000Z",
      "updatedAt": "2021-01-01T00:00:00.000Z"
    }
  ],
  "total": 1,
  "links": {
    "next": "<string>",
    "prev": "<string>",
    "self": "<string>"
  }
}

GET

public

calls

Find calls

curl --request GET \
  --url https://web-api.clerk.chat/public/calls \
  --header 'apiKey: <api-key>'

const options = {method: 'GET', headers: {apiKey: '<api-key>'}};

fetch('https://web-api.clerk.chat/public/calls', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://web-api.clerk.chat/public/calls",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "apiKey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://web-api.clerk.chat/public/calls"

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

	req.Header.Add("apiKey", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://web-api.clerk.chat/public/calls")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["apiKey"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "conversationId": "00000000-0000-0000-0000-000000000000",
      "userId": "00000000-0000-0000-0000-000000000000",
      "callerNumber": "+14155550123",
      "direction": "inbound",
      "callStatus": "completed",
      "callStatusReason": "hangup_participant",
      "callStartTime": "2021-01-01T00:00:00.000Z",
      "callEndTime": "2021-01-01T00:05:00.000Z",
      "summary": "<string>",
      "createdAt": "2021-01-01T00:00:00.000Z",
      "updatedAt": "2021-01-01T00:00:00.000Z"
    }
  ],
  "total": 1,
  "links": {
    "next": "<string>",
    "prev": "<string>",
    "self": "<string>"
  }
}

Authorizations

apiKey

string

header

required

Query Parameters

callerNumber

string

Filter calls by the phone number that initiated the call

inboxId

string

Filter calls by the inbox they belong to

status

enum<string>[]

Filter calls by one or more statuses

The status of the call

Available options:

busy,

cancelled,

completed,

failed,

in_progress,

no_answer,

queued

direction

enum<string>

Filter calls by direction Whether the call was inbound or outbound

Available options:

inbound,

outbound

start

string<date-time>

Only calls that started after this date until the end date or now

end

string<date-time>

Only calls that started up to this date

limit

number

Number of items to return (max 50)

page

number

Page number

Response

A paginated list of calls

data

object[]

required

Show child attributes

total

number

required

The total number of calls

Example:

1

links

object

Show child attributes

Messages

Calls

Contacts

Campaigns

Pipelines

Knowledge Base

Twilio

API Reference

Admin

Inboxes

Programs

Opt-outs

Find calls

Authorizations

Query Parameters

Response