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
Signaling Message Types
Request Phone Call
This message is sent from the client to request a phone call.
Format
| {
“type”: “REQUEST_PHONE_CALL”, “number”: “<phone number>” } |
Request SMS
This message is sent from the client to request an SMS session.
Format
| {
“type”: “REQUEST_SMS”, “number”: “<phone number>” } |
Request Call
This message is sent from the client to request a WebRtc call.
Format
| {
“type”: “REQUEST_CALL”, “offerVideo”: true|false } |
Call Rejected
This message is sent from the server to indicate that a requested call was rejected.
Format
| {
“type”: “CALL_REJECTED”, “reason_code”: <reject reason code>, “reason”: TBD } |
Offer Call
This message is sent from the server to start a WebRTC session.
Format
| {
“type”: “OFFER_CALL”, “offerVideo”: true|false, “sdp”: “<session description string>” } |
Answer Call
This message is sent from the client to confirm the WebRTC session started by the server.
Format
| {
“type”: “ANSWER_CALL”, “sdp”: “<session description string>” } |
ICE Candidate
This message is sent from the client or server with ICE candidate description.
Format
| {
“type”: “ICE_CANDIDATE”, “sdpMid”: “<candidate id>”, “sdpMLineIndex”: “<candidate index>”, “candidate”: “<candidate description>” } |
End Call
This message is sent from the client or server to end the current WebRTC session.
Format
| {
“type”: “END_CALL” } |