Call
Transfer a call
This API enables an in-progress or ongoing call to fetch and execute XML from a different URL. If the call (the A leg) is in a Dial, you can also transfer the other party (the B leg) at the same time, or only transfer the B leg to a URL. This is useful for applications where you want to asynchronously change the behavior of a live call. For example, you can play music while a call is on hold, queue calls, or transfer calls.
API Endpoint
POST
Arguments
Parameter | Type | Description |
---|---|---|
legs | — | Valid values are aleg , bleg , or both . aleg transfers call_uuid . bleg transfers the bridged leg of call_uuid . both transfers both legs. |
aleg_url | — | The URL to fetch XML from for the A leg. This argument needs to be specified if the legs parameter is either aleg or both . Callback-retry configurable |
aleg_method | — | The HTTP verb to invoke the aleg_url . Defaults to POST . |
bleg_url | — | The URL to fetch XML from for the B leg. This needs to be specified if the legs parameter is either bleg or both . Callback-retry configurable |
bleg_method | — | The HTTP verb to invoke the bleg_url . Defaults to POST . |
Returns
Returns an acknowledgement that the call is transferred.