Hangup command
The Hangup command can be used to disconnect a call by ID. It is best used if you want to hang the call up after a given menu point. For example: 'Congratulation! You subscribed to the golden package. Goodbye!' and then it hangs up. It also can be used by phone companies to hang up calls if the client has no more money in his phone account.
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 OzML script you can see below is a complete implementation of a very simple IVR system that contains the Hangup command. First, between the InitialCommands tags, the system reads out the opportunities where the user can choose from by pressing one of the keys. After the user pressed a key, the Speak command says Goodbye and the Hangup command will be activated to terminate the call.
<?xml version="1.0"?> <Response> <UserInput timeout="2" repeat="true"> <InitialCommands> <Speak>To subscribe to the silver package, press 1.</Speak> <Speak>To subscribe to the golden package, press 2.</Speak> </InitialCommands> <Inputs> <Input key="1"> <Speak>Congratulation! You subscribed to the silver package. Goodbye!</Speak> <Hangup></Hangup> </Input> <Input key="2"> <Speak>Congratulation! You subscribed to the golden package. Goodbye!</Speak> <Hangup></Hangup> </Input> </Inputs> </UserInput> </Response>
Example request and response
URL request
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
- Comando de transferencia asistida
- Comando de transferencia ciega
- Comando de llamada
- Comando de reenvío de llamada
- Comando para listar historial de llamadas
- Comando para colgar
- Comando para poner en espera
- Comando para listar llamadas activas
- Comando para listar extensiones
- Comando para listar tipos de extensión
- Comando para reproducir
- Comando para grabar
- Comando de solicitud
- Comando para enviar DTMF
- Hablar
- Comando para quitar de espera
- Comando para recibir mensaje
- Comando para enviar correo
- Comando para enviar mensaje
- Comando para enviar SMS
- Comando de arreglo
- Comando para emitir tono
- Comando para retraso
- Comando para eliminar archivo
- Comando para cada
- Comando para ir a
- Comando para mover archivo
- Comando para rechazar
- Comando para enrutar
- Comando para enviar notificación de alarma
- Comando para enviar mensaje
- Comando para entrada de usuario
- Comando para variable
- Comando para esperar mensaje
- Comando para configuración de llamada
- Comando para salir
- Listar contactos de agenda
- Comando para listar nombres de agenda
- Recibir notificación de alarma