Create a trunk with every PBX setting
POST/v1/trunks
Creates a trunk with any field the PBX accepts. type may only be netgsm or custom (omitted: netgsm for Netgsm hosts, custom otherwise); fct and fctmvno are rejected with 422. port defaults to 5060, and transport to transport-udp when neither inbound_identification nor inbound_pattern is sent. name, secret and host are required unless inbound_pattern is sent; permit is required unless the host is the Netgsm SIP server. An inbound_pattern without name uses its prefix as the name. tenantid, id, deny, field_policy and identification_mode 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
- 404
- 409
- 422
- 429
- 503
Created
Unauthenticated
Missing permission, or no phone line package owned
No PBX found for the organization
The trunk name is already taken
Validation error, unavailable prefix, 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