This documentation outlines the methods of the Window Proxy API for the uContact portal, which enables the portal to be embedded into any site via an iframe. This allows the host site to receive and send events to perform specific actions, such as being notified of incoming calls or making calls.
For uContact v6 instances, the URL will be https://instancedomain/uphone
Creating the iframe
Code Block | ||
---|---|---|
| ||
<iframe src="https://yourInstance.ucontactcloud.com/uphone/url" scrolling="no" allow="camera;microphone"> </iframe> |
allow attribute is required for calls and video calls
Event notifications
Messages will be sent to the parent page when these events occur:
...
Making a call
Receiving a call
Sent dispositions
Agent login
The information will be received in the following format
...
Code Block | ||
---|---|---|
| ||
{
"action": "sentDispositions",
"params":{
"campaign": "Incoming<-",
"clientId": "9999",
"date": "2022-6-17 12:51:59",
"direction": "incoming",
"dispositions": {
"action": "NOACTION"
"comment": "comment"
"value1": "Venta"
"value2": ""
"value3": ""
},
"duration": "123",
"guid": "6353dfa0-2a90-4d57-b145-1c3826cde381"
}
} |
Agent Login
Code Block | ||
---|---|---|
| ||
{ "action": "agentLogin", "params":{ "fullname": "uContact User", "callerid": "4444", "username": "ccass_ucontact", } } |
Execute actions
You can execute actions on uPhone by using the window proxy API.
...