Jump to

• Request
• Response
• Examples

Set activity status

post

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

This operation is used by the agent to set the agent's activity status to available or unavailable.
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.
• CONFLICT - The agent status could not be changed.

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.ActivityStatusChangeRequest

Type: object

Show Source

• sequenceNumber(optional): integer(int64)
  The client application defined transaction sequence number.
• status: string
  Allowed Values: [ "NONE", "AVAILABLE", "UNAVAILABLE" ]

  The new agent status.
• subTypeId: integer(int32)
  The new agent status sub type.
• timeCreated(optional): integer(int64)
  The time the request was created in milliseconds.

{
    "required":[
        "status",
        "subTypeId"
    ],
    "properties":{
        "status":{
            "type":"string",
            "description":"The new agent status.",
            "enum":[
                "NONE",
                "AVAILABLE",
                "UNAVAILABLE"
            ]
        },
        "subTypeId":{
            "type":"integer",
            "format":"int32",
            "description":"The new agent status sub type."
        },
        "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.ActivityStatusChangeResponse

Type: object

Show Source

• chatActivityStatusChangeResult(optional): object com.rightnow.chat.rest.agent_api.model.responses.v1.results.ChatActivityStatusChangeResult
• chatSystemError(optional): object com.rightnow.chat.rest.agent_api.model.types.v1.ChatSystemError
• 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.
• 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":{
        "chatActivityStatusChangeResult":{
            "description":"The object containing the transaction results.",
            "$ref":"#/definitions/com.rightnow.chat.rest.agent_api.model.responses.v1.results.ChatActivityStatusChangeResult"
        },
        "chatSystemError":{
            "description":"The chat system error result object.",
            "$ref":"#/definitions/com.rightnow.chat.rest.agent_api.model.types.v1.ChatSystemError"
        },
        "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."
        }
    }
}

Nested Schema : com.rightnow.chat.rest.agent_api.model.responses.v1.results.ChatActivityStatusChangeResult

Type: object

Show Source

• status: string
  Allowed Values: [ "NONE", "AVAILABLE", "UNAVAILABLE" ]

  The assignment action
• subTypeId: integer(int32)
  The sub type identifier

{
    "required":[
        "status",
        "subTypeId"
    ],
    "properties":{
        "status":{
            "type":"string",
            "description":"The assignment action",
            "enum":[
                "NONE",
                "AVAILABLE",
                "UNAVAILABLE"
            ]
        },
        "subTypeId":{
            "type":"integer",
            "format":"int32",
            "description":"The sub type identifier"
        }
    }
}

Nested Schema : com.rightnow.chat.rest.agent_api.model.types.v1.ChatSystemError

Type: object

Show Source

• errorCondition(optional): string
  The error condition.
• text(optional): string
  The error text.
• type(optional): string
  The error type.

{
    "properties":{
        "errorCondition":{
            "type":"string",
            "description":"The error condition."
        },
        "text":{
            "type":"string",
            "description":"The error text."
        },
        "type":{
            "type":"string",
            "description":"The error type."
        }
    }
}

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 the agent's status.

cURL Command Example

curl -X POST https://chat_rest_server_domain.com/engagement/api/agent/day001_221100_sql_001h/v1/setActivityStatus?pool=297:1 -H 'Content-Type: application/json; charset=UTF-8' -H 'X-JSESSIONID: node01h8m13tljpm7ns8nayp0pid91' -d ' -H 'X-AID: 12' {"timeCreated" :1618317020415, "sequenceNumber" : 12, "status" : "AVAILABLE", "subTypeId": 25}'

Request Body Example

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

{
  "timeCreated" : 1618317020415,
  "sequenceNumber" : 12,
  "status" : "AVAILABLE",
  "subTypeId": 25
}

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.

{
  "chatActivityStatusChangeResult": {
    "status": "AVAILABLE",
    "subTypeId": 25
  },
  "chatSystemError": null,
  "clientSendTime": 1618302560000,
  "serviceStartTime": 1648665877936,
  "serviceFinishTime": 1648665879114,
  "sessionId": "node0e17vqd3nxmwrgp0o1tyij12g0",
  "clientId": 47,
  "clientIdString": "47",
  "sequenceNumber": 12,
  "sequenceNumberString": "12"
}

Back to Top