文档首页/ 云客服/ API参考/ 座席工作台/ 座席控制/ 座席操作类接口:onlineagent/ 发送便签接口
更新时间：2023-09-27 GMT+08:00
查看PDF
分享

发送便签接口

前置条件

  • 座席已签入。

场景描述

座席之间发送便签。

接口方法

设置成“POST”。该接口仅支持POST方法，不支持PUT、GET和DELETE等方法。

接口URI

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

其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。

表1 URI中携带的参数说明

序号

参数名

数据类型

选取原则

说明

1

agentid

string

True

座席的工号，取值范围：101～59999。

日志中的方法名

sendNoteletEx

请求说明

  • 消息头
    表2 请求头参数说明

    序号

    名称

    参数类型

    是否必选

    说明

    1

    Content-Type

    string

    True

    消息主体编码方式，缺省值：application/json; charset=UTF-8

    2

    Guid

    string

    True

    静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。
  • 消息体
    表3 消息体参数说明

    序号

    名称

    参数类型

    是否必选

    说明

    1

    agentIds

    int

    True

    接收便签消息座席工号。

    最大可以传100个座席工号。

    2

    content

    string

    True

    便签内容。

    大小为0~1023个字节，内容可为空，支持中文内容。

响应说明

表4 消息体参数说明

序号

名称

参数类型

说明

1

message

string

描述

2

retcode

string

错误码。取值如下：

0：成功

非0：失败

3

result

Map

查询成功后，返回结果信息的对象。

触发事件

如果接收便签座席签入时，触发如下事件

  • 接收便签（AgentOther_Note）

错误结果码

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

报文样例

  • 消息头 
    Content-Type:application/json; charset=UTF-8
Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
  • 请求参数 
    {
    "agentIds": [
        31002,
        31003
    ],
    "content": "hello"
}
  • 响应参数 
    {
    "result": null,
    "message": "success",
    "retcode": "0"
}