Help Center/ Customer Engagement Center/ API Reference/ System Configuration API Reference (API Fabric)/ Co-browsing/ Obtaining Co-browsing Connection Information (V1.0.0) (getConnectionInfo)
Updated on 2025-11-13 GMT+08:00
View PDF
Share

Obtaining Co-browsing Connection Information (V1.0.0) (getConnectionInfo)

Scenario

This interface is invoked to obtain co-browsing connection information.

Method

POST

URI

https://Domain name/apiaccess/api/cobrowse/getConnectionInfo (For example, the domain name is service.besclouds.com.)

Request Description

Table 1 Request header parameters

No.

Parameter

Type

Mandatory or Not

Description

1

x-app-key

String

Yes

App key, which is the user ID and is configured on the API Fabric

2

Authorization

String

Yes

Authentication field. The format is Bearer {Value of AccessToken returned by the tokenByAkSk interface}. (A space is required after Bearer.)

3

X-TenantSpaceID

String

Yes

Tenant space ID
Table 2 Request body parameters

No.

Parameter

Type

Mandatory or Not

Description

1

roomId

String

No

Co-browsing room ID

(Generally, the value is a session ID. If this parameter is not passed, a UUID is generated by default. Ensure that the room IDs on both sides are the same.)

2

userId

String

No

User ID

3

userName

String

No

Username

4

workNo

String

No

Agent ID

5

role

String

Yes

Co-browsing role

  • replayer: agent
  • recorder: user

Response Description

  • Status code: 200
    Table 3 Response body parameters

    No.

    Parameter

    Type

    Mandatory or Not

    Description

    1

    success

    Boolean

    Yes

    Operation result

    • true: success
    • false: failure

    2

    data

    Object

    No

    Returned data

    2.1

    roomId

    String

    No

    Co-browsing room ID

    (Generally, the value is a session ID. If this parameter is not passed, a UUID is generated by default. Ensure that the room IDs on both sides are the same.)

    2.2

    wssUrl

    String

    No

    Internal access URL

    2.3

    wssUrlOut

    String

    No

    External access URL (accessible over public networks)

    2.4

    connectParam

    String

    No

    Signature

    3

    errorCode

    Number

    Yes

    Error code

    4

    errorReason

    String

    Yes

    Error cause
  • Status code: 401

    HTTP response code when the authentication fails.

  • Status code: 404

    HTTP response code when the requested resource does not exist.

  • Status code: 500

    HTTP response code when an internal error occurs on the server.

Error Codes

None

Example

Request header: 
{
    "x-app-key": "****",
    "Authorization": "Bearer xxxx",
    "X-TenantSpaceID": "****"
}

Request parameters:

{
    "roomId": "10***04",
    "workNo": "667",
    "role": "replayer"
}

Response parameters:

{
    "success": true,
    "data": {
        "roomId": "10***04",
        "wssUrl": "wss://IP:PORT/ws/cobrowse/1",
        "wssUrlOut": "wss://IP:PORT/ws/cobrowse/1",
        "connectParam": "****"
    },
    "errorCode": null,
    "errorReason": null
}

Parent topic: Co-browsing