Play a Group Voicemail Greeting

Play a group voicemail greeting.

Steps to play a group vociemail greeting

  1. Get the play URL of a greeting
  2. Download and play the greeting

Request URL

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

Request parameters

Parameter Required Type Description
extension Yes String The extension number.
Note: You can query the extension number using Search Specific Extensions.
file Yes String The full filename (including the file extension) of the greeting to be played.
Note: You can query the full filename of the greeting using Query Group 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).
play_resource_url String The play URL of the greeting.
Note: The play URL is only valid for 30 minutes.

Examples

Request example

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

GET /openapi/v1.0/vm_greeting/play?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",
    "play_resource_url": "/api/download/PBX-VoicemailGreeting-83.23.0.x-download-20260512105718-NaXXXXXXXXXXXP9O.wav"
}

Download and play the greeting

After obtaining the play URL for the greeting, combine it with the {base_url}. Then use the complete link to download the greeting and play locally.

Play link format

{base_url}/{play_resource_url}

Play link example

https://192.168.5.150:8088/api/download/PBX-VoicemailGreeting-83.23.0.x-download-20260512105718-NaXXXXXXXXXXXP9O.wav