Download a Group Voicemail Greeting

Download a group voicemail greeting.

Steps to download a group voicemail greeting

  1. Get the download URL of a greeting
  2. Download the greeting

Request URL

GET {base_url}/{api_path}/vm_greeting/download?access_token={access_token}

Request parameters

Parameter Required Type Description
extension Yes String The number of the group voicemail.
Note: You can query the number of the group voicemail using Query Group Voicemail List.
file Yes String The full filename (including the file extension) of the greeting to be download.
Note: You can query the full filename of the voicemail greeting using Query Extension Voicemail Greeting List.

Response parameters

Parameter Type Description
errcode Integer Returned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsg String Returned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.
file String The greeting full filename (including the file extension).
download_resource_url String The download URL of the greeting.
Note: The download URL is only valid for 30 minutes.

Examples

Request example

Obtain the download URL of a greeting (full filename: group_vm_welcome.wav), which belongs to the voicemail group (number: 6300).

GET /openapi/v1.0/vm_greeting/download?access_token=VZxAbA2kfB6o6eBEh2XJTxIi8auE3KCC&extension=6300&file=group_vm_welcome.wav HTTP/1.1 
Host: 192.168.5.150:8088
User-Agent: OpenAPI

Response example

HTTP/1.1 200 OK

{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "file": "group_vm_welcome.wav",
    "download_resource_url": "/api/download/PBX-VoicemailGreeting-83.23.0.x-download-20260512105717-37XXXXXXXXXXXP9O.wav"
}

Download the greeting

After obtaining the download URL for the greeting, combine it with the {base_url} and append the {access_token} parameter. Then, use the complete link to download the desired greeting.

Download link format

{base_url}/{download_resource_url}?access_token={access_token}

Download link example

https://192.168.5.150:8088/api/download/PBX-VoicemailGreeting-83.23.0.x-download-20260512105717-37XXXXXXXXXXXP9O.wav?access_token=MB1OklPar5hnDfhi4srZa8FrZ4znFSzr