Difference between revisions of "Get the List of Voicemail Details"
Ashley DeBon (talk | contribs) (→Get Recorded Voicemail Details) |
Ashley DeBon (talk | contribs) (→Successful Response (200)) |
||
| Line 37: | Line 37: | ||
==== Request Body ==== | ==== Request Body ==== | ||
None. | None. | ||
| + | |||
| + | === cURL Example for Android === | ||
| + | |||
| + | <pre> curl --location 'https://apimobile.callproof.com/api/voicemail/recorded/YOUR_PHONE_NUMBER' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre> | ||
| + | |||
| + | === cURL Example for iOS === | ||
| + | |||
| + | <pre> curl --location 'https://apimobile.callproof.com/api/voicemail/recorded/YOUR_PHONE_NUMBER' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre> | ||
=== Successful Response (200) === | === Successful Response (200) === | ||
Revision as of 06:18, 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.
cURL Example for Android
curl --location 'https://apimobile.callproof.com/api/voicemail/recorded/YOUR_PHONE_NUMBER' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
cURL Example for iOS
curl --location 'https://apimobile.callproof.com/api/voicemail/recorded/YOUR_PHONE_NUMBER' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
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.
