Versions Compared

Key

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

...

Info

This guide explains how to configure x-hoppers integration with Veesion

Created: January 2023

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

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

...

Examples of using Veesion API

  • Get token:


Code Block
curl -v --header "Content-Type: application/json" --request POST --data '{"username":"webhook_user@wildix","password":"5SNd#3Ov7h*F"}' https://api.klaxon.veesion.io/token 
{"token":"1dcbf200cc775968a62a41dad40b8298bd5165a8","expires_in":"1702.352942"} 


  • Get user info:


Code Block
curl -v --header "Authorization: Token 1dcbf200cc775968a62a41dad40b8298bd5165a8" --request GET https://api.klaxon.veesion.io/user-info {"user":"webhook_user@wildix","expires_in":"805.326849"}
  • Get stores:


Code Block
curl -v --header "Authorization: Token 1dcbf200cc775968a62a41dad40b8298bd5165a8" --request GET https://api.klaxon.veesion.io/stores 
{"stores":[{"store_veesion_id":"test-store-wildix","store_veesion_name":"test store wildix","store_id":""}]} 
  • Set hooks:


Code Block
curl -v --header "Authorization: Token 1dcbf20cc7768a641da40b829bd565a8" --header "Content-Type: application/json" --request POST --data '{"store_veesion_id":"test-store-wildix","hooks":["https://semen.wildixin.com/api/v1/veesion?token=access_Wq1WDc79z3Q2Lk6eVlKnaHjuwITfYABBWVPg9MiWrWLJhGKspsWZ2"]}' https://api.klaxon.veesion.io/hooks2{"message":"OK"}

Hook payload format:


Code Block
{

"store_veesion_id":"test-store-wildix",

"store_hook_id":"test-store-wildix@wildix",

"group_id":"5",

"store_id":"",

"start_date":"2022-09-27T17:48:50Z",

"end_date":"2022-09-27T17:49:57Z",

"camera_ip":"192.168.0.108",

"camera_id":"5",

"video_url":"https:\/\/veesion-alerts-global\/alert.mp4",

"alert_type":"theft"

}

...

  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 following applications:
      • Custom application: DumpChan(1) - 
      • Custom application: NoOp(store ID: ${storeId} camera ID: ${cameraId}) - detects store ID and camera ID
      • Play sound: Detected ${alertType} on ___??

...


      • Image Added


Variables available in Dialplan:

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

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

...