SendEventRinging
SyncId [mandatory] |
String | Store the tracking id for the interaction that can be used in the native platform to create a link between LiveVQ and the native platform. |
Queue | String | |
Customer | String | |
BusinessData | Json | |
CustomData | Json | |
Source | String |
Can be used to identify the method in the code used to send this message from for debugging code purposes |
Minimal
Code
let contactId = contact.getContactId(); CyaraLiveVq.SendEventRinging({ SyncId: contactId });
Payload
{ "type": "cyara-agent-event", "what": "ringing", "details": { "syncid": "6d542175-47dd-428e-bf5e-64895231a018" }, "publickey": "942cce9d-63a9-4908-aae5-ce617b1ea785", "by": "api", "source": "custom" }
Custom
Code
// our business logic... let crm = {}; crm.profile = { name: 'Toby Dux', team: 'Gruffalo', pwd: 'secret', account: '529485' } // obfuscate the data here so Cyara does not see it... delete crm.profile.pwd; // ensure sensitive keys are not provided from the IVR delete attributes?.crmlink; delete attributes?.saveSuggestion; CyaraLiveVq.SendEventRinging({ SyncId: contactId, Queue: crm.profile.team, BusinessData: attributes, CustomData: crm });
Payload
{ "type": "cyara-agent-event", "what": "ringing", "details": { "syncid": "c905f44e-89cb-422d-bd2e-c6f7f5f217b9", "queue": "Gruffalo", "businessdata": { "CustomerNumber": "3330", "CustomerTier": "Gold", "Selection": "Load" }, "customdata": { "profile": { "name": "Toby Dux", "team": "Gruffalo", "account": "529485" } } }, "publickey": "942cce9d-63a9-4908-aae5-ce617b1ea785", "by": "api", "source": "custom" }
BlackBox
Payload
{ "type": "cyara-agent-event", "what": "contact-incoming", "queue": { "queueARN": "arn:aws:connect:us-east-1:359670509492:instance/227c5107-cee0-4044-9ec1-27e9c9a1bdb0/queue/8d7fc2e9-cfc5-40d8-aa6b-bf27453cb931", "name": "Dev", "queueId": "arn:aws:connect:us-east-1:359670509492:instance/227c5107-cee0-4044-9ec1-27e9c9a1bdb0/queue/8d7fc2e9-cfc5-40d8-aa6b-bf27453cb931" }, "attributes": { "CustomerNumber": "3330", "CustomerTier": "Gold", "Selection": "Load" }, "contactid": "7494d00a-fb14-4f3f-af29-e0fa1046f592", "caller": { "endpointARN": null, "endpointId": null, "type": "phone_number", "name": null, "phoneNumber": "Restricted", "agentLogin": null, "queue": null }, "raw": { "contactId": "7494d00a-fb14-4f3f-af29-e0fa1046f592" }, "by": "hey-cyara", "source": "api", "publickey": "942cce9d-63a9-4908-aae5-ce617b1ea785" }
Comments
0 comments
Please sign in to leave a comment.