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.

Download OpenAPI Specification
Available Operations

Retrieve call logs for your account

Retrieve call logs for your account

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

Authentication

KeyDescriptionWhereExample
Authorization

Your OAuth token.
Read more about OAuth tokens

Headers

Bearer <access_token>

Path Parameters

account_id
string
Required

The Vonage Business Communications account ID

Query Parameters

start:gte
string

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

start:lte
string

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
Default10

Number of records per page

page
number
Default1

Current page number

to
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:InboundOutbound

Responses
Content Type
application/json

Success

page_size
number
example10

Number of records per page

page
number
example1

Current page number

total_pages
number
example10

Total number of pages

total_items
number
example100

Total number of records

_links
object
first
object

URL to the first page of records

href
string
prev
object

URL to the previous page of records

href
string
self
object

URL to the current page of records

href
string
next
object

URL to the next page of records

href
string
_embedded
object
call_logs
array
id
string
examplef27b937d-6dde-441a-9595-006e7302eac1

Unique identifier of the call

in_network
boolean
exampletrue

Indicates if call was on/off network

international
boolean

Indicates if call was international

from
string
example17325550100

Source number of the call

to
string
example17325550100

Destination number of the call

direction
string
exampleInbound

Direction of the call

length
number
example60

Duration of the call in seconds

start
string
example2019-01-01 00:00:00

Start time of the call

end
string
example2019-01-01 00:00:00

End time of the call

charge
number

Amount charged for the call

rate
number

Rate charged for the call

destination_device_name
string
exampleSmith

Name of the destination device of the call

destination_user_full_name
string
exampleJohn Smith

Full name of the destination user of the call

destination_user
string
exampleJSmith

Destination user of the call

destination_sip_id
string
exampleVH1111111

SIP ID of the destination device of the call

destination_extension
number
example1000

Destination extension of the call

source_device_name
string
exampleSmith

Name of the source device of the call

source_user_full_name
string
exampleJohn Smith

Full name of the source user of the call

source_user
string
exampleJSmith

Source user of the call

custom_tag
string
exampleSales

Custom tag added to caller id

source_sip_id
string
exampleVH1111111

SIP ID of the source device of the call

source_extension
number
example1000

Source extension of the call

result
string
exampleAnswered

Result of the call

recorded
boolean
exampletrue

Indicates if call was recorded

Example Response

{
   "page_size": 10,
   "page": 1,
   "total_pages": 10,
   "total_items": 100,
   "_links": {
      "first": {
         "href": "string"
      },
      "prev": {
         "href": "string"
      },
      "self": {
         "href": "string"
      },
      "next": {
         "href": "string"
      }
   },
   "_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
         }
      ]
   }
}