1. Teleboard | Support Center
  2. Solution home
  3. API Documentation
  4. REST API - POST Requests
Open navigation

POST/voicemail/call

Function


The POST/voicemail/call request redirects a call to a user's voicemail box, based on the the provided authorization credentials. For this to work, the redirected call must be placed using the post/send/call method in order for the call to be identified with a unique ID.


Parameters


There are no parameters in the header. All parameters go in the body in JSON Raw format.


ParameterTypeOperation
uniqueidstringA unique ID number for the call. This need to be obtained from the uniqueid field in the response received from the post/send/call request, once the call is placed from that method. You may also use the get/active/calls request for this.

Example


To redirect a call to a user's voicemail box use this syntax:


HTTPS method: POST


Header


webserv.telebroad.com/api/teleconsole/rest/voicemail/call


Body


{"uniqueid":"1519784628.70134037"}


Response:


If the call was redirected successfully:


{

    "error": null,

    "result": "1"

}



If there was a problem redirecting the call (usually due to wrong uniqueid or if the call has already ended):


{

    "error":{

        "code": 444,

        "message": "The call does not exist."

    }

}