Hold command
With the Hold command, you can put both legs of the call into the Hold state. The state of the call can be changed back to InCall state with the Unhold command. This command only requires a single CallId parameter and when the command executed, both parties of this call will be put into the Hold state.
Request parameters
Parameter name | Example value | Description | Mandatory |
CallId | 345fad34 | ID of the call to hangup. 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 | The username of the account. 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 the description of the response code. | yes |
NotificationName | CallConnected | Name of the notification request type. | no |
OzML example
The next OzML script example puts the current call into Hold state. First, the Speak says to all participants, that the call will be put into Hold state, then the Hold command puts the call on hold.
<?xml version="1.0"?> <Response> <Speak Party="all">This call will be put on hold</Speak> <Hold></Hold> </Response>
Example request and response
URL request
http://127.0.0.1:9509/api?command=Hold&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
- AttendedTransfer command
- BlindTransfer command
- Call command
- ForwardCall command
- ListCallHistory command
- Hangup command
- Hold command
- ListActiveCalls command
- ListExtensions command
- ListExtensionTypes command
- Play command
- Record command
- Request command
- SendDTMF command
- Speak
- Unhold command
- ReceiveMessage command
- SendEmail command
- SendMessage command
- SendSMS command
- Array command
- Beep command
- Delay command
- DeleteFile command
- ForEach command
- GoTo command
- MoveFile command
- Reject command
- Route command
- SendAlarmNotification command
- SendMsg command
- UserInput command
- Var command
- WaitForMsg command
- CallSetup command
- Exit command
- ListAddressbokkContacts
- ListAddressbookNames command
- ReceiveAlarmNotification