v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014102371.0 MB

Transfer

Start a transfer

Initiates a call transfer and returns the result.

post/transfers

Request body

transfer_type'attended' | 'blind' required

transferer_call_idstring required

Call ID of the transfer initiator.

Example request

{
  "transfer_type": "blind",
  "transferee_addresses": [
    {
      "type": "tel",
      "target": "+14155551234",
      "target_name": "John Smith",
      "name": "Main Office",
      "detail": "Primary contact number"
    }
  ]
}

Response

The transfer details.

idstring uuid

The unique identifier of the transfer. Returned from the POST /transfers response.

customer_idstring uuid

The unique identifier of the customer who owns this transfer. Returned from the GET /customers response.

type'attended' | 'blind'

transferer_call_idstring uuid

The unique identifier of the call initiating the transfer. Returned from the GET /calls response.

transferee_call_idstring uuid

The unique identifier of the call being transferred. Returned from the GET /calls response.

groupcall_idstring uuid

The unique identifier of the groupcall created for the transfer. Returned from the GET /groupcalls response.

confbridge_idstring uuid

The unique identifier of the conference bridge used for attended transfer. Returned from the GET /conferences response.

tm_createstring date-time

Timestamp when created

tm_updatestring date-time

Timestamp when updated

tm_deletestring date-time

Timestamp when deleted

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  "type": "blind",
  "transferer_call_id": "c9d0e1f2-a3b4-5c6d-7e8f-9a0b1c2d3e4f",
  "transferee_addresses": [
    {
      "type": "tel",
      "target": "+14155551234",
      "target_name": "John Smith",
      "name": "Main Office",
      "detail": "Primary contact number"
    }
  ],
  "transferee_call_id": "d0e1f2a3-b4c5-6d7e-8f9a-0b1c2d3e4f5a",
  "groupcall_id": "e1f2a3b4-c5d6-7e8f-9a0b-1c2d3e4f5a6b",
  "confbridge_id": "f2a3b4c5-d6e7-8f9a-0b1c-2d3e4f5a6b7c",
  "tm_create": "2026-01-15T09:30:00.000000Z",
  "tm_update": "2026-01-16T14:20:00.000000Z",
  "tm_delete": "2026-01-17T18:45:00.000000Z"
}