Difference between revisions of "Get the List of Voicemail Details"

From docs
Jump to: navigation, search
(Created page with "== Get Recorded Voicemail Details == === Base URL === https://apimobile.callproof.com === Endpoint === /api/voicemail/recorded/{phone_number} === Purpose === Retrieves the...")
 
(Get Recorded Voicemail Details)
Line 1: Line 1:
== Get Recorded Voicemail Details ==
+
== [[Mobile_API]] »Get Recorded Voicemail Details ==
  
 
=== Base URL ===
 
=== Base URL ===

Revision as of 06:16, 21 July 2026

Mobile_API »Get Recorded Voicemail Details

Base URL

https://apimobile.callproof.com

Endpoint

/api/voicemail/recorded/{phone_number}

Purpose

Retrieves the recorded greeting/voicemail file details for a company Twilio phone number. Returns the recording identifier and a media URL when a voicemail recording is available for that number.

HTTP Method

GET

Headers

Header Required Description
Authorization Yes Bearer access token

Security

  • Yes – Requires Bearer Token authentication.

Parameters

Path Parameters

Parameter Type Required Description
phone_number string Yes Twilio phone number whose recorded voicemail details should be retrieved

Query Parameters

None.

Request Body

None.

Successful Response (200)

Returns recorded voicemail details for the phone number. If no matching number/recording is found, data may be an empty array.

Field Type Description
clientStatusCode integer Status indicator for the client (for example, 200)
user_id integer Identifier of the authenticated user
company_id integer Identifier of the authenticated user’s company
data array Recorded voicemail details (see below)
uri string Requested resource URI

data[]

Field Type Description
id integer Unique identifier of the Twilio phone number record
url string Full media URL of the recorded voicemail file

Error Responses

Status Code Meaning
400 Bad Request – recorded voicemail details could not be retrieved
401 Unauthorized – missing, invalid, or expired Bearer token
  • 400 – An error occurred while retrieving recorded voicemail details (for example, "Error while retrieving the recorded voicemail messages list").
  • 401 – Authentication failed or the access token is missing/expired.