XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

Social policy API provide most restricted max content length, shortened URL length etc... information in order to help client applciation to prepare and validate social post before sending to XOMNI. API aggregates platform limititations and provides most restricted values to client applications.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/social/comment/policies?targetPostId={targetPostId}&targetCommentId={targetCommentId}

URI Parameters

Parameter Name Description Type Conditions
targetPostId The unique ID for the social XOMNI post which the current comment replies to and belongs to. Number
targetCommentId The unique ID for the social XOMNI comment which the current comment replies to. Number

Request Headers

Header Field Name Description
Content-Type
Content type of the response entity. The value of this header is always application/json.
PIIToken
Includes the base64-encoded “Personally Identifiable Information” data.
Sample: dXNlcm5hbWU6SW5uQXBwc1VzZXI7cGFzc3dvcmQ6SW5uQXBwc1Bhc3M=
Authorization
Access or identity token taken from oauth APIs.
Sample: Bearer dc8f1dcdbe454da8a25621839a93569337522968019e4bd7becd6e01285444da
Accept
Includes minor version header.
Sample: application/vnd.xomni.api-v4-1, */*

Response

{
  "Data": {
    "MaxContentLength": 112,
    "ShortenedUrlLength": 23,
    "RepliedToTwitterAlias": "xomni_cloud"
  }
}

Response Body Description

Parameter Name Description Type
Data.MaxContentLength Max content length for related social operation. Number
Data.ShortenedUrlLength Shortened URL length. If content contains a link inside, it will be shortened to provided URL length. Number
Data.RepliedToTwitterAlias Twitter alias of the user whose tweet is replied. 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
400 (Bad Request) targetPostId or targetCommentId parameter should be provided.
404 (Not Found) No suitable platforms found for this operation.
404 (Not Found) Social post not found.
404 (Not Found) Social comment not found.