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

普通外呼

前置条件

  • 座席已签入
  • 座席当前无正在接听的呼叫(不包括保持后的呼叫)

场景描述

座席登录以后通过外呼接口呼叫外呼用户。

接口方法

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

接口URI

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

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

表1 URI中携带的参数说明

序号

参数名

数据类型

选取原则

说明

1

agentid

string

True

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

日志中的方法名

callout

请求说明

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

    序号

    名称

    参数类型

    是否必选

    说明

    1

    Content-Type

    string

    True

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

    2

    Guid

    string

    True

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

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

    序号

    名称

    参数类型

    是否必选

    说明

    1

    caller

    string

    False

    主叫号码。内容可为空,为空时为平台默认主叫号码,0-24位数字

    2

    called

    string

    True

    被叫号码。内容不可为空,1-24位数字或*或#

    3

    skillid

    int

    False

    技能ID。数字类型,内容可为空,为空时为平台配置默认的技能队列ID。

    4

    callappdata

    string

    False

    随路数据信息。可为空,最大长度为16k。

    5

    mediaability

    int

    False

    媒体能力,默认为0。0:音频,1:视频,2:以最大能力呼叫,由主机与终端进行协商。

    说明:

    视频呼音频,接听后会导致通话直接挂断,原因是媒体协商失败,推荐视频外呼时,mediaability配置为2,以最大能力呼叫。

响应说明

表4 消息体参数说明

序号

名称

参数类型

说明

1

message

string

描述

2

retcode

string

错误码。取值如下:

0:成功

非0:失败

3

result

string

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

呼叫失败不返回该项。

触发事件

  • 物理话机振铃(AgentOther_PhoneAlerting)
  • 物理话机摘机(AgentOther_PhoneOffhook)
  • 座席忙中(AgentState_Busy)
  • 对方振铃(AgentEvent_Customer_Alerting)
  • 座席进入Talking(AgentEvent_Talking)
  • 外呼失败(AgentEvent_Call_Out_Fail)
  • 外呼失败检测失败原因事件(OUTBOUND_DETECT_EVENT)

错误结果码

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

报文样例

  • 消息头
    Content-Type:application/json; charset=UTF-8
    Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
  • 请求参数
    {
        "caller": "40038",
        "called": "40040",
        "skillid": 25,
        "callappdata": "",
        "mediaability": 1
    }
  • 响应参数
    {
        "message": "",
        "retcode": "0",
        "result": "1455885056-1095"
    }