Help Center/ Cognitive Engagement Center/ API Reference/ Agent Workbench Interface Reference/ Agent Control/ Agent Operation Interfaces: onlineagent/ Sending Notes
Updated on 2023-09-27 GMT+08:00
View PDF
Share

Sending Notes

Prerequisites

  • The agent has signed in.

Description

This interface is used to send notes between agents.

Interface Method

The request method must be set to POST. This interface supports only the POST method.

URI

https://ip:port/agentgateway/resource/onlineagent/{agentid}/sendnoteletex

In the URL, ip indicates the IP address of the CC-Gateway server, and port indicates the HTTPS port number of the CC-Gateway server.

Table 1 Parameter in the URI

No.

Parameter

Data Type

Mandatory (Yes/No)

Description

1

agentid

string

Yes

Agent ID. The value ranges from 101 to 59999.

Method Name in Logs

sendNoteletEx

Request Description

  • Message header
    Table 2 Parameters in the request message header

    No.

    Parameter

    Value Type

    Mandatory (Yes/No)

    Description

    1

    Content-Type

    string

    Yes

    Coding mode of the message body. The default value is application/json; charset=UTF-8.

    2

    Guid

    string

    Yes

    GUID returned by the sign-in interface during static authentication (AUTHMODE is set to 1) or GUID returned by the polling event query interface during dynamic authentication (AUTHMODE is set to 2).
  • Message body
    Table 3 Parameters in the message body

    No.

    Parameter

    Value Type

    Mandatory (Yes/No)

    Description

    1

    agentIds

    int

    Yes

    ID of the agent who receives the note.

    A maximum of 100 agent IDs can be transferred.

    2

    content

    string

    Yes

    Indicates the note content.

    The value contains 0 to 1023 bytes and supports Chinese characters.

Response Description

Table 4 Parameters in the message body

No.

Parameter

Value Type

Description

1

message

string

Description.

2

retcode

string

Error code. The options are as follows:

0: success

Other values: failure

3

result

Map

Object in the returned result after a successful query.

Triggered Event

If the agent who receives the note signs in, the following event is triggered:

  • AgentOther_Note

Error Code

  • 100-001
  • 100-006
  • 100-007

Example

  • Message header 
    Content-Type:application/json; charset=UTF-8
Guid: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
  • Request parameter 
    {
    "agentIds": [
        31002,
        31003
    ],
    "content": "hello"
}
  • Response parameter 
    {
    "result": null,
    "message": "success",
    "retcode": "0"
}