Docs
ChangelogالعربيةDashboard
DocumentationAPI reference
API referenceLink an agent to an inbound trunk
  • Introduction
  • Authentication
    • GETVerify API key
  • Agents
    • POSTCreate agent
    • GETList agents
    • GETGet agent
    • PUTUpdate agent
    • DELDelete agent
    • POSTLink analysis groups to an agent
    • GETList analysis groups for an agent
  • Tools
    • POSTCreate tool
    • GETList tools
    • GETGet tool
    • PUTUpdate tool
    • DELDelete tool
    • POSTLink a tool to an agent
    • DELUnlink a tool from an agent
    • GETList tools for an agent
    • GETList agents for a tool
  • Analysis groups
    • POSTCreate analysis group
    • GETList analysis groups
    • GETGet analysis group
    • PUTUpdate analysis group
    • DELDelete analysis group
    • POSTLink an agent to an analysis group
    • POSTLink agents to an analysis group
    • GETList agents for an analysis group
    • DELUnlink an analysis group from an agent
  • Knowledge bases
    • POSTCreate knowledge base
    • GETList knowledge bases
    • GETGet knowledge base
    • PATCHUpdate knowledge base
    • DELDelete knowledge base
  • Documents
    • POSTAdd PDF document
    • POSTAdd text document
    • POSTAdd URL document
    • GETList documents
    • GETGet document
    • DELDelete document
  • Calls
    • POSTCreate outbound call
    • GETGet call
    • POSTSearch calls
    • POSTGet call analytics
    • POSTExport calls
    • GETGet recording download URL
    • POSTCreate outbound call (legacy path)
  • Web calls
    • POSTCreate web call
    • POSTCreate web call (legacy path)
  • SIP inbound
    • POSTCreate SIP inbound trunk
    • GETList SIP inbound trunks
    • GETGet SIP inbound trunk
    • DELDelete SIP inbound trunk
  • SIP outbound
    • POSTCreate SIP outbound trunk
    • GETList SIP outbound trunks
    • GETGet SIP outbound trunk
    • DELDelete SIP outbound trunk
  • Agent inbound links
    • POSTLink an agent to an inbound trunk
    • GETList agent inbound links
    • DELDelete agent inbound link
  • Text to speech
    • POSTGenerate speech
    • GETList voices
    • GETGet voice
    • POSTClone a voice
    • DELDelete cloned voice
  • Speech to text
    • POSTTranscribe an audio file
    • GETGet transcription job
    • GETList transcription jobs
    • WSStream speech to text
  • Contacts
    • POSTCreate contact
    • GETList contacts
    • GETSearch contacts
    • GETGet contact
    • PATCHUpdate contact
    • GETList conversations for a contact
  • Conversations
    • GETList conversations
    • POSTFilter conversations
    • POSTList conversations by contact
    • GETGet conversation
    • GETList conversation messages
    • POSTSend a message
    • POSTSend a message with an attachment
    • GETList conversation attachments
    • POSTAssign conversation
    • POSTChange conversation status
    • POSTChange conversation priority
    • POSTMark conversation as seen
  • Tickets
    • POSTCreate ticket
    • GETList tickets
    • POSTFilter tickets
    • POSTList tickets by contact
    • GETGet ticket
    • GETList ticket messages
    • POSTAdd a ticket message
    • POSTAdd a ticket message with attachments
    • POSTAssign ticket
    • POSTChange ticket status
    • POSTChange ticket priority
    • POSTChange ticket type
    • POSTCreate ticket inbox
    • GETList ticket inboxes
    • PATCHUpdate ticket inbox
    • DELDelete ticket inbox
  • WhatsApp
    • POSTConnect a WhatsApp number
    • GETList WhatsApp inboxes
    • GETGet WhatsApp inbox
    • PATCHUpdate WhatsApp inbox
    • DELDelete WhatsApp inbox
    • POSTCreate WhatsApp conversation
    • GETList WhatsApp conversations
    • POSTFilter WhatsApp conversations
    • POSTList WhatsApp conversations by contact
    • POSTAssign an agent to a WhatsApp number
    • GETGet the agent on a WhatsApp number
    • DELRemove the agent from a WhatsApp number
    • POSTGet WhatsApp analytics
  • Instagram
    • GETList Instagram accounts
    • GETGet Instagram account
    • DELDelete Instagram account
    • GETList Instagram conversations
    • POSTFilter Instagram conversations
    • POSTList Instagram conversations by contact
    • POSTAssign an agent to an Instagram account
    • GETGet the agent on an Instagram account
    • DELRemove the agent from an Instagram account
  • TikTok
    • GETList TikTok accounts
    • GETGet TikTok account
    • DELDelete TikTok account
    • GETList TikTok conversations
    • POSTFilter TikTok conversations
    • POSTList TikTok conversations by contact
    • POSTAssign an agent to a TikTok account
    • GETGet the agent on a TikTok account
    • DELRemove the agent from a TikTok account

Agent inbound links

Link an agent to an inbound trunk

Links an agent to a SIP inbound trunk so the agent answers calls arriving on that trunk. Both the agent and the trunk must already exist in the workspace behind your API key — create them with POST /api/ext/agent and POST /api/ext/sip-inbound. Save the returned link_id to de-link later via DELETE /api/ext/agent-inbound-link/{link_id}.

POST
https://api.nabrah.ai/api/ext/agent-inbound-link
Link an agent to an inbound trunk
curl --request POST \
  --url 'https://api.nabrah.ai/api/ext/agent-inbound-link' \
  --header 'X-API-Key: <your-api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "agent_id": "018f3a2b-9c4d-7e1a-bf52-0a1b2c3d4e5f",
  "inbound_id": "018f3a2b-9c4d-7e1a-bf52-0a1b2c3d5a60"
}'
{
  "link_id": "00000000-0000-4000-8000-000000000000",
  "agent": {
    "agent_id": "00000000-0000-4000-8000-000000000000",
    "name": "string"
  },
  "sip_inbound": {
    "id": "00000000-0000-4000-8000-000000000000",
    "numbers": "string"
  },
  "project_id": "00000000-0000-4000-8000-000000000000",
  "created_at": "2026-01-15T12:00:00.000Z"
}

Where the IDs come from

agent_id and inbound_id

agent_id comes from GET /api/ext/agent or the create response of POST /api/ext/agent. inbound_id comes from GET /api/ext/sip-inbound or the create response of POST /api/ext/sip-inbound.

agent_idinbound_id

When this returns 400

All three of these produce the same 400 response, so check them in order.

Agent or trunk not in this workspace

Both IDs are validated against the workspace behind your API key. An ID belonging to another workspace is rejected exactly like a non-existent one.

The link already exists

The same agent cannot be linked to the same trunk twice. Call GET /api/ext/agent-inbound-link first if you need to know whether a pair is already linked.

Many-to-many

Several agents on one trunk

A trunk may carry several agents and an agent may serve several trunks — call this endpoint once per pair. Which agent answers a given call is decided at call time by the voice runtime, not by this API.

Authorization

X-API-Keystringheaderrequired

Your workspace API key. Create one in the dashboard under API keys.

Body

application/json

Attach one agent to one SIP inbound trunk.

Example
{
  "agent_id": "018f3a2b-9c4d-7e1a-bf52-0a1b2c3d4e5f",
  "inbound_id": "018f3a2b-9c4d-7e1a-bf52-0a1b2c3d5a60"
}

Response

200

Successful Response

application/json

422

Validation Error

application/json

PreviousAgent inbound linksNextList agent inbound links
© 2026 Nabrah. All rights reserved.
ChangelogPrivacy PolicyTerms of Service