文档首页/ 云客服/ API参考/ 座席工作台/ 座席控制/ 座席操作类接口:onlineagent/ 座席页面刷新时同步座席状态status和通话信息
更新时间:2024-09-24 GMT+08:00
分享

座席页面刷新时同步座席状态status和通话信息

该接口仅限在浏览器刷新后状态同步使用,调用此接口会清理事件队列。

前置条件

  • 座席已签入

场景描述

座席页面刷新时同步座席状态status和通话信息。

接口方法

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

接口URI

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

其中,ip为agentgateway服务器地址,port为agentgateway服务器的HTTPS端口号。

表1 URI中携带的参数说明

序号

参数名

数据类型

选取原则

说明

1

agentid

string

True

座席的工号,取值范围:101~59999。

日志中的方法名

syncagentinfo

请求说明

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

    序号

    名称

    参数类型

    是否必选

    说明

    1

    Content-Type

    string

    True

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

    2

    Guid

    string

    True

    静态鉴权(AUTHMODE = 1)签入接口返回的Guid;动态鉴权(AUTHMODE = 2)轮询事件接口返回的Guid。

  • 消息体

响应说明

表3 消息体参数说明

序号

名称

参数类型

说明

1

message

string

描述

2

retcode

string

错误码。取值如下:

0:成功

非0:失败

3

result

object

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

该对象的参数说明请参见表4

表4 result对象参数说明

序号

名称

参数类型

说明

3.1

callinfo

string

通话信息。

3.2

agentStateInfo

object

座席状态信息,该对象的参数说明请参见表5

表5 agentStateInfo对象参数说明

序号

名称

参数类型

说明

3.2.1

callFeature

int

呼叫原始类型。特征ID,详细见表6

3.2.2

callData

string

呼叫相关信息。

3.2.3

lastState

int

座席最后的状态。

3.2.4

preBusy

boolean

是否示忙。

3.2.5

firsttalkingFlag

boolean

是否第一次通话。

3.2.6

workNo

string

座席工号。

3.2.7

qcWorkNo

string

qc座席工号。

3.2.8

callerNo

string

主叫号码。

3.2.9

beginHoldTime

string

开始保持时间,时间戳,单位:ms。

3.2.10

state

int

座席状态。

详细状态码和含义请参见表3

3.2.11

talkingCallfeature

int

通话呼叫原始类型,详细见表6

3.2.12

releaseFlag

int

会话是否释放。

暂未使用。

3.2.13

calledNo

string

被叫号码。

3.2.14

mainCallId

string

首次发起呼叫的callid。

3.2.15

secondTalkingTime

string

第二次通话时间,时间戳,单位:ms。

3.2.16

preRest

boolean

是否休息。

3.2.17

recordID

string

录音流水号。

3.2.18

currentTime

string

当前时间,时间戳,单位:ms。

3.2.19

beginTalkingTime

string

开始通话时间,时间戳,单位:ms。

3.2.20

partner

string

合作伙伴。

3.2.21

holdCallId

string

保持的呼叫callid

3.2.22

agentStateBeginTime

string

座席状态开始时间,时间戳,单位:ms。

3.2.23

curCommand

int

当前命令,详细含义见表7

3.2.24

curCallId

string

当前的呼叫callid。

3.2.25

cmdBeginTime

string

命令开始时间,时间戳,单位:ms。

表6 呼叫类型信息

状态值

说明

-1

其他。

0

普通呼入。

6

内部呼叫。

7

普通呼叫。

41

HPS预占式外呼。

44

HPS预测式外呼。

45

HPS预约回呼。

51

内部两方咨询。

52

内部三方咨询。

53

多方通话

表7 操作命令信息

状态值

说明

0

无命令。

1

座席挂机。

2

座席断开连接。

3

用户挂机。

4

首次外呼。

5

外呼。

6

保持。

7

取消保持。

8

静音。

9

取消静音。

10

释放转。

11

成功转。

12

通话转。

13

三方转。

14

挂起转。

15

特殊转。

16

两方求助。

17

三方求助。

18

三方通话。

19

放音。

20

插入。

21

侦听。

22

切换。

23

拦截。

24

耳语。

30

示忙。

31

休息。

触发事件

错误结果码

  • 100-007
  • 100-011

报文样例

  • 消息头
    Content-Type:application/json; charset=UTF-8
    Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
  • 请求参数

  • 响应参数
    {
        "result": {
            "callinfo": null,
            "agentStateInfo": {
                "callFeature": 0,
                "callData": "",
                "lastState": 255,
                "preBusy": false,
                "firsttalkingFlag": false,
                "workNo": "41001",
                "qcWorkNo": "",
                "callerNo": "",
                "beginHoldTime": null,
                "state": 1,
                "talkingCallfeature": 0,
                "releaseFlag": 0,
                "calledNo": "",
                "mainCallId": "",
                "secondTalkingTime": null,
                "preRest": false,
                "recordID": "",
                "currentTime": "1566636307992",
                "beginTalkingTime": null,
                "partner": "",
                "holdCallId": "",
                "agentStateBeginTime": 1566636286408,
                "curCommand": 0,
                "curCallId": "",
                "cmdBeginTime": ""
            }
        },
        "message": "success",
        "retcode": "0"
    }

相关文档