Avaya Co-Browsing Snap-in provides the following Customer and Agent REST API endpoints. . If you need to configure firewall, proxy, or any other filters, you must allow the following endpoints for Avaya Co-Browsing Snap-in.
Note:
The Customer and Agent REST APIs are used by the co-browsing client SDK. Hence, the request and response parameters are not mentioned here.
Endpoint Interface |
REST API version |
REST API |
Description |
Customer |
V1 |
/services/CoBrowse/v1/customer/session/request |
Allows customer to generate passphrase and join the co-browse session. This is customer-initiated session. |
/services/CoBrowse/v1/customer/session/join |
Allows customer to join the co-browse session initiated by an agent. |
/services/CoBrowse/v1/customer/session/logout |
Allows customer to logout from the co-browse session. |
/services/CoBrowse/v1/customer/status |
Customer status. |
Agent |
V1 |
/services/CoBrowse/v1/agent/session/request |
If autojoin is true, allows agent to generate passphrase and join the co-browse session. (one step process) If autojoin is false, only passphrase is generated. (two-step process) |
/services/CoBrowse/v1/agent/session/join |
In the above request, when autojoin is passed as false, this request is required to join the co-browse session in the two-step process. Agent first generates the passphrase in the first step and joins in the second step. |
/services/CoBrowse/v1/agent/session/live/join |
Allows agent to join co-browse session when customer has already joined and is waiting for the agent. |
/services/CoBrowse/v1/agent/session/logout |
Allows agent to logout from the session. |
/services/CoBrowse/v1/agent/status |
Agent status. |
Server Status |
V1 |
/services/CoBrowse/v1/server/status |
Returns co-browse server status as successful or not. |
sockjs endpoint |
REST API version |
REST API |
Description |
Customer |
|
/services/CoBrowse/sockjs/cobrowse/customer/ |
Handles the co-browse traffic over the websocket from customer. |
Agent |
|
/services/CoBrowse/sockjs/cobrowse/agent/ |
Handles the co-browse traffic over the websocket from agent. |
To check the co-browse server status, type the following URL:
https://<Cluster_IP>/services/CoBrowse/v1/server/status
where <Cluster_IP> is the IP address of the Avaya Co-Browsing Snap-in cluster where the service that you want to verify is running.
