CreateRingGroup

POST

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

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

grpc.InvalidArgument: The request is invalid.

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

{
    "name": "string",
    "description": "string",
    "ring_strategy": "RING_STRATEGY_UNSPECIFIED",
    "pbx_user_ids": [
        "string"
    ],
    "extension": 0
}

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/v1/pbxservice/createringgroup' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "description": "string",
    "ring_strategy": "RING_STRATEGY_UNSPECIFIED",
    "pbx_user_ids": [
        "string"
    ],
    "extension": 0
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "group": {
        "id": "string",
        "name": "string",
        "description": "string",
        "extension": 0,
        "ring_strategy": "RING_STRATEGY_UNSPECIFIED",
        "pbx_users": [
            {
                "pbx_user_id": "string",
                "org_user_id": "string",
                "sip_accounts": [
                    {
                        "sip_id": "string",
                        "is_active": true,
                        "extension": 0,
                        "ring_groups": [
                            {}
                        ]
                    }
                ]
            }
        ]
    }
}

🟢200Success

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

UpdateRingGroup

DeleteRingGroup