Subtrunks

Read a subtrunk of the project

GET

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

/subtrunks/{subtrunk_id}

Read a subtrunk of the project › path Parameters

subtrunk_id

string · required

Subtrunk id

Read a subtrunk 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 subtrunk of the project › Responses

The subtrunk.

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

GET/subtrunks/{subtrunk_id}

curl https://api.signals.pressone.africa/v1/subtrunks/:subtrunk_id \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "delegations": [
    {
      "assigned_at": "2024-08-25T15:00:00Z",
      "assigned_by": "assigned_by",
      "block_id": "block_id",
      "end": "end",
      "id": "id",
      "size": 0,
      "start": "start",
      "status": "pending"
    }
  ],
  "id": "id",
  "inheritance": {
    "organization_allowed_destinations": [
      "string"
    ],
    "shared_policy": {
      "acknowledged_at": "2024-08-25T15:00:00Z",
      "currency": "NGN",
      "daily_spend_cap_minor": 0,
      "id": "id",
      "max_call_duration_seconds": 0,
      "max_concurrent": 0,
      "max_cps": 0,
      "max_destination_rate_minor": 0,
      "name": "name",
      "revision": 0,
      "runtime_revision": 0
    }
  },
  "limits": {
    "concurrency": 0,
    "cps": 0,
    "daily_spend_cap_minor": 0,
    "max_call_duration_seconds": 0,
    "max_destination_rate_minor": 0,
    "velocity_cap_minor": 0
  },
  "name": "name",
  "organization_id": "organization_id",
  "revision": 0,
  "status": "draft",
  "trunk_id": "trunk_id",
  "usage": {
    "answered_calls": 0,
    "as_of": "2024-08-25T15:00:00Z",
    "call_attempts": 0,
    "currency": "NGN",
    "pending_spend_minor": 0,
    "refusals": [
      {
        "count": 0,
        "reason": "reason"
      }
    ],
    "refused_calls": 0,
    "settled_spend_minor": 0,
    "window_from": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Release an unreferenced subtrunk

DELETE

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

/subtrunks/{subtrunk_id}

Release an unreferenced subtrunk › path Parameters

subtrunk_id

string · required

Subtrunk id

Release an unreferenced subtrunk › 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 an unreferenced subtrunk › Request Body

ReleaseSubtrunkRequest

confirm_name

string · required

Release an unreferenced subtrunk › Responses

The subtrunk is releasing; the parent's apply retires it.

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

DELETE/subtrunks/{subtrunk_id}

curl https://api.signals.pressone.africa/v1/subtrunks/:subtrunk_id \
  --request DELETE \
  --header 'Content-Type: application/json' \
  --header 'If-Match: <string>' \
  --header 'Idempotency-Key: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "confirm_name": "confirm_name"
}'

Example Request Body

{
  "confirm_name": "confirm_name"
}

json

Example Responses

{
  "delegations": [
    {
      "assigned_at": "2024-08-25T15:00:00Z",
      "assigned_by": "assigned_by",
      "block_id": "block_id",
      "end": "end",
      "id": "id",
      "size": 0,
      "start": "start",
      "status": "pending"
    }
  ],
  "id": "id",
  "inheritance": {
    "organization_allowed_destinations": [
      "string"
    ],
    "shared_policy": {
      "acknowledged_at": "2024-08-25T15:00:00Z",
      "currency": "NGN",
      "daily_spend_cap_minor": 0,
      "id": "id",
      "max_call_duration_seconds": 0,
      "max_concurrent": 0,
      "max_cps": 0,
      "max_destination_rate_minor": 0,
      "name": "name",
      "revision": 0,
      "runtime_revision": 0
    }
  },
  "limits": {
    "concurrency": 0,
    "cps": 0,
    "daily_spend_cap_minor": 0,
    "max_call_duration_seconds": 0,
    "max_destination_rate_minor": 0,
    "velocity_cap_minor": 0
  },
  "name": "name",
  "organization_id": "organization_id",
  "revision": 0,
  "status": "draft",
  "trunk_id": "trunk_id",
  "usage": {
    "answered_calls": 0,
    "as_of": "2024-08-25T15:00:00Z",
    "call_attempts": 0,
    "currency": "NGN",
    "pending_spend_minor": 0,
    "refusals": [
      {
        "count": 0,
        "reason": "reason"
      }
    ],
    "refused_calls": 0,
    "settled_spend_minor": 0,
    "window_from": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Edit a subtrunk

PATCH

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

/subtrunks/{subtrunk_id}

Edit a subtrunk › path Parameters

subtrunk_id

string · required

Subtrunk id

Edit a subtrunk › 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.

Edit a subtrunk › Request Body

UpdateSubtrunkRequest

name

string | null

Edit a subtrunk › Responses

The subtrunk was updated.

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

PATCH/subtrunks/{subtrunk_id}

curl https://api.signals.pressone.africa/v1/subtrunks/:subtrunk_id \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'If-Match: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "limits": {
    "concurrency": 0,
    "cps": 0,
    "daily_spend_cap_minor": 0,
    "max_call_duration_seconds": 0,
    "max_destination_rate_minor": 0,
    "velocity_cap_minor": 0
  },
  "name": "name",
  "status": "enabled"
}'

Example Request Body

{
  "limits": {
    "concurrency": 0,
    "cps": 0,
    "daily_spend_cap_minor": 0,
    "max_call_duration_seconds": 0,
    "max_destination_rate_minor": 0,
    "velocity_cap_minor": 0
  },
  "name": "name",
  "status": "enabled"
}

json

Example Responses

{
  "delegations": [
    {
      "assigned_at": "2024-08-25T15:00:00Z",
      "assigned_by": "assigned_by",
      "block_id": "block_id",
      "end": "end",
      "id": "id",
      "size": 0,
      "start": "start",
      "status": "pending"
    }
  ],
  "id": "id",
  "inheritance": {
    "organization_allowed_destinations": [
      "string"
    ],
    "shared_policy": {
      "acknowledged_at": "2024-08-25T15:00:00Z",
      "currency": "NGN",
      "daily_spend_cap_minor": 0,
      "id": "id",
      "max_call_duration_seconds": 0,
      "max_concurrent": 0,
      "max_cps": 0,
      "max_destination_rate_minor": 0,
      "name": "name",
      "revision": 0,
      "runtime_revision": 0
    }
  },
  "limits": {
    "concurrency": 0,
    "cps": 0,
    "daily_spend_cap_minor": 0,
    "max_call_duration_seconds": 0,
    "max_destination_rate_minor": 0,
    "velocity_cap_minor": 0
  },
  "name": "name",
  "organization_id": "organization_id",
  "revision": 0,
  "status": "draft",
  "trunk_id": "trunk_id",
  "usage": {
    "answered_calls": 0,
    "as_of": "2024-08-25T15:00:00Z",
    "call_attempts": 0,
    "currency": "NGN",
    "pending_spend_minor": 0,
    "refusals": [
      {
        "count": 0,
        "reason": "reason"
      }
    ],
    "refused_calls": 0,
    "settled_spend_minor": 0,
    "window_from": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Outbound policies Trunks