Trunks
A trunk connects your PBX or SBC to Signals over SIP. Create and change trunks, add the IP addresses and digest credentials that authenticate them and the termination targets that receive inbound calls, attach an outbound policy, and suspend and resume new calls. See the SIP Trunks overview.
List the project's trunks
Headers
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
List the project's trunks › Responses
Every trunk.
Create a trunk
Headers
Idempotency-KeyOne nonblank key of at most 128 characters; a retry with the same key repeats the outcome.
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Create a trunk › Request Body
auth_modecodecsdirectionmedia_securitynamerequire_tlssource_validationsourcesnumber_block_idsNumber blocks of the project, each routed whole to the trunk as part of the create.
outbound_policy_idA live outbound policy of the project to attach as part of the create.
subaccount_idCreate a trunk › Responses
The trunk was created and is applying.
digest_passwordRead a trunk of the project
path Parameters
trunk_idTrunk id
Headers
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Read a trunk of the project › Responses
The trunk.
concurrency_limitconcurrency_usedcpscurrencydaily_spend_cap_minordirectionidmax_call_duration_secondsmax_destination_rate_minornamenumbersEvery number the trunk answers, by route or as a connection's hosted default.
parent_nameproject_idrevisionThe current revision, quoted as the ETag; a write sends it back in If-Match.
signaling_fqdnstatussubaccount_idsubaccount_nameapplication_stateas_ofRelease a drained, unreferenced trunk
path Parameters
trunk_idTrunk id
Headers
If-MatchThe quoted revision the caller last read, so a concurrent change answers 412.
Idempotency-KeyOne nonblank key of at most 128 characters; a retry with the same key repeats the outcome.
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Release a drained, unreferenced trunk › Responses
The trunk is releasing; its runtime deactivates in the background.
Replace the trunk's own fields
path Parameters
trunk_idTrunk id
Headers
If-MatchThe quoted revision the caller last read, so a concurrent change answers 412.
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Replace the trunk's own fields › Request Body
auth_modecodecsdirectionmedia_securitynamerequire_tlssource_validationsubaccount_idReplace the trunk's own fields › Responses
The trunk was saved and is applying.
concurrency_limitconcurrency_usedcpscurrencydaily_spend_cap_minordirectionidmax_call_duration_secondsmax_destination_rate_minornamenumbersEvery number the trunk answers, by route or as a connection's hosted default.
parent_nameproject_idrevisionThe current revision, quoted as the ETag; a write sends it back in If-Match.
signaling_fqdnstatussubaccount_idsubaccount_nameapplication_stateas_ofList trunk digest identities
path Parameters
trunk_idTrunk id
Headers
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
List trunk digest identities › Responses
Every digest identity on the trunk.
Create a trunk digest credential
path Parameters
trunk_idTrunk id
Headers
If-MatchThe quoted revision the caller last read, so a concurrent change answers 412.
Idempotency-KeyOne nonblank key of at most 128 characters; a retry with the same key repeats the outcome.
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Create a trunk digest credential › Responses
The digest credential and its one-time password.
created_atenabledidnew_applied_atprevious_retires_atrealmrevoked_atrotated_from_idusernamevalid_untilpasswordsecret_unavailableRevoke a trunk digest credential
path Parameters
trunk_idTrunk id
credential_idDigest credential id
Headers
If-MatchThe quoted revision the caller last read, so a concurrent change answers 412.
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Revoke a trunk digest credential › Responses
The digest credential was revoked and the trunk is applying.
Create a replacement digest credential; the original remains valid until explicitly revoked
path Parameters
trunk_idTrunk id
credential_idDigest credential id
Headers
If-MatchThe quoted revision the caller last read, so a concurrent change answers 412.
Idempotency-KeyOne nonblank key of at most 128 characters; a retry with the same key repeats the outcome.
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Create a replacement digest credential; the original remains valid until explicitly revoked › Responses
The replacement credential and its one-time password. Existing credentials remain valid until explicitly revoked. A replay returns no password.
created_atenabledidnew_applied_atprevious_retires_atrealmrevoked_atrotated_from_idusernamevalid_untilpasswordsecret_unavailableList trunk IP credentials
path Parameters
trunk_idTrunk id
Headers
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
List trunk IP credentials › Responses
Every IP credential of the trunk.
Create a trunk IP credential
path Parameters
trunk_idTrunk id
Headers
If-MatchThe quoted revision the caller last read, so a concurrent change answers 412.
Idempotency-KeyOne nonblank key of at most 128 characters; a retry with the same key repeats the outcome.
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Create a trunk IP credential › Request Body
cidrenabledselector_precedenceCreate a trunk IP credential › Responses
The IP credential was added and the trunk is applying.
cidrcreated_atenabledidselector_precedenceDelete a trunk IP credential
path Parameters
trunk_idTrunk id
credential_idIP credential id
Headers
If-MatchThe quoted revision the caller last read, so a concurrent change answers 412.
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Delete a trunk IP credential › Responses
The IP credential was removed and the trunk is applying.
Update a trunk IP credential
path Parameters
trunk_idTrunk id
credential_idIP credential id
Headers
If-MatchThe quoted revision the caller last read, so a concurrent change answers 412.
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Update a trunk IP credential › Request Body
cidrenabledselector_precedenceUpdate a trunk IP credential › Responses
The IP credential was updated and the trunk is applying.
cidrcreated_atenabledidselector_precedenceRead measured trunk call outcomes and media quality
path Parameters
trunk_idTrunk id
query Parameters
windowHeaders
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Read measured trunk call outcomes and media quality › Responses
The trunk call outcomes and media quality for the window.
acd_reasonacd_secondsansweredas_ofasr_7d_pctattemptsfailedMedia quality of the window's answered calls on this trunk.
pdd_mspdd_reasonwindow_hoursAttach an outbound policy to the trunk
path Parameters
trunk_idTrunk id
Headers
If-MatchThe quoted revision the caller last read, so a concurrent change answers 412.
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Attach an outbound policy to the trunk › Request Body
policy_idAttach an outbound policy to the trunk › Responses
The policy is attached and the trunk is applying.
concurrency_limitconcurrency_usedcpscurrencydaily_spend_cap_minordirectionidmax_call_duration_secondsmax_destination_rate_minornamenumbersEvery number the trunk answers, by route or as a connection's hosted default.
parent_nameproject_idrevisionThe current revision, quoted as the ETag; a write sends it back in If-Match.
signaling_fqdnstatussubaccount_idsubaccount_nameapplication_stateas_ofResume new-call admission for a trunk
path Parameters
trunk_idTrunk id
Headers
If-MatchThe quoted revision the caller last read, so a concurrent change answers 412.
Idempotency-KeyOne nonblank key of at most 128 characters; a retry with the same key repeats the outcome.
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Resume new-call admission for a trunk › Responses
The trunk is resumed and applying.
concurrency_limitconcurrency_usedcpscurrencydaily_spend_cap_minordirectionidmax_call_duration_secondsmax_destination_rate_minornamenumbersEvery number the trunk answers, by route or as a connection's hosted default.
parent_nameproject_idrevisionThe current revision, quoted as the ETag; a write sends it back in If-Match.
signaling_fqdnstatussubaccount_idsubaccount_nameapplication_stateas_ofSuspend new-call admission for a trunk
path Parameters
trunk_idTrunk id
Headers
If-MatchThe quoted revision the caller last read, so a concurrent change answers 412.
Idempotency-KeyOne nonblank key of at most 128 characters; a retry with the same key repeats the outcome.
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Suspend new-call admission for a trunk › Responses
The trunk is suspended and applying.
concurrency_limitconcurrency_usedcpscurrencydaily_spend_cap_minordirectionidmax_call_duration_secondsmax_destination_rate_minornamenumbersEvery number the trunk answers, by route or as a connection's hosted default.
parent_nameproject_idrevisionThe current revision, quoted as the ETag; a write sends it back in If-Match.
signaling_fqdnstatussubaccount_idsubaccount_nameapplication_stateas_ofList trunk termination targets
path Parameters
trunk_idTrunk id
Headers
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
List trunk termination targets › Responses
Every termination target of the trunk.
Create a trunk termination target
path Parameters
trunk_idTrunk id
Headers
If-MatchThe quoted revision the caller last read, so a concurrent change answers 412.
Idempotency-KeyOne nonblank key of at most 128 characters; a retry with the same key repeats the outcome.
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Create a trunk termination target › Request Body
sip_uritransportenabledpriorityweightCreate a trunk termination target › Responses
The termination target was added and the trunk is applying.
created_atenabledidprioritysip_uritransportupdated_atweightDelete a trunk termination target
path Parameters
trunk_idTrunk id
target_idTermination target id
Headers
If-MatchThe quoted revision the caller last read, so a concurrent change answers 412.
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Delete a trunk termination target › Responses
The termination target was removed and the trunk is applying.
Update a trunk termination target
path Parameters
trunk_idTrunk id
target_idTermination target id
Headers
If-MatchThe quoted revision the caller last read, so a concurrent change answers 412.
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Update a trunk termination target › Request Body
sip_uritransportenabledpriorityweightUpdate a trunk termination target › Responses
The termination target was updated and the trunk is applying.
created_atenabledidprioritysip_uritransportupdated_atweight