更新时间:2023-09-27 GMT+08:00

内部求助

前置条件

  • 座席已签入

场景描述

座席登录以后通进行内部求助操作。

接口方法

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

接口URI

https://ip:port/agentgateway/resource/voicecall/{agentid}/innerhelp

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

表1 URI中携带的参数说明

序号

参数名

数据类型

选取原则

说明

1

agentid

string

True

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

日志中的方法名

innerHelp

请求说明

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

    序号

    名称

    参数类型

    是否必选

    说明

    1

    Content-Type

    string

    True

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

    2

    Guid

    string

    True

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

  • 消息体
    表3 消息体参数说明

    序号

    名称

    参数类型

    是否必选

    说明

    1

    dstaddress

    string

    True

    求助对象,座席工号或技能队列ID

    2

    devicetype

    int

    False

    求助设备类型,技能队列为1,座席为2,默认为2。

    3

    mode

    int

    False

    求助模式,两方求助为1,三方求助为2,默认为1。

    4

    callappdata

    string

    False

    需设置的随路数据。内容可为空,最大长度为16k。

    5

    holdflag

    boolean

    False

    三方转时是否保持呼叫,取值为false时不保持,true为保持,默认为true

响应说明

表4 消息体参数说明

序号

名称

参数类型

说明

1

message

string

描述

2

retcode

string

错误码。取值如下:

0:成功

非0:失败

3

result

string

求助成功后,返回呼叫唯一标识callid。

求助失败不返回该项。

触发事件

  • 两方求助
    • 呼叫保持(AgentEvent_Hold)
    • 对方振铃(AgentEvent_Customer_Alerting)
    • 座席进入Talking(AgentEvent_Talking)
  • 三方通话
    • 对方振铃(AgentEvent_Customer_Alerting)
    • 三方通话成功(AgentEvent_Conference)
  • 内部求助失败
    • 咨询失败(AgentEvent_Consult_Fail)

错误结果码

  • 100-006
  • 100-007
  • 200-018

报文样例

  • 消息头
    Content-Type:application/json; charset=UTF-8
    Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
  • 请求参数
    {
        "dstaddress": 49997,
        "devicetype": 2,
        "mode": 1,
        "callappdata": "",
        "holdflag": "true"
    }
  • 响应参数
    {
        "message": "",
        "retcode": "0",
        "result": "1455885056-1095"
    }