Voicemails

Voicemails report

Returns voicemails left on the account's DID numbers, newest first, as the Voicemails report in the portal: the DID number, caller ID, receive time, the email addresses the voicemail was sent to and the playback that was played. The transcription of a voicemail is returned by the show method. Without time_range the last 7 days are returned; a range can span at most 1 year. Results can be narrowed by DID number and caller ID (partial match). Pagination is by page and per_page (default 100, max 1000).

get/voicemails

Request

  • Base URL
    https://api.commpeak.com/portal
  • URL
    https://api.commpeak.com/portal/voicemails
  • Auth
    API key in header Authorization

Query parameters

time_rangestring nullable

Date range "YYYY-MM-DD - YYYY-MM-DD" (or a single date).

did_numberstring nullable

Filter by DID number in E.164 format.

clistring nullable

Filter by caller ID (partial match).

pageinteger nullable

Page number (default 1).

per_pageinteger nullable

Items per page (default 100, max 1000).

Response

Successful Response

pageinteger nullable

Current page.

per_pageinteger nullable

Items per page.

totalinteger nullable

Total number of items.

Example response

{
  "page": 1,
  "per_page": 100,
  "total": 1,
  "voicemails": [
    {
      "cli": "12125551235",
      "did_number": "12125551234",
      "id": 501,
      "received_at": "2026-10-20T15:42:00.000Z",
      "sent_to": [
        "test@example.com"
      ],
      "voicemail_playback_id": 3
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.