Jump to

• Request
• Response
• Examples

Set engagement property

post

/engagement/api/agent/{fqSiteName}/v1/setEngagementProperty

This operation sets a property on the engagement. The allowable properties to be set if the type is ENGAGEMENT are CONTACT_ID and INCIDENT_ID. The allowable properties to be set if the type is USER are FIRST_NAME, LAST_NAME, QUESTION, PRODUCT_ID and CATEGORY_ID.
The following is the list of exception codes that can be returned from this operation:

• ACCESS_DENIED - Authentication failed.
• UNKNOWN_EXCEPTION - An unknown error has occurred.
• BAD_REQUEST - A field in the request is invalid.
• INTERNAL_SERVER_ERROR - An error occurred within the core server.

Request

Supported Media Types

• application/json; charset=utf-8

Path Parameters

• fqSiteName: string
  The fully qualified site name.

Header Parameters

• X-AID: string
  A header element containing the agent account identifier.
• X-JSESSIONID: string
  A header element containing the unique session identifier returned in the create automated agent session call.

Body ()

The object containing the request information.

Root Schema : com.rightnow.chat.rest.agent_api.model.requests.v1.SetEngagementPropertyRequest

Type: object

Show Source

• engagementId: integer(int64)
  The unique identifier of the chat engagement.
• name: string
  Allowed Values: [ "FIRST_NAME", "LAST_NAME", "EMAIL", "QUESTION", "PRODUCT_ID", "CATEGORY_ID", "CONTACT_ID", "INCIDENT_ID" ]

  The property name.
• sequenceNumber(optional): integer(int64)
  The client application defined transaction sequence number.
• timeCreated(optional): integer(int64)
  The time the request was created in milliseconds.
• type: string
  Allowed Values: [ "USER", "ENGAGEMENT" ]

  The engagement property type.
• value: string
  The property value.

{
    "required":[
        "engagementId",
        "name",
        "type",
        "value"
    ],
    "properties":{
        "engagementId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of the chat engagement."
        },
        "type":{
            "type":"string",
            "description":"The engagement property type.",
            "enum":[
                "USER",
                "ENGAGEMENT"
            ]
        },
        "name":{
            "type":"string",
            "description":"The property name.",
            "enum":[
                "FIRST_NAME",
                "LAST_NAME",
                "EMAIL",
                "QUESTION",
                "PRODUCT_ID",
                "CATEGORY_ID",
                "CONTACT_ID",
                "INCIDENT_ID"
            ]
        },
        "value":{
            "type":"string",
            "description":"The property value."
        },
        "timeCreated":{
            "type":"integer",
            "format":"int64",
            "description":"The time the request was created in milliseconds."
        },
        "sequenceNumber":{
            "type":"integer",
            "format":"int64",
            "description":"The client application defined transaction sequence number."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json; charset=utf-8

200 Response

The request completed successfully.

Body ()

Root Schema : com.rightnow.chat.rest.agent_api.model.responses.v1.SetEngagementPropertyResponse

Type: object

Show Source

• clientId(optional): integer(int64)
  The unique identifier of the agent client, created to identify the agent during this agent session.
• clientIdString(optional): string
  The unique identifier of the agent client in string format, created to identify the agent during this agent session.
• clientSendTime(optional): integer(int64)
  The time when the client request was received in yyyy-MM-dd'T'HH:mm:ssXXX format.
• oldValue(optional): string
  The old value of the property that was changed.
• sequenceNumber(optional): integer(int64)
  The client application defined transaction sequence number.
• sequenceNumberString(optional): string
  The client application defined transaction sequence number as a string.
• serviceFinishTime(optional): integer(int64)
  The time when the chat server completed processing the client request in yyyy-MM-dd'T'HH:mm:ssXXX format.
• serviceStartTime(optional): integer(int64)
  The time when the chat server began processing the client request in yyyy-MM-dd'T'HH:mm:ssXXX format.
• sessionId(optional): string
  The unique identifier of the agent session.

{
    "properties":{
        "oldValue":{
            "type":"string",
            "description":"The old value of the property that was changed."
        },
        "clientSendTime":{
            "type":"integer",
            "format":"int64",
            "description":"The time when the client request was received in yyyy-MM-dd'T'HH:mm:ssXXX format."
        },
        "serviceStartTime":{
            "type":"integer",
            "format":"int64",
            "description":"The time when the chat server began processing the client request in yyyy-MM-dd'T'HH:mm:ssXXX format."
        },
        "serviceFinishTime":{
            "type":"integer",
            "format":"int64",
            "description":"The time when the chat server completed processing the client request in yyyy-MM-dd'T'HH:mm:ssXXX format."
        },
        "sessionId":{
            "type":"string",
            "description":"The unique identifier of the agent session."
        },
        "clientId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of the agent client, created to identify the agent during this agent session."
        },
        "clientIdString":{
            "type":"string",
            "description":"The unique identifier of the agent client in string format, created to identify the agent during this agent session."
        },
        "sequenceNumber":{
            "type":"integer",
            "format":"int64",
            "description":"The client application defined transaction sequence number."
        },
        "sequenceNumberString":{
            "type":"string",
            "description":"The client application defined transaction sequence number as a string."
        }
    }
}

400 Response

The validation of the request object failed.

Body ()

Root Schema : schema

Type: object

403 Response

The agent session identifier is unknown.

Body ()

Root Schema : schema

Type: object

404 Response

The resource was not found.

Body ()

Root Schema : schema

Type: object

500 Response

An error occurred in the chat server while processing the request.

Body ()

Root Schema : schema

Type: object

Back to Top

Examples

The following example shows how to set a property on an engagement.

cURL Command Example

curl -X POST https://chat_rest_server_domain.com/engagement/api/agent/day001_221100_sql_001h/v1/setEngagementProperty?pool=297:1 -H 'Content-Type: application/json; charset=UTF-8' -H 'X-JSESSIONID: node01h8m13tljpm7ns8nayp0pid91' -d ' -H 'X-AID: 12' {"timeCreated" :1618317020415, "sequenceNumber" : 13, "engagementId": 642, "type": "USER", "name": "PRODUCT_ID", "value": "30"}'

Request Body Example

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

{
  "engagementId": 642,
  "type": "USER",
  "name": "PRODUCT_ID",
  "value": "30",
  "timeCreated": 1618317020415,
  "sequenceNumber": 13
}

Response Header Example

The following shows an example of the response header.

Status: 200 OK
Content-Type: application/json;charset=utf-8

Response Body Example

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

{
  "serviceStartTime": 1643733912599,
  "serviceFinishTime": 1643733944620,
  "sessionId": "node01mlc65n8qocev1y1s3jm8gacps0",
  "clientId": 47,
  "clientIdString": "47",
  "sequenceNumber": 13,
  "sequenceNumberString": "13"
}

Back to Top