UpdateRingGroup

POST

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

Updates details of a Ring Group for the authenticated callers ORG. This operation acts as an "upsert".

If the groupID is in the update mask and the group exists, the group will be updated.

If the groupID is not in the update mask a group will be created.
Allows for creating and updating a ring group.
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

{
    "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": [
                            {}
                        ]
                    }
                ]
            }
        ]
    },
    "update_mask": "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/v1/pbxservice/updateringgroup' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "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": [
                            {}
                        ]
                    }
                ]
            }
        ]
    },
    "update_mask": "string"
}'

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

UpdatePbxUser

CreateRingGroup