ForwardCall command

The ForwardCall command forwards the call by ID to another destination while the call is in ringing state. A great example for its command is the case when the boss is on a meeting and gets a call but can't answer it. This command forwards the call to the secretary.

Request parameters

Parameter name	Example value	Description	Mandatory
CallId	345fad34	The ID of the call which will be forwarded. If this command is in a response to a call notification, this parameter will be the ID of that call and can be omitted.	no
Destination	500	The number where the call will be forwarded to.	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

This simple example will forward the call to extension number 102.

<?xml version="1.0"?>
<Response>
    <ForwardCall Destination="102"></ForwardCall>
</Response>

Example request and response

URL request

http://127.0.0.1:9509/api?command=ForwardCall&CallId=Nt3uh&Destination=104&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>