XOMNI: Experience Omni-Channel

Last Updated: April 14, 2016

This API allows a client application to fetch PII User OmniTicket’s on specified OmniPlay logical device queue.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/omniplay/logicaldevices/{logicalDeviceId}/incoming

URI Parameters

Parameter Name Description Type Conditions
logicalDeviceId Id of the device String

Request Headers

Header Field Name Description
Accept
Includes minor version header.
Sample: application/vnd.xomni.api-v4-0, */*
Authorization
Access or identity token taken from oauth APIs.
Sample: Bearer dc8f1dcdbe454da8a25621839a93569337522968019e4bd7becd6e01285444da

Response

{
	"Data": [{
		"OmniToken": "Pbda570b0-cf86-4c86-830c-ac9445faf208",
		"PIIDisplayName": "Gokhan Gulbiz",
		
	},
	{
		"OmniToken": "Pbda570b0-cf86-4c86-830c-ac9445faf208",
		"PIIDisplayName": "Gokhan Gulbiz",
		
	}]
}

Response Body Description

Parameter Name Description Type
Data[0..N].OmniToken OmniToken for the PIIUser. String
Data[0..N].PIIDisplayName Display name of the PIIUser. String

Response Headers

Header Field Name Description
Content-Type
Content type of the response entity. The value of this header is always application/json.

Status Codes

A successful operation returns status code 200 (OK) for GET operations. Possible response status codes are as listed below:

Status Code Description
404 (Not Found) Device not found
404 (Not Found) Device Queue is empty