Jump to

• Request
• Response
• Examples

Respond contact

post

/srt/api/v1/contactDeflection/response

Process a RespondContact Mode Request

To enable accurate analytics, billing, pagination, and navigation for Search API requests, make sure that you specify the knowledge interaction ID parameter in the kmauthtoken header.

Note: If you are using Oracle B2C Service Knowledge Advanced, you must pass the interfaceId parameter in the kmauthtoken header.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• deflectedFlag: boolean
  Whether the quetion was deflected
• priorTransactionId: integer
  This ID relates to the current result set. This includes the displayed results plus any result up to the max number of results, as defined in the search configuration. If the request is for pagination or navigation, it applies pagination or navigation only to the current result set and doesn't retrieve new results.

Body ()

The session object which stores the content of a session.

Root Schema : SearchSession

Type: object

Title: SearchSession

Show Source

• baseURL(optional): string
  Base URL
• ccaInfo(optional): object CCAInfo
  Title: CCAInfo
• clientInfo(optional): object ClientInfo
  Title: ClientInfo
• domainGroup(optional): string
  The domain group to use for this request
• facetPriorTransactionId(optional): integer
  The ID that is set from the transactionId of a previous transaction to retain the facets. You can set the value of this ID to the transactionId of a previous transaction in the same session to retain the facets selected in a previous transaction. You must either set the value of the startOverFlag to false or omit the flag. Omitting the flag defaults its value to false. You can use the transactionIds from the most recent transaction or five previous transactions in the history to set facetPriorTransactionId of the current transaction. Note that the facetPriorTransactionId applies only to the /question endpoint.
• isDeflection(optional): boolean
  Is this request an attempt to deflect
• locale(optional): string
  locale of the request
• navigationApplicationId(optional): string
  The name of the taxonomy to use for this request
• pageSize(optional): integer
  The maximum number of search results to be displayed in the results page. If a value is not specified by the client, then the default value is used.
• querySource(optional): string
  The query source for this request
• requestSource(optional): string
  Request Source
• resultLocales(optional): string
  A comma separted list of the desired resulting locales
• segment(optional): string
  The analytics segment to associate with this request
• session(optional): string
  Session Node
• subject(optional): string
  The subject/vertical to use for this request
• transactionId(optional): integer
  TransactionId
• uiMode(optional): string
  The UI mode for this request

{
    "title":"SearchSession",
    "properties":{
        "session":{
            "type":"string",
            "description":"Session Node"
        },
        "transactionId":{
            "type":"integer",
            "description":"TransactionId"
        },
        "facetPriorTransactionId":{
            "type":"integer",
            "description":"The ID that is set from the transactionId of a previous transaction to retain the facets. You can set the value of this ID to the transactionId of a previous transaction in the same session to retain the facets selected in a previous transaction. You must either set the value of the startOverFlag to false or omit the flag. Omitting the flag defaults its value to false. You can use the transactionIds from the most recent transaction or five previous transactions in the history to set facetPriorTransactionId of the current transaction. Note that the facetPriorTransactionId applies only to the /question endpoint."
        },
        "baseURL":{
            "type":"string",
            "description":"Base URL"
        },
        "locale":{
            "type":"string",
            "description":"locale of the request"
        },
        "resultLocales":{
            "type":"string",
            "description":"A comma separted list of the desired resulting locales"
        },
        "domainGroup":{
            "type":"string",
            "description":"The domain group to use for this request"
        },
        "navigationApplicationId":{
            "type":"string",
            "description":"The name of the taxonomy to use for this request"
        },
        "segment":{
            "type":"string",
            "description":"The analytics segment to associate with this request"
        },
        "querySource":{
            "type":"string",
            "description":"The query source for this request"
        },
        "uiMode":{
            "type":"string",
            "description":"The UI mode for this request"
        },
        "requestSource":{
            "type":"string",
            "description":"Request Source"
        },
        "subject":{
            "type":"string",
            "description":"The subject/vertical to use for this request"
        },
        "isDeflection":{
            "type":"boolean",
            "description":"Is this request an attempt to deflect"
        },
        "clientInfo":{
            "$ref":"#/definitions/ClientInfo",
            "description":"Information about the client for this request"
        },
        "ccaInfo":{
            "$ref":"#/definitions/CCAInfo",
            "description":"CCA Information for this request"
        },
        "pageSize":{
            "type":"integer",
            "description":"The maximum number of search results to be displayed in the results page. If a value is not specified by the client, then the default value is used."
        }
    }
}

Nested Schema : CCAInfo

Type: object

Title: CCAInfo

Show Source

• answerSolutionList(optional): string
  Answer Solution List
• caseDescription(optional): string
  Case Description
• connected(optional): boolean
  Connected
• contentIds(optional): string
  ContentIds
• extSolutionList(optional): string
  External Solution List
• name(optional): string
  Name
• SRKey(optional): string
  SRKey
• system(optional): string
  System
• types(optional): string
  Types

{
    "title":"CCAInfo",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name"
        },
        "connected":{
            "type":"boolean",
            "description":"Connected"
        },
        "caseDescription":{
            "type":"string",
            "description":"Case Description"
        },
        "extSolutionList":{
            "type":"string",
            "description":"External Solution List"
        },
        "SRKey":{
            "type":"string",
            "description":"SRKey"
        },
        "system":{
            "type":"string",
            "description":"System"
        },
        "contentIds":{
            "type":"string",
            "description":"ContentIds"
        },
        "answerSolutionList":{
            "type":"string",
            "description":"Answer Solution List"
        },
        "types":{
            "type":"string",
            "description":"Types"
        }
    }
}

Nested Schema : ClientInfo

Type: object

Title: ClientInfo

Show Source

• address(optional): string
  Address
• agentAddress(optional): string
  Agent Address
• cookies(optional): string
  Cookies
• extSessionId(optional): string
  External Session Id
• host(optional): string
  Host
• referrer(optional): string
  Referrer URL
• requestAttributes(optional): array requestAttributes
  list of Map Entries
• requestHeaders(optional): array requestHeaders
  list of Map Entries
• requestParameters(optional): array requestParameters
  list of Map Entries

{
    "title":"ClientInfo",
    "properties":{
        "agentAddress":{
            "type":"string",
            "description":"Agent Address"
        },
        "extSessionId":{
            "type":"string",
            "description":"External Session Id"
        },
        "referrer":{
            "type":"string",
            "description":"Referrer URL"
        },
        "cookies":{
            "type":"string",
            "description":"Cookies"
        },
        "address":{
            "type":"string",
            "description":"Address"
        },
        "host":{
            "type":"string",
            "description":"Host"
        },
        "requestHeaders":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/MapEntry"
            },
            "description":"list of Map Entries"
        },
        "requestParameters":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/MapEntry"
            },
            "description":"list of Map Entries"
        },
        "requestAttributes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/MapEntry"
            },
            "description":"list of Map Entries"
        }
    }
}

Nested Schema : requestAttributes

Type: array

list of Map Entries

Show Source

• Array of: object MapEntry
  Title: MapEntry

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/MapEntry"
    },
    "description":"list of Map Entries"
}

Nested Schema : requestHeaders

Type: array

list of Map Entries

Show Source

• Array of: object MapEntry
  Title: MapEntry

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/MapEntry"
    },
    "description":"list of Map Entries"
}

Nested Schema : requestParameters

Type: array

list of Map Entries

Show Source

• Array of: object MapEntry
  Title: MapEntry

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/MapEntry"
    },
    "description":"list of Map Entries"
}

Nested Schema : MapEntry

Type: object

Title: MapEntry

Show Source

• key(optional): string
  Key Name
• value(optional): string
  Value

{
    "title":"MapEntry",
    "properties":{
        "key":{
            "type":"string",
            "description":"Key Name"
        },
        "value":{
            "type":"string",
            "description":"Value"
        }
    }
}

Back to Top

Response

204 Response

No Content.

Back to Top

Examples

The following example shows how to create a respond contact by submitting a post request on the REST resource using cURL.

cURL Command

curl -X "POST" "http://<SEARCH_REST_API_HOST>/srt/api/contactDeflection/response"

Example of Request Header

The following shows an example of the request header.

-H "kmauthtoken: {\"siteName\":\"ORACLE_KNOWLEDGE\",\"interfaceId\":\"1\",\"interactionIdGenerated\":\"true\",\"knowledgeInteractionId\":\"Z9X3D85Ka8C\",\"integrationUserToken\":\"\"+eCJYkxKwj5HUaIiJYun0/TpatwT1LmtcsF05W33xnEojifV/AsLDj9RpN0lKuorTMNKeSE1tgC7svVL+BzntqDON4KiM1HFlpxvXEUCB0P2w0Xrs75McygqxdVaDSE9"}" \
-H "Accept: application/json"

Example of Request Body

The following shows an example of the request body in JSON format.

{
  "session" : "SESSION_VALUE",
  "transactionId" : -470886747,
  "facetPriorTransactionId" : 0,
  "baseURL" : "BASEURL_VALUE",
  "locale" : "LOCALE_VALUE",
  "resultLocales" : "RESULTLOCALES_VALUE",
  "domainGroup" : "DOMAINGROUP_VALUE",
  "navigationApplicationId" : "NAVIGATIONAPPLICATIONID_VALUE",
  "segment" : "SEGMENT_VALUE",
  "querySource" : "QUERYSOURCE_VALUE",
  "uiMode" : "UIMODE_VALUE",
  "requestSource" : "REQUESTSOURCE_VALUE",
  "subject" : "SUBJECT_VALUE",
  "isDeflection" : true,
  "clientInfo" : {
    "agentAddress" : "AGENTADDRESS_VALUE",
    "extSessionId" : "EXTSESSIONID_VALUE",
    "referrer" : "REFERRER_VALUE",
    "cookies" : "COOKIES_VALUE",
    "address" : "ADDRESS_VALUE",
    "host" : "HOST_VALUE",
    "requestHeaders" : [ {
      "key" : "KEY_VALUE",
      "value" : "VALUE_VALUE"
    } ],
    "requestParameters" : [ {
      "key" : "KEY_VALUE",
      "value" : "VALUE_VALUE"
    } ],
    "requestAttributes" : [ {
      "key" : "KEY_VALUE",
      "value" : "VALUE_VALUE"
    } ]
  }
}

Back to Top