Signals Docs
SIP Trunking
SIP Trunking

Trunks

List the project's trunks

GET
https://api.signals.pressone.africa/v1
/trunks

List the project's trunks › Headers

X-Project-ID
​string

The 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.

TrunkList
​TrunkSummary[] · required

Create a trunk

POST
https://api.signals.pressone.africa/v1
/trunks

Create a trunk › Headers

Idempotency-Key
​string · required

One nonblank key of at most 128 characters; a retry with the same key repeats the outcome.

X-Project-ID
​string

The project the request acts on, as prj_ and its lowercase UUID; optional while the organization has one active project.

Create a trunk › Request Body

CreateTrunkRequest
auth_mode
​TrunkAuthMode · enum · required
Enum values:
ip_allow_list
digest
codecs
​TrunkCodec[] · required
Enum values:
PCMA
PCMU
G729
G722
OPUS
direction
​TrunkTrafficDirection · enum · required
Enum values:
inbound
outbound
both
media_security
​TrunkMediaSecurity · enum · required
Enum values:
rtp
sdes_srtp_required
name
​string · required
require_tls
​boolean · required
source_validation
​TrunkSourceValidation · enum · required
Enum values:
relaxed
strict
sources
​string[] · required
​TrunkTargetInput[] · required
​
number_block_ids
​string[]

Number blocks of the project, each routed whole to the trunk as part of the create.

outbound_policy_id
​string | null

A live outbound policy of the project to attach as part of the create.

subaccount_id
​string | null

Create a trunk › Responses

The trunk was created and is applying.

The created trunk. `digest_password` is the generated password of a digest trunk's first credential: sent by this response alone, null for an IP trunk and on a replay.
TrunkCreation
digest_password
​string | null · required
​TrunkDetail · required

Read a trunk of the project

GET
https://api.signals.pressone.africa/v1
/trunks/{trunk_id}

Read a trunk of the project › path Parameters

trunk_id
​string · required

Trunk id

Read a trunk of the project › Headers

X-Project-ID
​string

The 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.

TrunkDetail
concurrency_limit
​integer · int32 · min: 0 · required
concurrency_used
​integer · int32 · min: 0 · required
cps
​string | null · required
currency
​string · required
daily_spend_cap_minor
​integer | null · int64 · required
direction
​TrunkTrafficDirection · enum · required
Enum values:
inbound
outbound
both
​TrunkEndpointSummary · required
id
​string · required
max_call_duration_seconds
​integer · int32 · min: 0 · required
max_destination_rate_minor
​integer | null · int64 · required
name
​string · required
numbers
​integer · int32 · min: 0 · required
parent_name
​string | null · required
project_id
​string · required
revision
​integer · int64 · required

The current revision, quoted as the ETag; a write sends it back in If-Match.

signaling_fqdn
​string | null · required
status
​TrunkLifecycleStatus · enum · required
Enum values:
draft
enabled
disabled
releasing
released
subaccount_id
​string | null · required
subaccount_name
​string | null · required
as_of
​string · date-time · required
​TrunkAuthentication · required
​TrunkEndpointEvidence[] · required
​TrunkLimits · required
​TrunkMedia · required
​TrunkNumbers · required
​required
​TrunkRoute[] · required

Release a drained, unreferenced trunk

DELETE
https://api.signals.pressone.africa/v1
/trunks/{trunk_id}

Release a drained, unreferenced trunk › path Parameters

trunk_id
​string · required

Trunk id

Release a drained, unreferenced trunk › Headers

If-Match
​string · required

The quoted revision the caller last read, so a concurrent change answers 412.

Idempotency-Key
​string · required

One nonblank key of at most 128 characters; a retry with the same key repeats the outcome.

X-Project-ID
​string

The project the request acts on, as prj_ and its lowercase UUID; optional while the organization has one active project.

Release a drained, unreferenced trunk › Request Body

ReleaseTrunkRequest
confirm_name
​string · required

Release a drained, unreferenced trunk › Responses

The trunk is releasing; its runtime deactivates in the background.

No data returned

Replace the trunk's own fields

PATCH
https://api.signals.pressone.africa/v1
/trunks/{trunk_id}

Replace the trunk's own fields › path Parameters

trunk_id
​string · required

Trunk id

Replace the trunk's own fields › Headers

If-Match
​string · required

The quoted revision the caller last read, so a concurrent change answers 412.

X-Project-ID
​string

The 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

The editable trunk fields. The project binding is fixed at creation, and sources and targets belong to their item routes, so a body naming any of them is rejected rather than ignored.
UpdateTrunkRequest
auth_mode
​TrunkAuthMode · enum · required
Enum values:
ip_allow_list
digest
codecs
​TrunkCodec[] · required
Enum values:
PCMA
PCMU
G729
G722
OPUS
direction
​TrunkTrafficDirection · enum · required
Enum values:
inbound
outbound
both
media_security
​TrunkMediaSecurity · enum · required
Enum values:
rtp
sdes_srtp_required
name
​string · required
require_tls
​boolean · required
source_validation
​TrunkSourceValidation · enum · required
Enum values:
relaxed
strict
​
subaccount_id
​string | null

Replace the trunk's own fields › Responses

The trunk was saved and is applying.

TrunkDetail
concurrency_limit
​integer · int32 · min: 0 · required
concurrency_used
​integer · int32 · min: 0 · required
cps
​string | null · required
currency
​string · required
daily_spend_cap_minor
​integer | null · int64 · required
direction
​TrunkTrafficDirection · enum · required
Enum values:
inbound
outbound
both
​TrunkEndpointSummary · required
id
​string · required
max_call_duration_seconds
​integer · int32 · min: 0 · required
max_destination_rate_minor
​integer | null · int64 · required
name
​string · required
numbers
​integer · int32 · min: 0 · required
parent_name
​string | null · required
project_id
​string · required
revision
​integer · int64 · required

The current revision, quoted as the ETag; a write sends it back in If-Match.

signaling_fqdn
​string | null · required
status
​TrunkLifecycleStatus · enum · required
Enum values:
draft
enabled
disabled
releasing
released
subaccount_id
​string | null · required
subaccount_name
​string | null · required
as_of
​string · date-time · required
​TrunkAuthentication · required
​TrunkEndpointEvidence[] · required
​TrunkLimits · required
​TrunkMedia · required
​TrunkNumbers · required
​required
​TrunkRoute[] · required

Read passive trunk diagnostics

GET
https://api.signals.pressone.africa/v1
/trunks/{trunk_id}/diagnostics

Read passive trunk diagnostics › path Parameters

trunk_id
​string · required

Trunk id

Read passive trunk diagnostics › Headers

X-Project-ID
​string

The project the request acts on, as prj_ and its lowercase UUID; optional while the organization has one active project.

Read passive trunk diagnostics › Responses

The passive trunk diagnostics.

TrunkDiagnostics
​TrunkMediaDiagnostics · required

List trunk digest identities

GET
https://api.signals.pressone.africa/v1
/trunks/{trunk_id}/digest-credentials

List trunk digest identities › path Parameters

trunk_id
​string · required

Trunk id

List trunk digest identities › Headers

X-Project-ID
​string

The 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.

TrunkDigestCredentialList
​TrunkDigestCredential[] · required

Create a trunk digest credential

POST
https://api.signals.pressone.africa/v1
/trunks/{trunk_id}/digest-credentials

Create a trunk digest credential › path Parameters

trunk_id
​string · required

Trunk id

Create a trunk digest credential › Headers

If-Match
​string · required

The quoted revision the caller last read, so a concurrent change answers 412.

Idempotency-Key
​string · required

One nonblank key of at most 128 characters; a retry with the same key repeats the outcome.

X-Project-ID
​string

The project the request acts on, as prj_ and its lowercase UUID; optional while the organization has one active project.

Create a trunk digest credential › Request Body

CreateTrunkDigestCredentialRequest
realm
​string · required

Create a trunk digest credential › Responses

The digest credential and its one-time password.

TrunkDigestCredentialSecret
created_at
​string · date-time · required
enabled
​boolean · required
id
​string · required
new_applied_at
​string | null · date-time · required
previous_retires_at
​string | null · date-time · required
realm
​string · required
revoked_at
​string | null · date-time · required
rotated_from_id
​string | null · required
username
​string · required
valid_until
​string | null · date-time · required
password
​string | null · required
secret_unavailable
​boolean · required

Revoke a trunk digest credential

DELETE
https://api.signals.pressone.africa/v1
/trunks/{trunk_id}/digest-credentials/{credential_id}

Revoke a trunk digest credential › path Parameters

trunk_id
​string · required

Trunk id

credential_id
​string · required

Digest credential id

Revoke a trunk digest credential › Headers

If-Match
​string · required

The quoted revision the caller last read, so a concurrent change answers 412.

X-Project-ID
​string

The 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.

No data returned

Rotate a trunk digest credential

POST
https://api.signals.pressone.africa/v1
/trunks/{trunk_id}/digest-credentials/{credential_id}/rotate

Rotate a trunk digest credential › path Parameters

trunk_id
​string · required

Trunk id

credential_id
​string · required

Digest credential id

Rotate a trunk digest credential › Headers

If-Match
​string · required

The quoted revision the caller last read, so a concurrent change answers 412.

Idempotency-Key
​string · required

One nonblank key of at most 128 characters; a retry with the same key repeats the outcome.

X-Project-ID
​string

The project the request acts on, as prj_ and its lowercase UUID; optional while the organization has one active project.

Rotate a trunk digest credential › Responses

The replacement credential and its one-time password.

TrunkDigestCredentialSecret
created_at
​string · date-time · required
enabled
​boolean · required
id
​string · required
new_applied_at
​string | null · date-time · required
previous_retires_at
​string | null · date-time · required
realm
​string · required
revoked_at
​string | null · date-time · required
rotated_from_id
​string | null · required
username
​string · required
valid_until
​string | null · date-time · required
password
​string | null · required
secret_unavailable
​boolean · required

List trunk IP credentials

GET
https://api.signals.pressone.africa/v1
/trunks/{trunk_id}/ip-credentials

List trunk IP credentials › path Parameters

trunk_id
​string · required

Trunk id

List trunk IP credentials › Headers

X-Project-ID
​string

The 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.

TrunkIpCredentialList
​TrunkIpCredential[] · required

Create a trunk IP credential

POST
https://api.signals.pressone.africa/v1
/trunks/{trunk_id}/ip-credentials

Create a trunk IP credential › path Parameters

trunk_id
​string · required

Trunk id

Create a trunk IP credential › Headers

If-Match
​string · required

The quoted revision the caller last read, so a concurrent change answers 412.

Idempotency-Key
​string · required

One nonblank key of at most 128 characters; a retry with the same key repeats the outcome.

X-Project-ID
​string

The 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

TrunkIpCredentialRequest
cidr
​string · required
enabled
​boolean
selector_precedence
​integer · int32 · min: 0

Create a trunk IP credential › Responses

The IP credential was added and the trunk is applying.

TrunkIpCredential
cidr
​string · required
created_at
​string · date-time · required
enabled
​boolean · required
id
​string · required
selector_precedence
​integer · int32 · min: 0 · required

Delete a trunk IP credential

DELETE
https://api.signals.pressone.africa/v1
/trunks/{trunk_id}/ip-credentials/{credential_id}

Delete a trunk IP credential › path Parameters

trunk_id
​string · required

Trunk id

credential_id
​string · required

IP credential id

Delete a trunk IP credential › Headers

If-Match
​string · required

The quoted revision the caller last read, so a concurrent change answers 412.

X-Project-ID
​string

The 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.

No data returned

Update a trunk IP credential

PATCH
https://api.signals.pressone.africa/v1
/trunks/{trunk_id}/ip-credentials/{credential_id}

Update a trunk IP credential › path Parameters

trunk_id
​string · required

Trunk id

credential_id
​string · required

IP credential id

Update a trunk IP credential › Headers

If-Match
​string · required

The quoted revision the caller last read, so a concurrent change answers 412.

X-Project-ID
​string

The 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

TrunkIpCredentialRequest
cidr
​string · required
enabled
​boolean
selector_precedence
​integer · int32 · min: 0

Update a trunk IP credential › Responses

The IP credential was updated and the trunk is applying.

TrunkIpCredential
cidr
​string · required
created_at
​string · date-time · required
enabled
​boolean · required
id
​string · required
selector_precedence
​integer · int32 · min: 0 · required

Read measured trunk call outcomes

GET
https://api.signals.pressone.africa/v1
/trunks/{trunk_id}/metrics

Read measured trunk call outcomes › path Parameters

trunk_id
​string · required

Trunk id

Read measured trunk call outcomes › query Parameters

window
​string · enum
Enum values:
1h
24h
7d
30d

Read measured trunk call outcomes › Headers

X-Project-ID
​string

The project the request acts on, as prj_ and its lowercase UUID; optional while the organization has one active project.

Read measured trunk call outcomes › Responses

The trunk call outcomes for the window.

TrunkMetrics
acd_reason
​string | null · required
acd_seconds
​integer | null · int64 · required
answered
​integer · int64 · min: 0 · required
as_of
​string · date-time · required
asr_7d_pct
​string | null · required
attempts
​integer · int64 · min: 0 · required
failed
​integer · int64 · min: 0 · required
pdd_ms
​integer | null · int64 · required
pdd_reason
​string | null · required
​required
window_hours
​integer · int32 · min: 0 · required

Attach an outbound policy to the trunk

PUT
https://api.signals.pressone.africa/v1
/trunks/{trunk_id}/outbound-policy

Attach an outbound policy to the trunk › path Parameters

trunk_id
​string · required

Trunk id

Attach an outbound policy to the trunk › Headers

If-Match
​string · required

The quoted revision the caller last read, so a concurrent change answers 412.

X-Project-ID
​string

The 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_id` is required and may be null, so a body that forgets it never removes a policy.
SetTrunkOutboundPolicyRequest
policy_id
​string | null · required

Attach an outbound policy to the trunk › Responses

The policy is attached and the trunk is applying.

TrunkDetail
concurrency_limit
​integer · int32 · min: 0 · required
concurrency_used
​integer · int32 · min: 0 · required
cps
​string | null · required
currency
​string · required
daily_spend_cap_minor
​integer | null · int64 · required
direction
​TrunkTrafficDirection · enum · required
Enum values:
inbound
outbound
both
​TrunkEndpointSummary · required
id
​string · required
max_call_duration_seconds
​integer · int32 · min: 0 · required
max_destination_rate_minor
​integer | null · int64 · required
name
​string · required
numbers
​integer · int32 · min: 0 · required
parent_name
​string | null · required
project_id
​string · required
revision
​integer · int64 · required

The current revision, quoted as the ETag; a write sends it back in If-Match.

signaling_fqdn
​string | null · required
status
​TrunkLifecycleStatus · enum · required
Enum values:
draft
enabled
disabled
releasing
released
subaccount_id
​string | null · required
subaccount_name
​string | null · required
as_of
​string · date-time · required
​TrunkAuthentication · required
​TrunkEndpointEvidence[] · required
​TrunkLimits · required
​TrunkMedia · required
​TrunkNumbers · required
​required
​TrunkRoute[] · required

Resume new-call admission for a trunk

POST
https://api.signals.pressone.africa/v1
/trunks/{trunk_id}/resume

Resume new-call admission for a trunk › path Parameters

trunk_id
​string · required

Trunk id

Resume new-call admission for a trunk › Headers

If-Match
​string · required

The quoted revision the caller last read, so a concurrent change answers 412.

Idempotency-Key
​string · required

One nonblank key of at most 128 characters; a retry with the same key repeats the outcome.

X-Project-ID
​string

The 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.

TrunkDetail
concurrency_limit
​integer · int32 · min: 0 · required
concurrency_used
​integer · int32 · min: 0 · required
cps
​string | null · required
currency
​string · required
daily_spend_cap_minor
​integer | null · int64 · required
direction
​TrunkTrafficDirection · enum · required
Enum values:
inbound
outbound
both
​TrunkEndpointSummary · required
id
​string · required
max_call_duration_seconds
​integer · int32 · min: 0 · required
max_destination_rate_minor
​integer | null · int64 · required
name
​string · required
numbers
​integer · int32 · min: 0 · required
parent_name
​string | null · required
project_id
​string · required
revision
​integer · int64 · required

The current revision, quoted as the ETag; a write sends it back in If-Match.

signaling_fqdn
​string | null · required
status
​TrunkLifecycleStatus · enum · required
Enum values:
draft
enabled
disabled
releasing
released
subaccount_id
​string | null · required
subaccount_name
​string | null · required
as_of
​string · date-time · required
​TrunkAuthentication · required
​TrunkEndpointEvidence[] · required
​TrunkLimits · required
​TrunkMedia · required
​TrunkNumbers · required
​required
​TrunkRoute[] · required

List subtrunks under a trunk of the project

GET
https://api.signals.pressone.africa/v1
/trunks/{trunk_id}/subtrunks

List subtrunks under a trunk of the project › path Parameters

trunk_id
​string · required

Parent trunk id

List subtrunks under a trunk of the project › Headers

X-Project-ID
​string

The project the request acts on, as prj_ and its lowercase UUID; optional while the organization has one active project.

List subtrunks under a trunk of the project › Responses

Every subtrunk under the trunk.

SubtrunkList
​SubtrunkSummary[] · required

Create a subtrunk under a trunk

POST
https://api.signals.pressone.africa/v1
/trunks/{trunk_id}/subtrunks

Create a subtrunk under a trunk › path Parameters

trunk_id
​string · required

Parent trunk id

Create a subtrunk under a trunk › Headers

Idempotency-Key
​string · required

One nonblank key of at most 128 characters; a retry with the same key repeats the outcome.

X-Project-ID
​string

The project the request acts on, as prj_ and its lowercase UUID; optional while the organization has one active project.

Create a subtrunk under a trunk › Request Body

CreateSubtrunkRequest
name
​string · required
status
​SubtrunkStatusInput · enum · required
Enum values:
enabled
disabled
​

Create a subtrunk under a trunk › Responses

The subtrunk was created.

SubtrunkDetail
​SubtrunkDelegation[] · required
id
​string · required
​SubtrunkInheritance · required
​SubtrunkConfiguration · required
name
​string · required
organization_id
​string · required
revision
​integer · int64 · required

The save revision the ETag quotes; send it back as If-Match.

status
​TrunkLifecycleStatus · enum · required
Enum values:
draft
enabled
disabled
releasing
released
trunk_id
​string · required
​SubtrunkUsage · required

Suspend new-call admission for a trunk

POST
https://api.signals.pressone.africa/v1
/trunks/{trunk_id}/suspend

Suspend new-call admission for a trunk › path Parameters

trunk_id
​string · required

Trunk id

Suspend new-call admission for a trunk › Headers

If-Match
​string · required

The quoted revision the caller last read, so a concurrent change answers 412.

Idempotency-Key
​string · required

One nonblank key of at most 128 characters; a retry with the same key repeats the outcome.

X-Project-ID
​string

The 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.

TrunkDetail
concurrency_limit
​integer · int32 · min: 0 · required
concurrency_used
​integer · int32 · min: 0 · required
cps
​string | null · required
currency
​string · required
daily_spend_cap_minor
​integer | null · int64 · required
direction
​TrunkTrafficDirection · enum · required
Enum values:
inbound
outbound
both
​TrunkEndpointSummary · required
id
​string · required
max_call_duration_seconds
​integer · int32 · min: 0 · required
max_destination_rate_minor
​integer | null · int64 · required
name
​string · required
numbers
​integer · int32 · min: 0 · required
parent_name
​string | null · required
project_id
​string · required
revision
​integer · int64 · required

The current revision, quoted as the ETag; a write sends it back in If-Match.

signaling_fqdn
​string | null · required
status
​TrunkLifecycleStatus · enum · required
Enum values:
draft
enabled
disabled
releasing
released
subaccount_id
​string | null · required
subaccount_name
​string | null · required
as_of
​string · date-time · required
​TrunkAuthentication · required
​TrunkEndpointEvidence[] · required
​TrunkLimits · required
​TrunkMedia · required
​TrunkNumbers · required
​required
​TrunkRoute[] · required

List trunk termination targets

GET
https://api.signals.pressone.africa/v1
/trunks/{trunk_id}/termination-uris

List trunk termination targets › path Parameters

trunk_id
​string · required

Trunk id

List trunk termination targets › Headers

X-Project-ID
​string

The 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.

TrunkTerminationUriList
​TrunkTerminationUri[] · required

Create a trunk termination target

POST
https://api.signals.pressone.africa/v1
/trunks/{trunk_id}/termination-uris

Create a trunk termination target › path Parameters

trunk_id
​string · required

Trunk id

Create a trunk termination target › Headers

If-Match
​string · required

The quoted revision the caller last read, so a concurrent change answers 412.

Idempotency-Key
​string · required

One nonblank key of at most 128 characters; a retry with the same key repeats the outcome.

X-Project-ID
​string

The 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

TrunkTerminationUriRequest
sip_uri
​string · required
transport
​TrunkTransport · enum · required
Enum values:
udp
tcp
tls
enabled
​boolean
priority
​integer · int32
weight
​integer · int32

Create a trunk termination target › Responses

The termination target was added and the trunk is applying.

TrunkTerminationUri
created_at
​string · date-time · required
enabled
​boolean · required
id
​string · required
priority
​integer · int32 · required
sip_uri
​string · required
transport
​TrunkTransport · enum · required
Enum values:
udp
tcp
tls
updated_at
​string · date-time · required
weight
​integer · int32 · required

Delete a trunk termination target

DELETE
https://api.signals.pressone.africa/v1
/trunks/{trunk_id}/termination-uris/{target_id}

Delete a trunk termination target › path Parameters

trunk_id
​string · required

Trunk id

target_id
​string · required

Termination target id

Delete a trunk termination target › Headers

If-Match
​string · required

The quoted revision the caller last read, so a concurrent change answers 412.

X-Project-ID
​string

The 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.

No data returned

Update a trunk termination target

PATCH
https://api.signals.pressone.africa/v1
/trunks/{trunk_id}/termination-uris/{target_id}

Update a trunk termination target › path Parameters

trunk_id
​string · required

Trunk id

target_id
​string · required

Termination target id

Update a trunk termination target › Headers

If-Match
​string · required

The quoted revision the caller last read, so a concurrent change answers 412.

X-Project-ID
​string

The 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

TrunkTerminationUriRequest
sip_uri
​string · required
transport
​TrunkTransport · enum · required
Enum values:
udp
tcp
tls
enabled
​boolean
priority
​integer · int32
weight
​integer · int32

Update a trunk termination target › Responses

The termination target was updated and the trunk is applying.

TrunkTerminationUri
created_at
​string · date-time · required
enabled
​boolean · required
id
​string · required
priority
​integer · int32 · required
sip_uri
​string · required
transport
​TrunkTransport · enum · required
Enum values:
udp
tcp
tls
updated_at
​string · date-time · required
weight
​integer · int32 · required

List retained trunk diagnostic tests

GET
https://api.signals.pressone.africa/v1
/trunks/{trunk_id}/tests

List retained trunk diagnostic tests › path Parameters

trunk_id
​string · required

Trunk id

List retained trunk diagnostic tests › Headers

X-Project-ID
​string

The project the request acts on, as prj_ and its lowercase UUID; optional while the organization has one active project.

List retained trunk diagnostic tests › Responses

The retained diagnostic test history.

TrunkTestHistory
as_of
​string · date-time · required
​TrunkTestRun[] · required
retention_days
​integer · int32 · min: 0 · required
scheduled_check
​boolean · required

Start one trunk diagnostic test

POST
https://api.signals.pressone.africa/v1
/trunks/{trunk_id}/tests

Start one trunk diagnostic test › path Parameters

trunk_id
​string · required

Trunk id

Start one trunk diagnostic test › Headers

Idempotency-Key
​string · required

One nonblank key of at most 128 characters; a retry with the same key repeats the outcome.

X-Project-ID
​string

The project the request acts on, as prj_ and its lowercase UUID; optional while the organization has one active project.

Start one trunk diagnostic test › Request Body

StartTrunkTestRequest
destination
​string | null
​

Start one trunk diagnostic test › Responses

The diagnostic test was accepted.

TrunkTestDetail
destination
​string | null · required
next_sequence
​integer · int64 · min: 0 · required
requested_kind
​TrunkTestKind · enum · required
Enum values:
config_validation
rtp_reachability
test_call
requested_revision
​integer · int64 · required
​TrunkTestRun · required

Read a trunk diagnostic test

GET
https://api.signals.pressone.africa/v1
/trunks/{trunk_id}/tests/{test_id}

Read a trunk diagnostic test › path Parameters

trunk_id
​string · required

Trunk id

test_id
​string · required

Diagnostic test id

Read a trunk diagnostic test › Headers

X-Project-ID
​string

The project the request acts on, as prj_ and its lowercase UUID; optional while the organization has one active project.

Read a trunk diagnostic test › Responses

The diagnostic test.

TrunkTestDetail
destination
​string | null · required
next_sequence
​integer · int64 · min: 0 · required
requested_kind
​TrunkTestKind · enum · required
Enum values:
config_validation
rtp_reachability
test_call
requested_revision
​integer · int64 · required
​TrunkTestRun · required
Subtrunks