Signals Docs
SIP Trunking
SIP Trunking

Outbound policies

List the project's outbound policies

GET
https://api.signals.pressone.africa/v1
/outbound-policies

List the project's outbound policies › 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 outbound policies › Responses

Every outbound policy.

OutboundPolicyList
​OutboundPolicySummary[] · required

Create an outbound policy

POST
https://api.signals.pressone.africa/v1
/outbound-policies

Create an outbound policy › 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 an outbound policy › Request Body

OutboundPolicyRequest
name
​string · required
recording_channels
​RecordingPolicyChannelsInput · enum · int32 · required
Enum values:
2
recording_mode
​RecordingPolicyMode · enum · required
Enum values:
off
all
recording_retention_days
​RecordingRetentionDays · enum · int32 · required
Enum values:
30
90
365
concurrency
​integer | null · int32 · min: 0
cps
​integer | null · int32 · min: 0
daily_spend_limit_minor
​integer | null · int64
max_call_duration_seconds
​integer | null · int32 · min: 0
max_destination_rate_minor
​integer | null · int64

Create an outbound policy › Responses

The policy was created and is live.

OutboundPolicyDetail
applied_services
​integer · int64 · min: 0 · required
attached_services
​integer · int64 · min: 0 · required
​PolicyAttachmentRef[] · required
​PolicyCeilings · required
currency
​string · required
​PolicyDestinationSummary · required
id
​string · required
name
​string · required
​PolicyRecording · required
revision
​integer · int64 · required

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

status
​OutboundPolicyStatus · enum · required
Enum values:
active
archived
system_default
​boolean · required
as_of
​string · date-time · required
billing_group
​string · required
created_at
​string · date-time · required
created_by
​string | null · required
​PolicyDestinations · required

Read an outbound policy of the project

GET
https://api.signals.pressone.africa/v1
/outbound-policies/{policy_id}

Read an outbound policy of the project › path Parameters

policy_id
​string · required

Outbound policy id

Read an outbound policy 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 an outbound policy of the project › Responses

The outbound policy.

OutboundPolicyDetail
applied_services
​integer · int64 · min: 0 · required
attached_services
​integer · int64 · min: 0 · required
​PolicyAttachmentRef[] · required
​PolicyCeilings · required
currency
​string · required
​PolicyDestinationSummary · required
id
​string · required
name
​string · required
​PolicyRecording · required
revision
​integer · int64 · required

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

status
​OutboundPolicyStatus · enum · required
Enum values:
active
archived
system_default
​boolean · required
as_of
​string · date-time · required
billing_group
​string · required
created_at
​string · date-time · required
created_by
​string | null · required
​PolicyDestinations · required

Delete an outbound policy, detaching its services when asked

DELETE
https://api.signals.pressone.africa/v1
/outbound-policies/{policy_id}

Delete an outbound policy, detaching its services when asked › path Parameters

policy_id
​string · required

Outbound policy id

Delete an outbound policy, detaching its services when asked › query Parameters

detach
​boolean

Detach every attached service first; each detach saves that service's trunk.

Delete an outbound policy, detaching its services when asked › 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.

Delete an outbound policy, detaching its services when asked › Responses

The policy was deleted; detached trunks re-apply in the background.

No data returned

Replace an outbound policy's limits and recording

PATCH
https://api.signals.pressone.africa/v1
/outbound-policies/{policy_id}

Replace an outbound policy's limits and recording › path Parameters

policy_id
​string · required

Outbound policy id

Replace an outbound policy's limits and recording › 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.

Replace an outbound policy's limits and recording › Request Body

OutboundPolicyRequest
name
​string · required
recording_channels
​RecordingPolicyChannelsInput · enum · int32 · required
Enum values:
2
recording_mode
​RecordingPolicyMode · enum · required
Enum values:
off
all
recording_retention_days
​RecordingRetentionDays · enum · int32 · required
Enum values:
30
90
365
concurrency
​integer | null · int32 · min: 0
cps
​integer | null · int32 · min: 0
daily_spend_limit_minor
​integer | null · int64
max_call_duration_seconds
​integer | null · int32 · min: 0
max_destination_rate_minor
​integer | null · int64

Replace an outbound policy's limits and recording › Responses

The policy was saved; every attached trunk re-applies in the background.

OutboundPolicyDetail
applied_services
​integer · int64 · min: 0 · required
attached_services
​integer · int64 · min: 0 · required
​PolicyAttachmentRef[] · required
​PolicyCeilings · required
currency
​string · required
​PolicyDestinationSummary · required
id
​string · required
name
​string · required
​PolicyRecording · required
revision
​integer · int64 · required

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

status
​OutboundPolicyStatus · enum · required
Enum values:
active
archived
system_default
​boolean · required
as_of
​string · date-time · required
billing_group
​string · required
created_at
​string · date-time · required
created_by
​string | null · required
​PolicyDestinations · required

List services attached to an outbound policy

GET
https://api.signals.pressone.africa/v1
/outbound-policies/{policy_id}/attachments

List services attached to an outbound policy › path Parameters

policy_id
​string · required

Outbound policy id

List services attached to an outbound policy › 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 services attached to an outbound policy › Responses

Every service attached to the policy.

PolicyAttachmentList
​PolicyAttachment[] · required

Allow, deny or remove destinations of an outbound policy

PATCH
https://api.signals.pressone.africa/v1
/outbound-policies/{policy_id}/destination-rules

Allow, deny or remove destinations of an outbound policy › path Parameters

policy_id
​string · required

Outbound policy id

Allow, deny or remove destinations of an outbound policy › 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.

Allow, deny or remove destinations of an outbound policy › Request Body

ChangeOutboundPolicyDestinationRulesRequest
​DestinationRuleChangeInput[] · required

Allow, deny or remove destinations of an outbound policy › Responses

The destination rules were changed.

OutboundPolicyDetail
applied_services
​integer · int64 · min: 0 · required
attached_services
​integer · int64 · min: 0 · required
​PolicyAttachmentRef[] · required
​PolicyCeilings · required
currency
​string · required
​PolicyDestinationSummary · required
id
​string · required
name
​string · required
​PolicyRecording · required
revision
​integer · int64 · required

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

status
​OutboundPolicyStatus · enum · required
Enum values:
active
archived
system_default
​boolean · required
as_of
​string · date-time · required
billing_group
​string · required
created_at
​string · date-time · required
created_by
​string | null · required
​PolicyDestinations · required
Destination countriesSubtrunks