Skip to main content
POST
/
transfer-targets
Create Transfer Target
curl --request POST \
  --url https://api.example.com/transfer-targets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "target": "<string>",
  "mode": "warm",
  "sip_trunk_id": "<string>",
  "sip_headers": {},
  "briefing_prompt": "<string>",
  "transfer_announcement": "<string>",
  "tags": [
    "<string>"
  ],
  "enabled": true
}
'
{
  "id": "<string>",
  "owner_id": "<string>",
  "name": "<string>",
  "target": "<string>",
  "mode": "<string>",
  "sip_trunk_id": "<string>",
  "sip_headers": {},
  "briefing_prompt": "<string>",
  "transfer_announcement": "<string>",
  "tags": [
    "<string>"
  ],
  "enabled": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Documentation Index

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

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

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required

Friendly name (e.g. 'Billing').

Required string length: 1 - 160
target
string
required

E.164 number, sip: URI, or LiveKit identity.

Required string length: 3 - 255
mode
string
default:warm

warm | cold

sip_trunk_id
string | null
sip_headers
Sip Headers · object
briefing_prompt
string | null
transfer_announcement
string | null
tags
string[] | null
enabled
boolean
default:true

Response

Successful Response

id
string
required
owner_id
string
required
name
string
required
target
string
required
mode
string
required
sip_trunk_id
string | null
required
sip_headers
Sip Headers · object
required
briefing_prompt
string | null
required
transfer_announcement
string | null
required
tags
string[] | null
required
enabled
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required