Create an outbound SIP trunk

POST

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

POST

/atoms/v1/sip-trunk/outbound

1 import requests
2 
3 url = "https://api.smallest.ai/atoms/v1/sip-trunk/outbound"
4 
5 payload = {
6     "name": "Acme carrier (outbound)",
7     "address": "sip.acme.com:5060",
8     "numbers": ["+14155552671"]
9 }
10 headers = {
11     "Authorization": "Bearer <token>",
12     "Content-Type": "application/json"
13 }
14 
15 response = requests.post(url, json=payload, headers=headers)
16 
17 print(response.json())

1 {
2   "status": true,
3   "data": {
4     "_id": "string",
5     "livekitTrunkId": "string",
6     "name": "string",
7     "address": "string",
8     "transport": "auto",
9     "numbers": [
10       "string"
11     ],
12     "mediaEncryption": "disable",
13     "cpsLimit": 1,
14     "authUsername": "string",
15     "isActive": true,
16     "createdAt": "2024-01-15T09:30:00Z",
17     "updatedAt": "2024-01-15T09:30:00Z"
18   }
19 }

Creates an outbound trunk: the resource calls are placed through. Requires an admin-role key. numbers are the caller IDs the trunk may present; a call or campaign chooses among them per call via fromNumber / fromNumbers.

One trunk per carrier address per organization (409 naming the existing trunk), and a caller ID can live on only one of your outbound trunks (409 naming it). address and transport are immutable after creation: to change carriers, delete the trunk and create a new one.

Creates an outbound trunk: the resource calls are placed through. Requires an admin-role key. `numbers` are the caller IDs the trunk may present; a call or campaign chooses among them per call via `fromNumber` / `fromNumbers`. One trunk per carrier address per organization (`409` naming the existing trunk), and a caller ID can live on only one of your outbound trunks (`409` naming it). `address` and `transport` are immutable after creation: to change carriers, delete the trunk and create a new one.

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

addressstringRequired

Your carrier’s SIP termination host: a hostname or IP, optionally with a port. Full sip:/sips: URIs are normalized to the bare host.

numberslist of stringsRequired

Caller IDs this trunk may present, E.164 with leading +.

transportenumOptionalDefaults to auto

Allowed values:

mediaEncryptionenumOptionalDefaults to disable

Allowed values:

destinationCountrystringOptional=2 characters

ISO 3166-1 alpha-2 country code for region-pinned routing (optional).

cpsLimitintegerOptional1-50Defaults to 1

Calls per second placed through this carrier address. Shared by every trunk on the same address in your organization.

authUsernamestringOptional

authPasswordstringOptional

Response

Trunk created

statusbooleanOptional

dataobjectOptional

Errors

400

Bad Request Error

409

Conflict Error