BlindTransfer command

The BlindTransfer command blind transfers the other party of the API extension call to a target number. It can be also used to connect two phones together. If the connection is established, the phone which connected the phones together will leave the conversation. It is commonly used when the IVR can't answer the customer query, so the customer is transferred to the helpdesk staff. It also has great usage when making a callback request.

Request parameters

Parameter name Example value Description Mandatory
CallId 345fad34 ID of the call to transfer from. 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
TranferorParty caller The party of the call who will make the transfer. It can be caller or callee. no
Target 100 Target party of the blind transfer process. yes
FinishedUrl http://yourapp.com/callfinished.php The PBX will issue an HTTP request to this specified url when the transferred call ends. no
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 OzML example below shows the common usage of the BlindTransfer command. first, the caller will hear the 'You will be blind transfered to 102 in 1 seconds.' sentence by the Speak command, and after a second of Delay, the BlindTransfer command will be executed. If the transfer was unsuccessful, the 'Sorry, but blind transfer failed to extension 102.' sentence will be read out. 

<?xml version="1.0"?>
<Response>
    <Speak>You will be blind transfered to 102 in 1 seconds.</Speak>
    <Delay>1</Delay>
    <BlindTransfer>102</BlindTransfer>
    <Speak>Sorry, but blind transfer failed to extension 102</Speak>
</Response>

Example request and response

URL request

http://127.0.0.1:9509/api?command=BlindTransfer&CallId=Nt3uh&TransferorParty=caller&Target=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>

More information