GetSIPAccountByUserId

POST

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

Returns details of the SIP Account associated with the org_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 group 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

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

Responses

🟢200OK

application/json

Success

Body

Example

{
    "sip_account": {
        "sip_id": "string",
        "is_active": true,
        "extension": "string",
        "ring_group_ids": [
            "string"
        ],
        "org_user_id": "string",
        "ring_groups": [
            {
                "ring_group_id": "string",
                "ring_group_name": "string"
            }
        ],
        "org_username": "string",
        "org_full_name": "string",
        "org_hunt_group": {
            "hunt_group_sid": "string",
            "hunt_group_name": "string"
        },
        "org_skills": [
            {
                "skill_sid": "string",
                "skill_name": "string"
            }
        ],
        "org_permission_groups": [
            {
                "permission_group_id": "string",
                "permission_group_name": "string"
            }
        ]
    }
}

🟢200Success

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

GetSIPAccount

GetSIPCredentials