From Bright Pattern Documentation
< 5.8:Real-time-statistics-api
Revision as of 04:13, 29 May 2024 by BpDeeplTranslateMaintenance (talk | contribs) (Updated via BpDeleteTranslateTags script)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
• 5.19 • 5.3 • 5.8


Describe Global Interaction

Describes an interaction via GIID, providing metadata for all segments, parties, and related recording IDs. This method is useful for getting the data for a specific multi-channel audio recording.

URL

http[s]://<host>:<port>/admin/ws/t/<tenant_url>/recordings/describeGlobalInteraction?giid=<GIID>

HTTP Method

GET

Body

Description of interactions and parties.

Note: Duration is in seconds. startTime is in UTC.

Example

{“interactions”: [
	{“id”: “3891849308410948031948103294”, “partiesCount”: 2, “duration”: 3435, “startTime”: “2018/07/12 15:45”, “parties”: [{“type”: “trunk”, “number”: “14155551212”},{“type”: “extension”, “number”: “1415”},{“type”: “extension”, “number”: “1416”}]},
	{“id”: “38918493084109480319481032A4”, “partiesCount”: 3,  “duration”: 343,  “startTime”: “2018/07/12 15:46”, “parties”: [{“type”: “trunk”, “number”: “14155551212”},{“type”: “extension”, “number”: “1415”},{“type”: “extension”, “number”: “1416”},{“type”: “trunk”, “number”: “14156661212”}]},
	{“id”: “38918493084109480319481032B4”, “partiesCount”: 4,  “duration”: 34,  “startTime”: “2018/07/12 15:47”, “parties”: [{“type”: “trunk”, “number”: “14155551212”},{“type”: “extension”, “number”: “1415”},{“type”: “extension”, “number”: “1416”},{“type”: “trunk”, “number”: “14156661212”},{“type”: “extension”, “number”: “1418”}]]}
]
}

Response

Code Description
200 Success
401 Authentication failed
403 User authenticated but does not have sufficient privileges
404 File not found