Create an inbound SIP trunk

POST

https://api.smallest.ai/atoms/v1/sip-trunk/inbound

POST

/atoms/v1/sip-trunk/inbound

1 import requests
2 
3 url = "https://api.smallest.ai/atoms/v1/sip-trunk/inbound"
4 
5 payload = { "name": "Acme carrier (inbound)" }
6 headers = {
7     "Authorization": "Bearer <token>",
8     "Content-Type": "application/json"
9 }
10 
11 response = requests.post(url, json=payload, headers=headers)
12 
13 print(response.json())

1 {
2   "status": true,
3   "data": {
4     "_id": "string",
5     "livekitTrunkId": "string",
6     "name": "string",
7     "numbers": [
8       "string"
9     ],
10     "allowedAddresses": [
11       "string"
12     ],
13     "allowedNumbers": [
14       "string"
15     ],
16     "mediaEncryption": "disable",
17     "krispEnabled": true,
18     "ringingTimeoutSeconds": 1,
19     "authUsername": "string",
20     "sipHost": "5rdbhjuwtlk.sip.livekit.cloud",
21     "agent": {
22       "id": "string",
23       "name": "string"
24     },
25     "isActive": true,
26     "createdAt": "2024-01-15T09:30:00Z",
27     "updatedAt": "2024-01-15T09:30:00Z"
28   }
29 }

Phone numbers are unique across the platform: a number already answering elsewhere returns 409 (“Already in use and cannot be added to this trunk: …”). Wildcard peer addresses (0.0.0.0, ::, *, any /0) are refused, since the allow-list is the security boundary.

Creates an inbound trunk: the resource that receives calls from your carrier. Requires an admin-role key. An inbound trunk needs at least one phone number or one allowed peer address; the trunk gets its own credentials, media-encryption policy, Krisp toggle, and ringing timeout. Phone numbers are unique across the platform: a number already answering elsewhere returns `409` ("Already in use and cannot be added to this trunk: ..."). Wildcard peer addresses (`0.0.0.0`, `::`, `*`, any `/0`) are refused, since the allow-list is the security boundary.

Authentication

AuthorizationBearer

API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.

Request

This endpoint expects an object.

namestringRequired<=120 characters

Display name for the trunk

numberslist of stringsOptional

E.164 numbers (with leading +) this trunk answers. Deduplicated.

allowedAddresseslist of stringsOptional

Hostnames, IPs, or CIDR ranges allowed to send calls to this trunk. Wildcards refused.

allowedNumberslist of stringsOptional

Restrict accepted caller numbers to this list (optional). If set, the trunk is dedicated even without numbers.

mediaEncryptionenumOptional

Defaults to allow.

Allowed values:

krispEnabledbooleanOptional

Noise cancellation for callers arriving on this trunk. Defaults to true.

ringingTimeoutSecondsintegerOptional1-600

authUsernamestringOptional

SIP digest username. Provide both credentials or neither.

authPasswordstringOptional

SIP digest password. Stored with the SIP infrastructure, never returned.

Response

Trunk created

statusbooleanOptional

dataobjectOptional

Errors

400

Bad Request Error

409

Conflict Error