Create an outbound trunk with minimal fields
POST/v1/trunks/outbound
Only name, host and permit are required. Without secret a strong random one is generated and returned once in the response. port defaults to 5060 and transport to transport-udp; every other setting keeps the PBX default. type is not accepted: it is netgsm for Netgsm hosts and custom otherwise. type, inbound_identification, inbound_pattern and the engine fields are rejected with 422. Creating a trunk is capped by the number of phone line packages the organization owns; every existing trunk except fct ones counts against it (fctmvno counts). No phone line package returns 403 (also when the package check cannot be completed); a full quota returns 422, and a second create running for the same organization returns 429 after waiting up to 5 seconds. A 429 is also returned when the PBX trunk limit for the organization is reached. Requires api_user|trunk_create.
Request
Responses
- 201
- 401
- 403
- 409
- 422
- 429
- 503
Created
Unauthenticated
Missing permission, or no phone line package owned
The trunk name is already taken
Validation error or phone line quota exceeded
Rate limit exceeded, another create in progress, or the PBX trunk limit for the organization reached
The PBX is unreachable, or no PBX tenant is assigned to the organization