Reports API

The Vonage Business Communications Reports API enables you to retrieve call logs for your account.

Your application must subscribe to the Reports API suite to use this API.

Available Operations:

get Retrieve call logs for your account

Retrieve call logs for your account

GET


        https://api.vonage.com/t/vbc.prod/reports/accounts/:account_id/call-logs

Host


        https://api.vonage.com

GET


        /t/vbc.prod/reports/accounts/:account_id/call-logs

Authentication

Key	Description	Example	Default
Authorization	Your OAuth token. Read more about OAuth tokens	`Bearer <access_token>`	None

Path Parameters

account_id

string | Required

The Vonage Business Communications account ID

Query Parameter

start:gte

string | Required

Filter records by start date (greater equal or equal to) [yyyy-MM-dd HH:mm:ss in UTC]

start:lte

string | Required

Filter records by start date (less equal or equal to) [yyyy-MM-dd HH:mm:ss in UTC]

end:gte

string

Filter records by end date (greater equal or equal to) [yyyy-MM-dd HH:mm:ss in UTC]

end:lte

string

Filter records by end date (less equal or equal to) [yyyy-MM-dd HH:mm:ss in UTC]

page_size

number | Default: 10

Number of records per page

page

number | Default: 1

Current page number

string

Filter by called number

from

string

Filter by source number

source_user

string

Filter by source user

destination_user

string

Filter by destination user

direction

string

Filter by call direction.

Must be one of: Inbound or Outbound

Responses

200 Success

page_size

number

Number of records per page

page

number

Current page number

total_pages

number

Total number of pages

total_items

number

Total number of records

_embedded

object

array of objects

string

Unique identifier of the call

boolean

Indicates if call was on/off network

boolean

Indicates if call was international

string

Source number of the call

string

Destination number of the call

string

Direction of the call

number

Duration of the call in seconds

string

Start time of the call

string

End time of the call

number

Amount charged for the call

number

Rate charged for the call

string

Name of the destination device of the call

string

Full name of the destination user of the call

string

Destination user of the call

string

SIP ID of the destination device of the call

number

Destination extension of the call

string

Name of the source device of the call

string

Full name of the source user of the call

string

Source user of the call

string

Custom tag added to caller id

string

SIP ID of the source device of the call

number

Source extension of the call

string

Result of the call

boolean

Indicates if call was recorded

Example Responses

200 400

{
  "page_size": 10,
  "page": 1,
  "total_pages": 10,
  "total_items": 100,
  "_links": {
    "first": {
      "href": "abc123"
    },
    "prev": {
      "href": "abc123"
    },
    "self": {
      "href": "abc123"
    },
    "next": {
      "href": "abc123"
    }
  },
  "_embedded": {
    "call_logs": [
      {
        "id": "f27b937d-6dde-441a-9595-006e7302eac1",
        "in_network": true,
        "international": false,
        "from": 17325550100,
        "to": 17325550100,
        "direction": "Inbound",
        "length": 60,
        "start": "2019-01-01 00:00:00",
        "end": "2019-01-01 00:00:00",
        "charge": 0,
        "rate": 0,
        "destination_device_name": "Smith",
        "destination_user_full_name": "John Smith",
        "destination_user": "JSmith",
        "destination_sip_id": "VH1111111",
        "destination_extension": 1000,
        "source_device_name": "Smith",
        "source_user_full_name": "John Smith",
        "source_user": "JSmith",
        "custom_tag": "Sales",
        "source_sip_id": "VH1111111",
        "source_extension": 1000,
        "result": "Answered",
        "recorded": true
      }
    ]
  }
}

{
  "status": 1,
  "title": "abc123",
  "instance": "abc123",
  "invalid_parameters": [
    {
      "name": "abc123",
      "reason": "abc123"
    }
  ]
}