Signals Docs
Platform
Platform

Subaccounts

List project subaccounts

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

List project subaccounts › 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 project subaccounts › Responses

Every subaccount.

SubaccountList
​Subaccount[] · required

Create a project subaccount

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

Create a project subaccount › 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 project subaccount › Request Body

CreateSubaccountRequest
​SubaccountConfigurationInput · required
name
​string · required

Create a project subaccount › Responses

The subaccount was created.

Subaccount
created_at
​string · date-time · required
currency
​string · required
daily_spend_cap_minor
​integer | null · int64 · required
​SubaccountPolicyCeilings[] · required
id
​string · required
live_calls
​integer · int32 · min: 0 · required
max_call_duration_seconds
​integer | null · int32 · required
max_concurrent
​integer | null · int32 · required
max_cps
​integer | null · int32 · required
max_destination_rate_minor
​integer | null · int64 · required
name
​string · required
revision
​integer · int64 · required

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

status
​SubaccountLifecycleStatus · enum · required
Enum values:
enabled
suspended
updated_at
​string · date-time · required
​SubaccountUsage30Days · required

Read one project subaccount

GET
https://api.signals.pressone.africa/v1
/subaccounts/{subaccount_id}

Read one project subaccount › path Parameters

subaccount_id
​string · required

Subaccount id

Read one project subaccount › 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 one project subaccount › Responses

The subaccount.

Subaccount
created_at
​string · date-time · required
currency
​string · required
daily_spend_cap_minor
​integer | null · int64 · required
​SubaccountPolicyCeilings[] · required
id
​string · required
live_calls
​integer · int32 · min: 0 · required
max_call_duration_seconds
​integer | null · int32 · required
max_concurrent
​integer | null · int32 · required
max_cps
​integer | null · int32 · required
max_destination_rate_minor
​integer | null · int64 · required
name
​string · required
revision
​integer · int64 · required

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

status
​SubaccountLifecycleStatus · enum · required
Enum values:
enabled
suspended
updated_at
​string · date-time · required
​SubaccountUsage30Days · required

Update a project subaccount

PATCH
https://api.signals.pressone.africa/v1
/subaccounts/{subaccount_id}

Update a project subaccount › path Parameters

subaccount_id
​string · required

Subaccount id

Update a project subaccount › 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 project subaccount › Request Body

UpdateSubaccountRequest
​
name
​string | null

Update a project subaccount › Responses

The subaccount was updated.

Subaccount
created_at
​string · date-time · required
currency
​string · required
daily_spend_cap_minor
​integer | null · int64 · required
​SubaccountPolicyCeilings[] · required
id
​string · required
live_calls
​integer · int32 · min: 0 · required
max_call_duration_seconds
​integer | null · int32 · required
max_concurrent
​integer | null · int32 · required
max_cps
​integer | null · int32 · required
max_destination_rate_minor
​integer | null · int64 · required
name
​string · required
revision
​integer · int64 · required

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

status
​SubaccountLifecycleStatus · enum · required
Enum values:
enabled
suspended
updated_at
​string · date-time · required
​SubaccountUsage30Days · required

Resume call admission for a subaccount

POST
https://api.signals.pressone.africa/v1
/subaccounts/{subaccount_id}/resume

Resume call admission for a subaccount › path Parameters

subaccount_id
​string · required

Subaccount id

Resume call admission for a subaccount › 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 call admission for a subaccount › Request Body

SubaccountStatusRequest
confirm_name
​string · required

Resume call admission for a subaccount › Responses

The subaccount is enabled; its trunks apply in the background.

Subaccount
created_at
​string · date-time · required
currency
​string · required
daily_spend_cap_minor
​integer | null · int64 · required
​SubaccountPolicyCeilings[] · required
id
​string · required
live_calls
​integer · int32 · min: 0 · required
max_call_duration_seconds
​integer | null · int32 · required
max_concurrent
​integer | null · int32 · required
max_cps
​integer | null · int32 · required
max_destination_rate_minor
​integer | null · int64 · required
name
​string · required
revision
​integer · int64 · required

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

status
​SubaccountLifecycleStatus · enum · required
Enum values:
enabled
suspended
updated_at
​string · date-time · required
​SubaccountUsage30Days · required

Suspend new call admission for a subaccount

POST
https://api.signals.pressone.africa/v1
/subaccounts/{subaccount_id}/suspend

Suspend new call admission for a subaccount › path Parameters

subaccount_id
​string · required

Subaccount id

Suspend new call admission for a subaccount › 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 subaccount › Request Body

SubaccountStatusRequest
confirm_name
​string · required

Suspend new call admission for a subaccount › Responses

The subaccount is suspended; its trunks apply in the background.

Subaccount
created_at
​string · date-time · required
currency
​string · required
daily_spend_cap_minor
​integer | null · int64 · required
​SubaccountPolicyCeilings[] · required
id
​string · required
live_calls
​integer · int32 · min: 0 · required
max_call_duration_seconds
​integer | null · int32 · required
max_concurrent
​integer | null · int32 · required
max_cps
​integer | null · int32 · required
max_destination_rate_minor
​integer | null · int64 · required
name
​string · required
revision
​integer · int64 · required

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

status
​SubaccountLifecycleStatus · enum · required
Enum values:
enabled
suspended
updated_at
​string · date-time · required
​SubaccountUsage30Days · required
Projects