Skip to content

Get phone number history across the organization

client.call.phoneHistory(?): CallPhoneHistoryResponse { phone_history }

GET/calls/phone-history

Returns a map of phone numbers to the number of calls and associated campaigns across the entire organization. Useful for detecting contacts that have already been reached.

ReturnsExpand Collapse

CallPhoneHistoryResponse { phone_history }

phone_history: Record<string, PhoneHistory>

campaigns: Array<Campaign>

id: string

name: string

count: number

do_not_contact: boolean

hot: boolean

last_called_at: string | null

last_outcome: "not_interested" | "interested" | "completed" | "requested_callback_later" | null

One of the following:

"not_interested"

"interested"

"completed"

"requested_callback_later"

reached_human: boolean

Get phone number history across the organization

import Revox from '@revoxai/sdk';

const client = new Revox({
  apiKey: process.env['REVOX_API_KEY'], // This is the default and can be omitted
});

const response = await client.call.phoneHistory();

console.log(response.phone_history);

{
  "phone_history": {
    "foo": {
      "campaigns": [
        {
          "id": "id",
          "name": "name"
        }
      ],
      "count": 0,
      "do_not_contact": true,
      "hot": true,
      "last_called_at": "last_called_at",
      "last_outcome": "not_interested",
      "reached_human": true
    }
  }
}

Returns Examples

{
  "phone_history": {
    "foo": {
      "campaigns": [
        {
          "id": "id",
          "name": "name"
        }
      ],
      "count": 0,
      "do_not_contact": true,
      "hot": true,
      "last_called_at": "last_called_at",
      "last_outcome": "not_interested",
      "reached_human": true
    }
  }
}