Skip to content

Get phone number history across the organization

call.phone_history() -> 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

class CallPhoneHistoryResponse { phone_history }

phone_history: Hash[Symbol, { campaigns, count, do_not_contact, 4 more}]

campaigns: Array[{ id, name}]

id: String

name: String

count: Float

do_not_contact: bool

hot: bool

last_called_at: String

last_outcome: :not_interested | :interested | :completed | :requested_callback_later

One of the following:

:not_interested

:interested

:completed

:requested_callback_later

reached_human: bool

Get phone number history across the organization

require "revox"

revox = Revox::Client.new(api_key: "My API Key")

response = revox.call.phone_history

puts(response)

{
  "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
    }
  }
}