Unhold command

The Unhold command is used to put both legs of the call to InCall state. It only works if a Hold command was initiated to hold both legs of the call. It is used the reverse the effect of the Hold command.

Request parameters

Parameter name Example value Description Mandatory
CallId 345fad34 ID of the call to unhold.If this command is in a response to a call notification, this parameter will be the ID of that call and can be omitted. yes
Username admin Specifies the username. The username and password parameters are used to authenticate the user. yes
Password abc123 Specifies the password. The username and password parameters are used to authenticate the user. yes

Response parameters

Parameter name Example value Description Mandatory
Code 200 Returns the status code of the response. yes
Message Command successfully executed Returns th description of the response code. yes
NotificationName CallConnected Name of the notification request type. no

OzML example

With this very simple OzML example script you can put a call out from the Hold state. In this case, the script unholds the call with the ID '23Xdz7'. 

<?xml version="1.0"?>
<Response>
    <Unhold CallId="23Xdz7"></Unhold>
</Response>

Example request and response

URL request

http://127.0.0.1:9509/api?command=Unhold&CallId=Nt3uh&Username=HTTP_User_1&Password=qwe123

Response

<?xml version="1.0"?>
<Response xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Code>200</Code>
  <Message>Command successfully executed</Message>
</Response>

More information