Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Scroll export button
scopecurrent
template-id0fa09813-8b86-460a-aa1d-ef450a80e9ce
quick-starttrue
add-onScroll PDF Exporter

Info

This guide explains how to configure x-hoppers integration with Veesion, software that allows to detect thefts in real time. 

Created: January 2023

Updated: April 2024

Permalink: https://wildix.atlassian.net/wiki/x/AQA_Bg

Other documentation: x-hoppers User Guide,  x-hoppers Admin Guide

...

Veesion is software that helps to detect thefts in retails retail stores in real time, by analysing video feeds and sending real time alerts when suspicious behaviour is detected.

...

Easy html macro
<iframe src="https://wildixfast.wistia.com/embed/medias/fwjlhlantt" width="560" height="315" frameborder="0" allowfullscreen="allowfullscreen"></iframe>

...

Configure Veesion integration

Note

Note: The support starts from WMS Beta 6.02.20221228.1.

Step 1. Configuration of the webhook

...

  • URL of the hook (with PBX as host)
  • store_veesion_id
Note

Note: For PBX authorization, the webhook URL should contain the parameter with PBX token /?token=<simple>.  

...

  1. Add a Dialplan rule named veesion
  2. In the veesion Dialplan, add the following numbers:
    1. *Alerts", with application Conference and the relevant Room Number:


    2. veesion, with the application Play sound, typing text and variables to be played in the conference.

      Example: Attention! Theft detected in ${storeId} on ${cameraId}

      Available variables:

      • storeId
      • startDate
      • endDate
      • cameraIp
      • cameraId
      • groupId
      • videoUrl
      • alertType

Post Veesion alerts to x-bees conversation

Starting from WMS 6.03.20230630.3, it is possible to configure Veesion alerts to be sent to x-bees conversation (you can refer to x-bees documentation for more information about x-bees). The message that is sent to x-bees includes alert type, date, time, camera IP, ID of the camera and group, as well as the relevant video attachment. 

Note

Note: The feature works only if there is an x-hoppers license available on the PBX.

How to configure 

  1. Add a user in WMS
  2. Create x-bees conversation with the user created in step 1 and copy the conversation ID (available in the URL)

    Image Added

  3. Add following data to the /rw2/etc/pbx/x-hoppers.json file:

    Code Block
    [
      {
        "store_veesion_id": "test-store-wildix",
        "name": "Store1",
        "audio_conf_id": "2",
        "location": "Odesa",
        "xbees_channel_id": "f6d17593-98b6-471d-941a-cd03153f",
        "veesion_user_extension": "12345"
      }
    ]

    Where:

    • store_veesion_id: ID of the store on the Veesion side
    • name: name of the store 
    • audio_conf_id: ID of the audio broadcast channel in x-hoppers where the communication takes place
    • location: location of the store
    • xbees_channel_id: ID of the x-bees conversation, copied in step 2, where the content will be posted.
    • user: user, on behalf of whom the content will be posted

How to modify the alert 

Starting from WMS Beta 6.06.20240325.1, it is possible to edit x-hoppers theft alerts: remove camera ID, IP address and group ID, as well as add a message header.

For this, add the following parameters to the /rw2/etc/pbx/x-hoppers.json file:


a) To remove camera IP, camera ID and group ID:

  • "remove_camera_ip": true,
  • "remove_camera_id": true,
  • "remove_group_id": true,

By default, the values are false and camera IP, ID and group ID are displayed in the theft alert.

b) To add message header:

  • "xbees_message_header": "header text"

Where "header text" is your custom text for the message header. By default, theft alerts are sent without a header. 


Macrosuite divider macro
dividerTypetext
dividerWidth70
emoji{"id":"smile","name":"Smiling Face with Open Mouth and Smiling Eyes","short_names":["smile"],"colons":":smile:","emoticons":["C:","c:",":D",":-D"],"unified":"1f604","skin":null,"native":"😄"}
textColor#000000
dividerWeight2
labelPositionmiddle
textAlignmentcenter
iconColor#0052CC
fontSizemedium
textNot finding the help you need? Join the Facebook group to ask a question!
emojiEnabledfalse
dividerColor#DFE1E6
dividerIconbootstrap/CloudsFill

...