Skip to main content
POST
/
api
/
v1
/
Account
/
{auth_id}
/
Call
/
{call_uuid}
Transfer a Call
curl --request POST \
  --url https://api.example.com/api/v1/Account/{auth_id}/Call/{call_uuid}/

Documentation Index

Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt

Use this file to discover all available pages before exploring further.

POST https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/
Transfer an in-progress call to a different URL for new call flow instructions. The new URL must return XML instructions that define the next steps for the call. Use this to implement call forwarding, IVR navigation, or dynamic call routing.
Authentication required:
  • X-Auth-ID - Your account Auth ID
  • X-Auth-Token - Your account Auth Token
  • Content-Type: application/json
The call must be in an active state (in-progress) to be transferred. You can transfer both call legs independently using their respective UUIDs.
Transfer operations interrupt the current call flow and immediately execute the XML returned from the new URL. Ensure your transfer URL is accessible and returns valid XML.

​
Path parameters

FieldTypeRequiredDescription
auth_idstringYesYour Vobiz account ID (e.g., {auth_id}).
call_uuidstringYesUnique identifier of the call to transfer.

​
Request Parameters

FieldTypeRequiredDescription
legsstringNoWhich leg(s) of the call to transfer. Values: aleg (caller), bleg (callee), or both. Default: aleg.
aleg_urlstringNoURL to transfer the A leg (caller) to. Must return valid XML with call instructions.
aleg_methodstringNoHTTP method for aleg_url. Values: GET, POST. Default: POST.
bleg_urlstringNoURL to transfer the B leg (callee) to. Must return valid XML with call instructions.
bleg_methodstringNoHTTP method for bleg_url. Values: GET, POST. Default: POST.
Transfer Leg Options:
  • aleg - Transfers only the caller (A leg) to the new URL
  • bleg - Transfers only the callee (B leg) to the new URL
  • both - Transfers both legs to their respective URLs (requires both aleg_url and bleg_url)

​
Response

Returns a success message confirming the call transfer request has been initiated.
Response - 202 Accepted
{
  "api_id": "uuid-here",
  "message": "call transferred",
  "call_uuid": "call-uuid-here"
}

​
Response Fields

FieldDescription
api_idUnique identifier for this API request
messageConfirmation message indicating the transfer status

​
Example Request

{
  "legs": "aleg",
  "aleg_url": "https://yourdomain.com/transfer_instructions/",
  "aleg_method": "POST"
}

​
Use Cases

  • Implement call forwarding based on IVR input
  • Route calls to different departments dynamically
  • Play announcements or collect additional information mid-call
  • Implement warm transfer scenarios with hold music
  • Change call behavior based on external triggers or events
XML Response Example: Your transfer URL should return XML instructions like:
<Response>
  <Speak>Please hold while we transfer your call.</Speak>
  <Dial>
    <Number>+14156667890</Number>
  </Dial>
</Response>