Skip to Content

Forward an Incoming Call to Voicemail

Forward an incoming call to the voicemail of either the called party's own extension or another specified extension.

Request URL

POST {base_url}/{api_path}/call/directly_forward_to_voicemail?access_token={access_token}

Request parameters

ParameterRequiredTypeDescription
callee_channelYesStringThe call channel ID of the callee.
Note: You can obtain the call channel ID in the (30011) Call State Changed event.
numberYesStringThe target extension number.

The call will be forward to the extension's voicemail.

Response parameters

ParameterTypeDescription
errcodeIntegerReturned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsgStringReturned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.
call_idStringThe unique ID of each call.

Examples

Request example

POST /openapi/v1.0/call/directly_forward_to_voicemail?access_token=EQRuteleNDuN2q914CvJ07ua25Qo84uu HTTP/1.1
Host: 192.168.5.150:8088
Content-Type: application/json
{
    "callee_channel": "PJSIP/1001-00000076",
    "number": "1000"
}

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "call_id": "1758505980.197"
}