Connecting the widget

You can interact with the widget through a global object: window.usedeskMessenger

It is initialized (connects to the server, gets the necessary data) automatically. 

Widget methods

window.usedeskMessenger.userIdentify(
{
    name: 'Rad test',
    email: 'rad@test.test',
    phone: '79222222666',
    additional_fields:
    [
        {
            id: 3840, value: "text"
        },
        {
            id: 3841, value: "checkbox"
        },
        {
            id: 4704, value: "drop-down list"
        },
        [
            {
                id: 4011, value: "Nested list 1"
            },
            {
                id: 4012, value: "Nested list 2"
            },
            {
                id: 4013, value: "Nested list 3"
            }
        ]
    ]
});

Example for getting a token:

window.__usedeskWidgetInitedCallback = function() {            
 
  let token = window.usedeskMessenger.getChatToken();            
 
  console.log(token);        
 
}

The widget can be automatically initialized if the following callback has already appeared in the code of the page by then:

window.__widgetInitedCallback = function (widget) {
    var expectedWidget = window.usedeskMessenger;
    expectedWidget.identify({
        email: 'bob@email.ru',
        phone: '+7911111111111',
        name: 'Bob Marly'
        });
}

If you don't go the first way (via window.__widgetInitCallback), but you send a direst request (see it below), make sure that the user have not clicked and opened the chat before the user's data becomes available, so you will be able to transmit it via userIdentify. 

In such cases we recommend you to conceal and display the widget only after the user's data becomes available and you can transmit it to the widget.

window.usedeskMessenger.userIdentify({name: 'Dwight Schrute', email: 'dwight@mail.ru', phone: '79222222222'})

Initializing a message from a client

Method for sending messages to the widget with its opening-creating a chat:window.usedeskMessenger.sendMessage

Widget's methods

If you need to specify the mail, the system will wait until the chat window opens and immediately send a message.

window.usedeskMessenger.sendMessage({message:"Any text"})

Changing an additional fields

Use method for changing already existing fields in the request window.usedeskMessenger.setAdditionalFields"

Use the method when you pass values into an existing query. The values you pass will be updated for the current query.

window.usedeskMessenger.setAdditionalFields(
    [
        {
            id: 3840, value: "Text"
        },
        {
            id: 4704, value: "Checkbox"
        },
        [
            {
                id: 4011,value: "Nested list"
            }
        ]
    ]
)

Widget's buttons

It is possible to add buttons to the widget conversation by transmitting specific parameters in the messsage.

Parameters

* required fields

In the case of any error of the button configuration it will not appear in the widget. 

Text and button colors are configured on the widget settings page (see "Button text color in messages" and "Button background color in messages"). If none of them are set manually, default colors will be displayed instead.

Example: Take the gun Vincent {{button:Take the gun;https://usedesk.ru;blank;show}}

Widget item identifiers

To collect statistics or customize a widget, you can refer to various elements of the widget through their unique identifiers:

• The widget icon itself - uw-main-button
• Widget close button - uw-main-button-close
• Button to close the chat window when chatting is active - uw-close-chat-button
• Is the task complete? - uw-task-solved-button
• Submit button - uw-message-submit-button
• Attachment button - uw-attachment-button
• Each of the possible channel buttons:
  
  • id: 'uw-button-facebook',
  • id: 'uw-button-telegram',
  • id: 'uw-button-ok',
  • id: 'uw-button-viber',
  • id: 'uw-button-vk',
  • id: 'uw-button-skype',
  • id: 'uw-button-whatsapp',
  • id: 'uw-button-instagram',
• Sending e-mail button when chatting starts - uw-send-email-button
• Pressing the "Back" button and the "Write to us" button while viewing an article in the knowledge base:
  
  • uw-button-docs-write
  • uw-button-docs-back