CreateRingGroup

POST

https://api.cbf.tcn.com/services/pbx/v2/pbxservice/createringgroup

Creates a ring group for the authenticated caller's ORG.
Required permissions:
PBX-MANAGER
Errors:

grpc.InvalidArgument: The request is invalid.

grpc.OutOfRange: The request has fields that are out of range of constraints

grpc.AlreadyExists: The extension or name already exists.

grpc.PermissionDenied: Caller doesn't have the required permissions.

grpc.Internal: An internal error occurred.

grpc.Unavailable: The operation is currently unavailable. Likely a transient issue with a downstream service.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "group": {
        "id": "string",
        "name": "string",
        "description": "string",
        "extension": "string",
        "ring_strategy": "RING_STRATEGY_UNSPECIFIED",
        "sip_account_ids": [
            "string"
        ]
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/services/pbx/v2/pbxservice/createringgroup' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "group": {
        "id": "string",
        "name": "string",
        "description": "string",
        "extension": "string",
        "ring_strategy": "RING_STRATEGY_UNSPECIFIED",
        "sip_account_ids": [
            "string"
        ]
    }
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "group": {
        "id": "string",
        "name": "string",
        "description": "string",
        "extension": "string",
        "ring_strategy": "RING_STRATEGY_UNSPECIFIED",
        "sip_account_ids": [
            "string"
        ]
    }
}

🟢200Success

Modified at 2025-09-26 15:44:58

UpdateRingGroup

DeleteRingGroup