From Bright Pattern Documentation
Contents
- Introduction
- API Methods
- General Information
- Check Availability
- Expected Parameters
- Request Chat
- Request SMS Chat Session
- Get Active Chat
- Send Events
- Get Chat History
- Get New Chat Events
- Upload File
- Get File
- Get Agent Profile Photo
- API Events
Mobile/Web API Specification
Signaling Message Types
Request Call
| Description | This message is sent from client to request a WebRTC call. |
| Format | {
“type”: “REQUEST_CALL”, “offerVideo”: true|false } |
Call Rejected
| Description | This message is sent from server to indicate that a requested call was rejected. |
| Format | {
“type”: “CALL_REJECTED”, “reason_code”: <reject reason code>, “reason”: TBD } |
Offer Call
| Description | This message is sent from server to start a WebRTC session. |
| Format | {
“type”: “OFFER_CALL”, “offerVideo”: true|false, “sdp”: “<session description string>” } |
Answer Call
| Description | This message is sent from client to confirm the WebRTC session started by server. |
| Format | {
“type”: “ANSWER_CALL”, “sdp”: “<session description string>” } |
ICE Candidate
| Description | This message is sent from client or server with ICE candidate description. |
| Format | {
“type”: “ICE_CANDIDATE”, “sdpMid”: “<candidate id>”, “sdpMLineIndex”: “<candidate index>”, “candidate”: “<candidate description>” } |
End Call
| Description | This message is sent from client or server to end current WebRTC session. |
| Format | {
“type”: “END_CALL” } |