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

预览外呼

前置条件

  • 座席已签入
  • 座席当前无正在接听的呼叫(不包括保持后的呼叫)
  • 座席收到预览外呼事件

场景描述

座席收到预览外呼事件以后通过预览外呼接口呼叫外呼用户。

接口方法

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

接口URI

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

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

表1 URI中携带的参数说明

序号

参数名

数据类型

选取原则

说明

1

agentid

string

True

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

日志中的方法名

previewCallout

请求说明

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

    序号

    名称

    参数类型

    是否必选

    说明

    1

    Content-Type

    string

    True

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

    2

    Guid

    string

    True

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

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

    序号

    名称

    参数类型

    是否必选

    说明

    1

    called

    string

    True

    被叫号码。called必须包含在预览事件的dialeddigits字段中,不在此字段中的号码,不能呼叫。

    2

    callcontrolid

    long

    True

    预呼控制块号。callcontrolid是预览外呼事件中的controllid。

响应说明

表4 消息体参数说明

序号

名称

参数类型

说明

1

message

string

描述

2

retcode

string

错误码。取值如下:

0:成功

非0:失败

3

result

string

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

呼叫失败不返回该项。

触发事件

  • 物理话机振铃(AgentOther_PhoneAlerting)
  • 物理话机摘机(AgentOther_PhoneOffhook)
  • 座席进入Talking(AgentEvent_Talking)
  • 外呼失败(AgentEvent_Call_Out_Fail)

错误结果码

  • 000-002
  • 100-006
  • 100-007
  • 200-001
  • 200-036

报文样例

  • 消息头
    Content-Type:application/json; charset=UTF-8
    Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
  • 请求参数
    {
        "called": "88889039",
        "callcontrolid": "11776"
    }
  • 响应参数
    {
        "message": "",
        "retcode": "0",
        "result": "1455885056-1095"
    }