Dokumentation

Userstates/Snapshot API

Mithilfe der Userstates/Snapshot API ist es möglich den Status der einzelnen Nutzer abzufragen. Diese können sein: Bereit (ready), im Telefonat (in_call) oder in Nachbearbeitung (wrap_up).

POSTtevox_api_url + /user-states/snapshot

Request

{
   "accessKey": "xxxx-xxxx-xxxx-xxxx-xxxxxxxxxx"
}

 

Responses

Response bei erfolgreicher Anfrage:

{
   "success": true,
   "user_states": [
      {
         "user": "michael2@test.com",
         "states": {
            "ready": {
               "value": "NOT_READY",
               "ts": "1643998017197_0000000000_d29b667b6cc6bf1e746845b8bad86a5b26148b5f3a6075738dbda864a18f96ad"
            },
            "in_call": {
               "value": "NOT_IN_CALL",
               "ts": "1643998017210_0000000000_75434915172af89b392fbed918f20554600e3d565adb4b4cd1397b20fcb7297a"
            },
            "wrap_up": {
               "value": "{from=1,to=1}",
               "ts": "1643998017213_0000000000_77b8406f16da083187e792d4b32f87206ead7f3fce9095e681f34bf620e44238"
            }
         }
      },
      {
         "user": "michael@test.com",
         "states": {
            "ready": {
               "value": "READY",
               "ts": "1642771485759_0000000001_9faed22b74c48e1dcf77718cd25c3044a5b305b5f316aac3cc4af5a61053b987"
            },
            "in_call": {
               "value": "IN_CALL",
               "ts": "1642771485779_0000000001_9faed22b74c48e1dcf77718cd25c3044a5b305b5f316aac3cc4af5a61053b987"
            },
            "wrap_up": {
               "value": "{from=1642696809682,to=1642697267192}",
               "ts": "1642771485769_0000000001_9faed22b74c48e1dcf77718cd25c3044a5b305b5f316aac3cc4af5a61053b987"
            }
         }
      }
   ]
}

 

Response bei nicht-erfolgreicher Anfrage:

{
   "success": false,
   "user_states": null
}