API - Offers

Description

These APIs are used to get the offers from the started Interact Runtime session.

Get Offers

This API call gets offers from the started Interact session.

GET/interact/v2/offers/{sessionID}/{interationPointID}?number={numberRequested}

Parameters

Parameters	Description
sessionID	Interact Runtime Session ID
interactionPointID	Interaction Point ID
number	Number of offers requested

Example Result

Content-Type: application/json

{
  "messages": null,
  "offerLists": [
    {
      "defaultString": "string",
      "ip": "string",
      "offers": [
        {
          "attributes": [
            {
              "n": "string",
              "t": "string",
              "v": "string"
            }],
          "code": [
            "string"
          ],
          "desc": "string",
          "n": "string",
          "score": 0,
          "treatmentCode": "string"
        }] }],
  "sessionId": "string",
  "statusCode": 0,
  "version": "string"
}

Get Offers for Multiple IPs

This API call gets offers for multiple interaction points.

POST/interact/v2/offers/{sessionId}

Body Parameter

This is used to provide the get offers for multiple IP command details.

Parameters

Parameter	Description
sessionID	Interact Runtime Session ID.

Content-Type: application/json

{
  "messages": [],
  "offerLists": [
    {
      "defaultString": "string",
      "ip": "string",
      "offers": [
        {
          "attributes": [
            {
              "n": "string",
              "t": "string",
              "v": {}
            }
          ],
          "code": [
            "string"
          ],
          "desc": "string",
          "n": "string",
          "score": 0,
          "treatmentCode": "string"
        }
      ]
    }
  ],
  "sessionId": "string",
  "statusCode": 0,
  "version": "string"
}

Example Result

Content-Type: application/json

{
  "messages": [],
  "offerLists": [
    {
      "defaultString": "string",
      "ip": "string",
      "offers": [
        {
          "attributes": [
            {
              "n": "string",
              "t": "string",
              "v": {}
            }
          ],
          "code": [
            "string"
          ],
          "desc": "string",
          "n": "string",
          "score": 0,
          "treatmentCode": "string"
        }
      ]
    }
  ],
  "sessionId": "string",
  "statusCode": 0,
  "version": "string"
}