API referenceCreate SIP outbound trunk

SIP outbound

Create SIP outbound trunk

Creates a new outbound SIP trunk for the project tied to your API key, enabling agents to place calls out through your own SIP provider. You supply a display name, the caller phone number(s), the provider's SIP address (host/URI to send calls to), a maximum concurrent channel limit, and the SIP digest credentials Nabrah will use to authenticate against your provider. These credentials are stored per-project. On success the API returns the created trunk including its generated id. Authenticate with the X-API-Key header.

POST

https://api.nabrah.ai/api/ext/sip-outbound

curl --request POST \
  --url 'https://api.nabrah.ai/api/ext/sip-outbound' \
  --header 'X-API-Key: <your-api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Sales dialer (US)",
  "numbers": "+14155552671",
  "address": "sip.yourprovider.com:5060",
  "max_channels": 10,
  "auth_username": "nabrah_outbound_us",
  "auth_password": "s3cure-Outbound-Pass!",
  "pbx_type": "lk"
}'

{
  "name": "string",
  "numbers": "string",
  "address": "string",
  "max_channels": 0,
  "id": "00000000-0000-4000-8000-000000000000",
  "created_by": "00000000-0000-4000-8000-000000000000",
  "project_id": "00000000-0000-4000-8000-000000000000",
  "auth_username": "string",
  "auth_password": "string",
  "created_by_email": "string"
}

Connection fields

Provide these exactly as defined in the request body.

name

Human-readable label for the trunk, shown in the dashboard and list responses.

numbers

The phone number(s) used as the outbound caller identity (caller ID), in E.164 format (e.g. +14155552671).

address

The SIP host/URI of your provider that Nabrah signals to when placing outbound calls (e.g. sip.yourprovider.com or sip.yourprovider.com:5060). This is the destination trunk endpoint.

max_channels

Maximum number of simultaneous outbound calls (concurrent channels) allowed on this trunk. Caps concurrency so you do not exceed your provider's capacity.

auth_username / auth_password

SIP digest credentials Nabrah presents to your provider when authenticating outbound calls. Stored and scoped to the project that owns the API key.

pbx_type

Identifies the SIP/PBX backend the trunk is provisioned against.

After creation

Capture the returned id; it is the sip_id path parameter for GET /api/ext/sip-outbound/{sip_id} and DELETE /api/ext/sip-outbound/{sip_id}.

Authorization

X-API-Keystringheaderrequired

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

Body

application/json

Create an outbound SIP trunk pointing at your provider with digest credentials and a concurrency cap.

Example

{
  "name": "Sales dialer (US)",
  "numbers": "+14155552671",
  "address": "sip.yourprovider.com:5060",
  "max_channels": 10,
  "auth_username": "nabrah_outbound_us",
  "auth_password": "s3cure-Outbound-Pass!",
  "pbx_type": "lk"
}

Response

200

Successful Response

application/json

422

Validation Error

application/json

API referenceCreate SIP outbound trunk

SIP outbound

Create SIP outbound trunk

POST

https://api.nabrah.ai/api/ext/sip-outbound

Create SIP outbound trunk

curl --request POST \
  --url 'https://api.nabrah.ai/api/ext/sip-outbound' \
  --header 'X-API-Key: <your-api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Sales dialer (US)",
  "numbers": "+14155552671",
  "address": "sip.yourprovider.com:5060",
  "max_channels": 10,
  "auth_username": "nabrah_outbound_us",
  "auth_password": "s3cure-Outbound-Pass!",
  "pbx_type": "lk"
}'

{
  "name": "string",
  "numbers": "string",
  "address": "string",
  "max_channels": 0,
  "id": "00000000-0000-4000-8000-000000000000",
  "created_by": "00000000-0000-4000-8000-000000000000",
  "project_id": "00000000-0000-4000-8000-000000000000",
  "auth_username": "string",
  "auth_password": "string",
  "created_by_email": "string"
}

Connection fields

Provide these exactly as defined in the request body.

name

Human-readable label for the trunk, shown in the dashboard and list responses.

numbers

The phone number(s) used as the outbound caller identity (caller ID), in E.164 format (e.g. +14155552671).

address

The SIP host/URI of your provider that Nabrah signals to when placing outbound calls (e.g. sip.yourprovider.com or sip.yourprovider.com:5060). This is the destination trunk endpoint.

max_channels

Maximum number of simultaneous outbound calls (concurrent channels) allowed on this trunk. Caps concurrency so you do not exceed your provider's capacity.

auth_username / auth_password

SIP digest credentials Nabrah presents to your provider when authenticating outbound calls. Stored and scoped to the project that owns the API key.

pbx_type

Identifies the SIP/PBX backend the trunk is provisioned against.

After creation

Capture the returned id; it is the sip_id path parameter for GET /api/ext/sip-outbound/{sip_id} and DELETE /api/ext/sip-outbound/{sip_id}.

Authorization

X-API-Keystringheaderrequired

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

Body

application/json

Create an outbound SIP trunk pointing at your provider with digest credentials and a concurrency cap.

Example

{
  "name": "Sales dialer (US)",
  "numbers": "+14155552671",
  "address": "sip.yourprovider.com:5060",
  "max_channels": 10,
  "auth_username": "nabrah_outbound_us",
  "auth_password": "s3cure-Outbound-Pass!",
  "pbx_type": "lk"
}

Response

200

Successful Response

application/json

422

Validation Error

application/json