Vonage Business

App · 20 actions

Work with your Vonage Business phone system: look up users and extensions, read call logs, place, park and end calls, and find, read and delete call recordings and transcriptions.

Actions

ActionWhat it does
Delete company recordingDelete a company recording for good.
Delete user's recordingDelete an on-demand recording a user made, for good.
End callHang up a call in progress.
Get accountGet the connected Vonage Business account: its number, name, status and address.
Get active callGet one call in progress with its status and legs.
Get company recordingGet one company recording with its call details and download address.
Get extensionGet one extension with its user, caller ID, phone numbers, handsets and Do Not Disturb setting.
Get userGet one user with their email, login name, contact numbers and extensions.
Get user's recordingGet one on-demand recording a user made, with its call details and download address.
List active callsList calls in progress right now, with their legs, for the account or one extension.
List call logsList finished calls in the account: who called whom, when, for how long, the result and whether it was recorded.
List company recordingsList calls recorded by the account's call recording rules, newest first, with each recording's length and download address.
List extensionsList the account's extensions with their users, caller IDs, phone numbers and handsets.
List locationsList the account's locations (sites), with their addresses and time zones.
List registered devicesList the account's desk phones and other devices, with their addresses and when each last registered.
List transcriptionsList transcriptions of company recordings, with whether each is ready and the address to read it from.
List user's recordingsList the calls one user recorded themselves (on-demand recordings), newest first.
List usersList the account's users with their contact numbers and extensions, optionally filtered by name, login name or email.
Park or unpark callPark a call in progress so anyone can pick it up, or take a parked call off park.
Place callClick-to-dial: ring an extension's phone, and when it is picked up, call a phone number or another extension from it.

Delete company recording

Delete a company recording for good.

Inputs

Recording IDrecording_idtextRequired
The recording's id, from a list of recordings or an earlier step.

Outputs

deletedtrue/false
True once deleted
recording_idtext
The recording deleted
Example output
{
  "deleted": true,
  "recording_id": "193228"
}

Delete user's recording

Delete an on-demand recording a user made, for good.

Inputs

Uservbc_user_idtextRequired
The Vonage Business user. Pick one, or give their id from an earlier step.
Recording IDrecording_idtextRequired
The recording's id, from a list of recordings or an earlier step.

Outputs

deletedtrue/false
True once deleted
recording_idtext
The recording deleted
user_idtext
Whose recording it was
Example output
{
  "deleted": true,
  "recording_id": "193228",
  "user_id": "869048"
}

End call

Hang up a call in progress.

Inputs

Call IDcall_idtextRequired
The id of a call in progress, from 'List active calls' or 'Place call'.

Outputs

call_idtext
The call's id
call_statetext
The call's state now
destinationtext
Where the call is connected
endedtrue/false
True once Vonage ends it
Example output
{
  "call_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "call_state": "",
  "destination": "",
  "ended": true
}

Get account

Get the connected Vonage Business account: its number, name, status and address.

Inputs

None.

Outputs

accountobject
The account
Example output
{
  "account": {
    "address": {
      "address_1": "123 Example Street",
      "address_2": "Suite 4",
      "city": "Holmdel",
      "country": "US",
      "postal_code": "07733",
      "state": "NJ"
    },
    "id": 571700,
    "name": "Example Co",
    "status": "ACTIVE"
  }
}

Get active call

Get one call in progress with its status and legs.

Inputs

Call IDcall_idtextRequired
The id of a call in progress, from 'List active calls' or 'Place call'.

Outputs

callobject
The call
Example output
{
  "call": {
    "account_id": "571700",
    "call_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "direction": "outbound",
    "end_time": "",
    "from": "1001",
    "legs": [
      {
        "account_id": "571700",
        "call_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "direction": "outbound",
        "end_time": "",
        "from": "1001",
        "leg_id": "3fa85f64-5717-4562-b3fc-2c963f66afa7",
        "start_time": "1762351200",
        "status": "on-call",
        "to": "14155550100"
      }
    ],
    "start_time": "1762351200",
    "status": "on-call",
    "to": "14155550100"
  }
}

Get company recording

Get one company recording with its call details and download address.

Inputs

Recording IDrecording_idtextRequired
The recording's id, from a list of recordings or an earlier step.

Outputs

recordingobject
The recording
Example output
{
  "recording": {
    "call_direction": "INBOUND",
    "call_id": "c91150a6-8cc4-4e73-9fef-17fd925c6448",
    "caller_id": "17325550100",
    "cnam": "JOHN SMITH",
    "dnis": "14155550100",
    "download_url": "https://api.vonage.com/t/vbc.prod/call_recording/api/audio/recording/193228",
    "duration": 60000,
    "end": "2026-11-05T14:01:00+0000",
    "extensions": [
      "1001"
    ],
    "file_name": "730048.11826465111463122315701.95a7584be",
    "file_size_in_bytes": 100000,
    "id": 193228,
    "rule_ids": [
      1989
    ],
    "start": "2026-11-05T14:00:00+0000"
  }
}

Get extension

Get one extension with its user, caller ID, phone numbers, handsets and Do Not Disturb setting.

Inputs

ExtensionextensiontextRequired
The extension. Pick one, or give its number, like 1001.

Outputs

extensionobject
The extension
Example output
{
  "extension": {
    "block_caller_id": false,
    "caller_id": "Jo Bloggs",
    "dids": [
      {
        "custom_tag": "Sales",
        "phone_number": "14155550100"
      }
    ],
    "dnd_enabled": false,
    "extension_handsets": [
      {
        "handset_name": "line1-VH1111111",
        "sip_id": "VH1111111"
      }
    ],
    "extension_number": "1001",
    "external_id": "abc11111111111",
    "location_id": 327910,
    "service_type_name": "UX",
    "user": {
      "email": "jo.bloggs@example.com",
      "first_name": "Jo",
      "id": 869048,
      "last_name": "Bloggs",
      "login_name": "jbloggs"
    },
    "vtt_enabled": true
  }
}

Get user

Get one user with their email, login name, contact numbers and extensions.

Inputs

Uservbc_user_idtextRequired
The Vonage Business user. Pick one, or give their id from an earlier step.

Outputs

userobject
The user
Example output
{
  "user": {
    "contact_numbers": [
      {
        "type": "Mobile",
        "value": "14155550101"
      }
    ],
    "email": "jo.bloggs@example.com",
    "extensions": [
      {
        "dids": [
          {
            "custom_tag": "Sales",
            "phone_number": "14155550100"
          }
        ],
        "extension_number": "1001"
      }
    ],
    "first_name": "Jo",
    "id": 869048,
    "last_name": "Bloggs",
    "login_name": "jbloggs"
  }
}

Get user's recording

Get one on-demand recording a user made, with its call details and download address.

Inputs

Uservbc_user_idtextRequired
The Vonage Business user. Pick one, or give their id from an earlier step.
Recording IDrecording_idtextRequired
The recording's id, from a list of recordings or an earlier step.

Outputs

recordingobject
The recording
Example output
{
  "recording": {
    "call_direction": "INBOUND",
    "call_id": "c91150a6-8cc4-4e73-9fef-17fd925c6448",
    "caller_id": "17325550100",
    "cnam": "JOHN SMITH",
    "dnis": "14155550100",
    "download_url": "https://api.vonage.com/t/vbc.prod/call_recording/api/audio/recording/193228",
    "duration": 60000,
    "end": "2026-11-05T14:01:00+0000",
    "extensions": [
      "1001"
    ],
    "file_name": "730048.11826465111463122315701.95a7584be",
    "file_size_in_bytes": 100000,
    "id": 193228,
    "rule_ids": [
      1989
    ],
    "start": "2026-11-05T14:00:00+0000"
  }
}

List active calls

List calls in progress right now, with their legs, for the account or one extension. Finished calls are in 'List call logs'.

Inputs

Extensionextensiontext
Only calls on this extension. Leave empty for every extension.
Orderordertext
Newest or oldest first. Defaults to newest first.One of: desc (Newest first), asc (Oldest first).
How manypage_sizenumber
The most to return, 1 to 100. Vonage's default is 100.From 1 to 100.

Outputs

callslist
The calls in progress
countnumber
How many
Example output
{
  "calls": [
    {
      "account_id": "571700",
      "call_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "direction": "outbound",
      "end_time": "",
      "from": "1001",
      "legs": [
        {
          "account_id": "571700",
          "call_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "direction": "outbound",
          "end_time": "",
          "from": "1001",
          "leg_id": "3fa85f64-5717-4562-b3fc-2c963f66afa7",
          "start_time": "1762351200",
          "status": "on-call",
          "to": "14155550100"
        }
      ],
      "start_time": "1762351200",
      "status": "on-call",
      "to": "14155550100"
    }
  ],
  "count": 1
}

List call logs

List finished calls in the account: who called whom, when, for how long, the result and whether it was recorded.

Inputs

Started on or afterstart_fromdate and time
Only calls that started at or after this time.
Started on or beforestart_todate and time
Only calls that started at or before this time.
Directiondirectiontext
Only inbound or only outbound calls. Leave empty for both.One of: Inbound, Outbound.
From numberfrom_numbertext
Only calls from this number, like 17325550100.
To numberto_numbertext
Only calls to this number, like 14155550100.
Made by usersource_usertext
Only calls made by the user with this login name.
Received by userdestination_usertext
Only calls received by the user with this login name.
Pagepagenumber
Which page to return, from 1. Defaults to the first.At least 1.
Page sizepage_sizenumber
How many to return per page, 1 to 100. Vonage's default is 10.From 1 to 100.

Outputs

call_logslist
The finished calls
countnumber
How many on this page
has_moretrue/false
True when there is a page after this one
pagenumber
This page's number, from 1
total_itemsnumber
How many there are in all
total_pagesnumber
How many pages there are
Example output
{
  "call_logs": [
    {
      "charge": 0,
      "custom_tag": "Sales",
      "destination_device_name": "Desk phone",
      "destination_extension": 1001,
      "destination_sip_id": "VH1111111",
      "destination_user": "jbloggs",
      "destination_user_full_name": "Jo Bloggs",
      "direction": "Inbound",
      "end": "2026-11-05 14:01:00",
      "from": "17325550100",
      "id": "f27b937d-6dde-441a-9595-006e7302eac1",
      "in_network": false,
      "international": false,
      "length": 60,
      "rate": 0,
      "recorded": true,
      "result": "Answered",
      "source_device_name": "",
      "source_extension": 0,
      "source_sip_id": "",
      "source_user": "",
      "source_user_full_name": "",
      "start": "2026-11-05 14:00:00",
      "to": "14155550100"
    }
  ],
  "count": 1,
  "has_more": false,
  "page": 1,
  "total_items": 1,
  "total_pages": 1
}

List company recordings

List calls recorded by the account's call recording rules, newest first, with each recording's length and download address.

Inputs

Directiondirectiontext
Only inbound, outbound or internal calls. Leave empty for all.One of: INBOUND, OUTBOUND, INTRA_PBX (Between extensions).
Extensionextensiontext
Only recordings on this extension.
Caller numbercaller_idtext
Only recordings of calls from this caller ID, like 17325550100.
Started on or afterstart_fromdate and time
Only recordings of calls that started at or after this time.
Started on or beforestart_todate and time
Only recordings of calls that started at or before this time.
Call IDcall_idtext
Only the recording of this call.
At least (seconds)min_secondsnumber
Only recordings this many seconds long or longer.At least 0.
At most (seconds)max_secondsnumber
Only recordings this many seconds long or shorter.At least 0.
Pagepagenumber
Which page to return, from 1. Defaults to the first.At least 1.
Page sizepage_sizenumber
How many to return per page, 1 to 100. Vonage's default is 10.From 1 to 100.

Outputs

countnumber
How many on this page
has_moretrue/false
True when there is a page after this one
pagenumber
This page's number, from 1
recordingslist
The recordings
total_itemsnumber
How many there are in all
total_pagesnumber
How many pages there are
Example output
{
  "count": 1,
  "has_more": false,
  "page": 1,
  "recordings": [
    {
      "call_direction": "INBOUND",
      "call_id": "c91150a6-8cc4-4e73-9fef-17fd925c6448",
      "caller_id": "17325550100",
      "cnam": "JOHN SMITH",
      "dnis": "14155550100",
      "download_url": "https://api.vonage.com/t/vbc.prod/call_recording/api/audio/recording/193228",
      "duration": 60000,
      "end": "2026-11-05T14:01:00+0000",
      "extensions": [
        "1001"
      ],
      "file_name": "730048.11826465111463122315701.95a7584be",
      "file_size_in_bytes": 100000,
      "id": 193228,
      "rule_ids": [
        1989
      ],
      "start": "2026-11-05T14:00:00+0000"
    }
  ],
  "total_items": 1,
  "total_pages": 1
}

List extensions

List the account's extensions with their users, caller IDs, phone numbers and handsets.

Inputs

Locationlocation_idtext
Only extensions at this location.
Phone numberphone_numbertext
Only the extension with this phone number, like 14155550100.
Login namelogin_nametext
Only extensions of the user with this login name.
Emailemailtext
Only extensions of the user with this email address.
Pagepagenumber
Which page to return, from 1. Defaults to the first.At least 1.
Page sizepage_sizenumber
How many to return per page, 1 to 100. Vonage's default is 10.From 1 to 100.

Outputs

countnumber
How many on this page
extensionslist
The extensions
has_moretrue/false
True when there is a page after this one
pagenumber
This page's number, from 1
total_itemsnumber
How many there are in all
total_pagesnumber
How many pages there are
Example output
{
  "count": 1,
  "extensions": [
    {
      "block_caller_id": false,
      "caller_id": "Jo Bloggs",
      "dids": [
        {
          "custom_tag": "Sales",
          "phone_number": "14155550100"
        }
      ],
      "dnd_enabled": false,
      "extension_handsets": [
        {
          "handset_name": "line1-VH1111111",
          "sip_id": "VH1111111"
        }
      ],
      "extension_number": "1001",
      "external_id": "abc11111111111",
      "location_id": 327910,
      "service_type_name": "UX",
      "user": {
        "email": "jo.bloggs@example.com",
        "first_name": "Jo",
        "id": 869048,
        "last_name": "Bloggs",
        "login_name": "jbloggs"
      },
      "vtt_enabled": true
    }
  ],
  "has_more": false,
  "page": 1,
  "total_items": 1,
  "total_pages": 1
}

List locations

List the account's locations (sites), with their addresses and time zones.

Inputs

None.

Outputs

countnumber
How many on this page
has_moretrue/false
True when there is a page after this one
locationslist
The locations
pagenumber
This page's number, from 1
total_itemsnumber
How many there are in all
total_pagesnumber
How many pages there are
Example output
{
  "count": 1,
  "has_more": false,
  "locations": [
    {
      "address": {
        "address_1": "123 Example Street",
        "address_2": "Suite 4",
        "city": "Holmdel",
        "country": "US",
        "postal_code": "07733",
        "state": "NJ",
        "time_zone": "America/New_York"
      },
      "id": 327910,
      "name": "Headquarters"
    }
  ],
  "page": 1,
  "total_items": 1,
  "total_pages": 1
}

List registered devices

List the account's desk phones and other devices, with their addresses and when each last registered.

Inputs

Orderordertext
Newest or oldest first. Defaults to newest first.One of: desc (Newest first), asc (Oldest first).
How manypage_sizenumber
The most to return, 1 to 100. Vonage's default is 100.From 1 to 100.

Outputs

countnumber
How many
deviceslist
The devices
Example output
{
  "count": 1,
  "devices": [
    {
      "account_id": "571700",
      "device_ip": "203.0.113.17",
      "last_request": "1762351200",
      "last_success": "1762351200",
      "mac_address": "79-5C-7D-28-1B-B3",
      "provisioned": {
        "last_request": "1762351200",
        "last_success": "1762351200"
      },
      "registration": {
        "last_success": "1762351200"
      }
    }
  ]
}

List transcriptions

List transcriptions of company recordings, with whether each is ready and the address to read it from.

Inputs

Only ready onesready_onlytrue/false
Turn on for only transcriptions that are ready to read.
Directiondirectiontext
Only inbound, outbound or internal calls. Leave empty for all.One of: INBOUND, OUTBOUND, INTRA_PBX (Between extensions).
Extensionextensiontext
Only recordings on this extension.
Caller numbercaller_idtext
Only recordings of calls from this caller ID, like 17325550100.
Started on or afterstart_fromdate and time
Only recordings of calls that started at or after this time.
Started on or beforestart_todate and time
Only recordings of calls that started at or before this time.
Pagepagenumber
Which page to return, from 1. Defaults to the first.At least 1.
Page sizepage_sizenumber
How many to return per page, 1 to 100. Vonage's default is 10.From 1 to 100.

Outputs

countnumber
How many on this page
has_moretrue/false
True when there is a page after this one
pagenumber
This page's number, from 1
total_itemsnumber
How many there are in all
total_pagesnumber
How many pages there are
transcriptionslist
The transcriptions
Example output
{
  "count": 1,
  "has_more": false,
  "page": 1,
  "total_items": 1,
  "total_pages": 1,
  "transcriptions": [
    {
      "call_date": "2026-11-05T14:00:00+0000",
      "call_id": "c91150a6-8cc4-4e73-9fef-17fd925c6448",
      "caller_id": "17325550100",
      "cnam": "JOHN SMITH",
      "direction": "INBOUND",
      "dnis": "14155550100",
      "duration": 60000,
      "recording_id": 193228,
      "transcription_error": "",
      "transcription_ready": true,
      "transcription_url": "https://api.vonage.com/t/vbc.prod/call_recording/api/transcription/193228"
    }
  ]
}

List user's recordings

List the calls one user recorded themselves (on-demand recordings), newest first.

Inputs

Uservbc_user_idtextRequired
The Vonage Business user. Pick one, or give their id from an earlier step.
Directiondirectiontext
Only inbound, outbound or internal calls. Leave empty for all.One of: INBOUND, OUTBOUND, INTRA_PBX (Between extensions).
Extensionextensiontext
Only recordings on this extension.
Caller numbercaller_idtext
Only recordings of calls from this caller ID, like 17325550100.
Started on or afterstart_fromdate and time
Only recordings of calls that started at or after this time.
Started on or beforestart_todate and time
Only recordings of calls that started at or before this time.
Call IDcall_idtext
Only the recording of this call.
At least (seconds)min_secondsnumber
Only recordings this many seconds long or longer.At least 0.
At most (seconds)max_secondsnumber
Only recordings this many seconds long or shorter.At least 0.
Pagepagenumber
Which page to return, from 1. Defaults to the first.At least 1.
Page sizepage_sizenumber
How many to return per page, 1 to 100. Vonage's default is 10.From 1 to 100.

Outputs

countnumber
How many on this page
has_moretrue/false
True when there is a page after this one
pagenumber
This page's number, from 1
recordingslist
The recordings
total_itemsnumber
How many there are in all
total_pagesnumber
How many pages there are
Example output
{
  "count": 1,
  "has_more": false,
  "page": 1,
  "recordings": [
    {
      "call_direction": "INBOUND",
      "call_id": "c91150a6-8cc4-4e73-9fef-17fd925c6448",
      "caller_id": "17325550100",
      "cnam": "JOHN SMITH",
      "dnis": "14155550100",
      "download_url": "https://api.vonage.com/t/vbc.prod/call_recording/api/audio/recording/193228",
      "duration": 60000,
      "end": "2026-11-05T14:01:00+0000",
      "extensions": [
        "1001"
      ],
      "file_name": "730048.11826465111463122315701.95a7584be",
      "file_size_in_bytes": 100000,
      "id": 193228,
      "rule_ids": [
        1989
      ],
      "start": "2026-11-05T14:00:00+0000"
    }
  ],
  "total_items": 1,
  "total_pages": 1
}

List users

List the account's users with their contact numbers and extensions, optionally filtered by name, login name or email.

Inputs

First namefirst_nametext
Only users with this first name.
Last namelast_nametext
Only users with this last name.
Login namelogin_nametext
Only the user with this login name.
Emailemailtext
Only the user with this email address.
Pagepagenumber
Which page to return, from 1. Defaults to the first.At least 1.
Page sizepage_sizenumber
How many to return per page, 1 to 100. Vonage's default is 10.From 1 to 100.

Outputs

countnumber
How many on this page
has_moretrue/false
True when there is a page after this one
pagenumber
This page's number, from 1
total_itemsnumber
How many there are in all
total_pagesnumber
How many pages there are
userslist
The users
Example output
{
  "count": 1,
  "has_more": false,
  "page": 1,
  "total_items": 1,
  "total_pages": 1,
  "users": [
    {
      "contact_numbers": [
        {
          "type": "Mobile",
          "value": "14155550101"
        }
      ],
      "email": "jo.bloggs@example.com",
      "extensions": [
        {
          "dids": [
            {
              "custom_tag": "Sales",
              "phone_number": "14155550100"
            }
          ],
          "extension_number": "1001"
        }
      ],
      "first_name": "Jo",
      "id": 869048,
      "last_name": "Bloggs",
      "login_name": "jbloggs"
    }
  ]
}

Park or unpark call

Park a call in progress so anyone can pick it up, or take a parked call off park.

Inputs

Call IDcall_idtextRequired
The id of a call in progress, from 'List active calls' or 'Place call'.
DostatetextRequired
Park the call, or take it off park.One of: parked (Park the call), active (Take the call off park).

Outputs

call_idtext
The call's id
call_statetext
The call's state now
destinationtext
Where the call is connected
Example output
{
  "call_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "call_state": "parked",
  "destination": ""
}

Place call

Click-to-dial: ring an extension's phone, and when it is picked up, call a phone number or another extension from it.

Inputs

From extensionfrom_extensiontextRequired
The extension whose phone rings first and makes the call.
Callto_numbertextRequired
The phone number with its country code (like 14155550100), or the extension number to call.
Callingto_typetext
Whether 'Call' is a phone number or an extension. Defaults to a phone number.One of: pstn (Phone number), extension. Default: pstn.

Outputs

call_idtext
The new call's id
from_extensiontext
The extension that makes the call
totext
The number or extension called
to_typetext
pstn for a phone number, extension for an extension
Example output
{
  "call_id": "e2610a31-88be-4f12-90c0-ee98dbfaf80b",
  "from_extension": "1001",
  "to": "14155550100",
  "to_type": "pstn"
}

On this page