Skip to main content
POST
/
api
/
v1
/
phone-numbers
/
trunks
Register an external SIP trunk / BYO number
curl --request POST \
  --url https://{subdomain}.mihu.ai/api/v1/phone-numbers/trunks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone_number": "+12345678901",
  "agent_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "channel": "call",
  "name": "<string>",
  "direction": "inbound",
  "sip": {
    "gateway": "sip.acme.com",
    "port": 5060,
    "username": "<string>",
    "password": "<string>",
    "secondary_gateway": "<string>"
  },
  "additional_settings": {}
}
'
{
  "success": true,
  "message": "<string>",
  "data": {
    "phone_number_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "number": "<string>",
    "is_external": true,
    "source": "purchased",
    "channels": {
      "call": {
        "capable": true,
        "enabled": true,
        "channel_limit": 123,
        "whitelisted_destinations": [
          "US"
        ],
        "bound": true,
        "agent_uuid": "<string>",
        "agent_name": "<string>"
      },
      "sms": {
        "capable": true,
        "enabled": true,
        "channel_limit": 123,
        "whitelisted_destinations": [
          "<string>"
        ],
        "bound": true,
        "agent_uuid": "<string>",
        "agent_name": "<string>"
      },
      "whatsapp": {
        "bound": true,
        "agent_uuid": "<string>",
        "agent_name": "<string>"
      },
      "inbound": {
        "enabled": true,
        "channel_limit": 123
      }
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.mindhunters.ai/llms.txt

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

Authorizations

​
Authorization
string
header
required

Use a Bearer token to access these API endpoints. Example: "Bearer {your-token}"

Body

application/json
​
phone_number
string
required

The external phone number to register, in E.164 format. Must NOT already be in your purchased inventory or bound on the same channel.

Example:

"+12345678901"

​
agent_uuid
string<uuid>
required

UUID of the agent that will answer traffic on this trunk. The agent must not already serve another number on the same channel.

​
channel
enum<string>
required

Which channel this trunk handles. One trunk row per (number, channel) pair — you can register the same number on call+whatsapp by calling this twice. SMS is not supported on the trunk endpoints; use POST /api/v1/agents/{uuid}/channels/sms instead.

Available options:
call,
whatsapp
​
name
string

Friendly label for the trunk, surfaced in dashboards and logs. Defaults to {channel}_trunk_{digits} if omitted (e.g. call_trunk_12345678901).

​
direction
enum<string>

Call-channel only. Whether this trunk handles inbound, outbound, or both. Defaults to both. Ignored for WhatsApp.

Available options:
inbound,
outbound,
both
​
sip
object

Optional SIP credentials for the call channel. All fields are encrypted at rest. Omit if you only want to register the binding without storing credentials.

​
additional_settings
object

Free-form JSON stored on the binding. Use for channel-specific extras (for example, an ani_format: e164 flag).

Response

Trunk created

​
success
boolean

Indicates whether the request completed successfully. True for successful responses; false for documented error responses.

​
message
string

Human-readable response message. Safe to display in logs or simple client notifications; use structured fields for program logic.

​
data
object

Per-channel snapshot returned by /phone-numbers/{uuid}/channels, /phone-numbers/channels?number=…, and the trunk create/update/assign endpoints. Combines capability (what the carrier supports), state (what's enabled), and binding (which agent is wired up).