GetPBXUser

POST

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

DEPRECATED: This method is deprecated and may be removed in future versions. (No longer need PBX Users)
Returns details of the PBX User associated with the pbx_user_id
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.NotFound: The user does not exist or is not in the caller's ORG.

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

{
    "pbx_user_id": "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/getpbxuser' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "pbx_user_id": "string"
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "user": {
        "pbx_user_id": "string",
        "org_user_id": "string",
        "sip_account_ids": [
            "string"
        ]
    }
}

🟢200Success

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

ListPBXUsers

ListRingGroups