CCPaaS后端API V2.0

公共信息

通用规范

请求格式

Base URL

https://{host}/{Type}/{version}/{api}?Timestamp={Timestamp}&AppId={AppId}

HTTP Header

HTTP METHOD

HTTP Status Code

返回格式

通用

正确返回格式

{
  "ErrCode": "000000", // 响应码(必须)
  "ErrDesc": "OK",   // 响应描述(必须)
  "Result": {
    // 数据...
  }
}

错误返回格式

{
  "ErrCode": "000001",     // 响应码(必须)
  "ErrDesc": "参数错误", // 响应描述(必须)
  "Result": {
    // 数据...
  }
}

数据格式约定

PSTN号码

示例

"01067654637" # 座机号
"13676546374" # 手机号

分机号码(Extension)

示例

"8001"      # 分机号码

队列ID(QueueId)

坐席ID(AgentId)

坐席工号(WorkId)

时间戳(Timestamp)

鉴权方式

服务端接口鉴权

示例

https://xxx.udesk.cn/ccapi/v2/agents?Timestamp=1519468251&AppId=6f142ddb-47ed-442e-83e7-6d2574d77aa2&Sid=1234567890&Sign=9416b06a42d56dc3be412fa084e787dba52a2769

返回码说明

返回码 说明
000000 成功
000001 参数无效
000035 请求超时
000036 错误的请求
000060 内部错误
100001 参数为空
100002 app无效或禁止
100003 找不到账号
100004 错误的消息
100005 找不到中继号
100006 名称已经存在
100007 找不到语音
100008 无效的wav文件
100009 wav文件转换失败
100010 创建默认的声音文件失败
100011 新存储桶失败
100012 下载文件失败
100013 数据库初始失败
100014 md5校验失败
100015 号码存在
100016 语音绑定代理
100017 应用ID为空
100018 未发现记录
100019 解析失败
100020 找不到ivr
100021 无效的坐席状态
100022 所有权错误
200001 不存在此app
200002 参数错误
200003 服务解析出错
200004 没有找到相关记录
200005 开始结点错误
200006 条件结点错误
200007 播放节点错误
200008 语音收集结点错误
200009 入队结点错误
200010 webhook结点错误
200011 收号结点错误
200018 挂断节点错误
200019 已存在此名字
200020 鉴权出错
200021 内部服务错误
200022 路由格式错误
200023 数据库错误
200024 缺少开始或结束结点

开放接口

01.获取中继号列表

基本信息

Path: /ccapi/v2/spnumbers

Method: GET

接口描述:

概述

返回所有绑定在应用内的中继号列表,以及应用的默认外显号码。

名词解释

中继号:绑定到应用内号码的统称(一般分为数字中继号码和模拟固话号码两种,最主要的区别是前者支持多路并发),可能是Udesk提供,也可能是用户自建号码。
外显号码:当你用个人手机拨打其他人的电话时,对方手机上会显示一个主叫号码(如果对方手机开通来电显示功能的话),这个就是外显号码;同样,用Udesk CCPaaS平台外呼时也需要一个外显号码,并且,会按以下顺序选号:

  1. 优先使用外呼时指定的中继号;
  2. 使用座席的默认外显号码;
  3. 使用应用的默认外显号码;
  4. 以上都不满足的情况下,系统随机选号。

示例

请求

URL: http://ip:port/ccapi/v2/spnumbers?Timestamp=1566540424&AppId=a54a8b77-f12d-4ac9-742d-5b2bef5c4d11&Sign=de3fec40c8671bcbab00b12e5254e378a53f646a

响应

{
  "ErrCode": "000000",
  "ErrDesc": "OK",
  "Result": {
    "SpNumbers": [
      "057126200671",
      "057126200672",
      "057126200673",
      "057126200674"
    ],
    "DefSpNumber": "057126200670"
  }
}

请求参数

Query

参数名称 是否必须 示例 备注
AppId 4b8dc715-05e0-4340-6cae-a6e3c39a6012 应用 ID

返回数据

名称类型是否必须默认值备注其他信息
ErrCodestring必须响应码

mock: 000000

ErrDescstring必须响应描述

mock: OK

Resultobject必须
SpNumbersstring []必须中继号列表

item 类型: string

DefSpNumberstring必须当前配置的默认中继号

mock: 057126200670

02.修改默认中继号

基本信息

Path: /ccapi/v2/spnumbers/default

Method: PUT

接口描述:

概述

编辑应用默认的外显号码。

示例

请求

URL: http://ip:port/ccapi/v2/spnumbers/default?Timestamp=1566540424&AppId=a54a8b77-f12d-4ac9-742d-5b2bef5c4d11&Sign=de3fec40c8671bcbab00b12e5254e378a53f646a
BODY:
{
    "DefSpNumber":"057126200670"
}

响应

{
"ErrCode":"000000",
"ErrDesc":"OK",
"Result":""
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Query

参数名称 是否必须 示例 备注
AppId 4b8dc715-05e0-4340-6cae-a6e3c39a6012 应用 ID

Body

名称类型是否必须默认值备注其他信息
DefSpNumberstring非必须默认使用第一个中继号,可以是中继号列表中的任何一个号码

mock: 057126200670

返回数据

名称类型是否必须默认值备注其他信息
ErrCodestring必须响应码

mock: 000000

ErrDescstring必须响应描述

mock: OK

Resultstring必须无意义

03.删除默认中继号

基本信息

Path: /ccapi/v2/spnumbers/default

Method: DELETE

接口描述:

概述

清除应用的默认外显号码。

示例

请求

URL: http://ip:port/ccapi/v2/spnumbers/default?Timestamp=1566540424&AppId=a54a8b77-f12d-4ac9-742d-5b2bef5c4d11&Sign=de3fec40c8671bcbab00b12e5254e378a53f646a

响应

{
"ErrCode":"000000",
"ErrDesc":"OK",
"Result":""
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Query

参数名称 是否必须 示例 备注
AppId 4b8dc715-05e0-4340-6cae-a6e3c39a6012 应用 ID

Body

名称类型是否必须默认值备注其他信息

返回数据

名称类型是否必须默认值备注其他信息
ErrCodestring必须响应码

mock: 000000

ErrDescstring必须响应描述

mock: OK

Resultstring必须无意义

mock:

04.创建座席

基本信息

Path: /ccapi/v2/agents

Method: POST

接口描述:

概述

创建座席。
Udesk CC-PaaS基础对象关系如下图所示:
图片.png

示例

请求

URL: http://ip:port/ccapi/v2/agents?Timestamp=1566540424&AppId=a54a8b77-f12d-4ac9-742d-5b2bef5c4d11&Sign=de3fec40c8671bcbab00b12e5254e378a53f646a
BODY:
{
"AgentId":"9415",
"WorkId":"199"
}

响应

{
  "ErrCode": "000000",
  "ErrDesc": "OK",
  "Result": {
    "Extensions": {
      "Extension": "1002",
      "Password": "56ba42a18f"
    }
  }
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Query

参数名称 是否必须 示例 备注
AppId 4b8dc715-05e0-4340-6cae-a6e3c39a6012 应用 ID

Body

名称类型是否必须默认值备注其他信息
AgentIdstring必须座席ID

mock: 197

WorkIdstring必须座席工号

mock: 191

Namestring非必须座席姓名

mock: Li

Mobilestring非必须座席手机号

mock: 18512520714

Emailstring非必须座席Email

mock: 123@qq.com

Rolestring非必须可以是agent, leader,默认为agent

mock: agent

Enableboolean非必须true:启用,默认启用

mock: false

IsCreateExtensionboolean非必须创建并绑定座席分机

mock: false

WrapUpTimestring非必须话后时长

mock: 60

返回数据

名称类型是否必须默认值备注其他信息
ErrCodestring必须响应码

mock: 000000

ErrDescstring必须响应描述

mock: OK

Resultobject必须如果同时绑定分机
Extensionstring必须分机号码

mock: 1002

Passwordstring必须分机密码

mock: 1002

AgentIdstring必须坐席ID

mock: 197

Numberstring必须中继号

mock: 057126200670

ExtenInfosstring []必须分机号列表

item 类型: string

05.获取座席列表

基本信息

Path: /ccapi/v2/agents

Method: GET

接口描述:

概述

获取座席信息,可根据相关条件查询,未指定条件时返回全部座席列表。
既定查询条件有:角色、可用状态、座席状态;
模糊查询文本匹配范围:座席名称、座席工号、邮箱、手机号码。

示例

请求

URL: http://ip:port/ccapi/v2/agents?Timestamp=1566540424&AppId=a54a8b77-f12d-4ac9-742d-5b2bef5c4d11&Sign=de3fec40c8671bcbab00b12e5254e378a53f646a
2e5254e378a53f646a

响应

{
    "ErrCode":"000000",
    "ErrDesc":"",
    "Result":{
        "CurrPage":1,
        "PageSize":32,
        "Total":32,
        "TotalPage":1,
        "AgentList":[
            {
                "AppId":"4b8dc715-05e0-4340-6cae-a6e3c39a6012",
                "AgentId":"189",
                "WorkId":"",
                "Name":"管理员1",
                "Mobile":"17600364320",
                "Email":"crmdiaoxiao1@test.cn",
                "Role":"agent",
                "Queues":[
                    "9003@4b8dc715-05e0-4340-6cae-a6e3c39a6012"
                ],
                "QueuesNames":null,
                "Extensions":[
                    "1001",
                    "1008"
                ],
                "DefSpNumber":"02863138587",
                "State":1,
                "ExtState":0,
                "WrapUpTime":0,
                "Enable":true,
                "ExtenInfos":null
            }
        ]
    }
}

请求参数

Query

参数名称 是否必须 示例 备注
AppId 4b8dc715-05e0-4340-6cae-a6e3c39a6012 租户 ID
Role 角色:agent(座席),leader(班长)
Enable 可用状态:1(可用),0(禁用)
State 座席状态:offline(离线),idle(空闲),busy(示忙),onBreak(小休)
FuzzyQuery 模糊查询文本

返回数据

名称类型是否必须默认值备注其他信息
ErrCodestring必须

mock: 000000

ErrDescstring必须

mock: OK

Resultobject必须
CurrPagenumber必须当前页数

mock: 1

PageSizenumber必须每页显示数量

mock: 10

Totalnumber必须总数量

mock: 100

TotalPagenumber必须总页数

mock: 10

AgentListobject []必须坐席列表

item 类型: object

AppIdstring必须应用ID

mock: 4b8dc715-05e0-4340-6cae-a6e3c39a6012

AgentIdstring必须坐席ID

mock: 112

WorkIdstring必须任务ID

mock: 111

Namestring必须坐席姓名

mock: test

Mobilestring必须坐席手机号

mock: 17600364320

Emailstring必须坐席邮箱

mock: test@qq.com

Rolestring必须备注

mock: ""

Queuesstring []必须坐席队列列表

item 类型: string

QueuesNamesstring []必须队列名称列表

item 类型: string

Extensionsstring []必须分机号列表

item 类型: string

DefSpNumberstring必须默认中继号

mock: c39a6012

Statenumber必须状态

mock: 1

ExtStatestring必须默认分机状态

mock: 0

WrapUpTimestring必须更新时间

mock: 0

Enablestring必须是否开启

mock: false

ExtenInfosobject []必须分机号列表信息

item 类型: object

Numberstring非必须中继号

mock: 94286518751002

Extensionstring非必须分机号

mock: 1002

Passwordstring非必须分机密码

mock: eewz

SignalTypestring非必须信号类型

mock: 1

06.座席分机绑定

基本信息

Path: /ccapi/v2/agents/extensions

Method: POST

接口描述:

概述

为指定的座席绑定分机,可同时绑定两种类型分机。
注意:
座席外呼时需要手动切换到与当前外呼方式匹配的分机类型,例如,如用网页电话方式外呼,需切换到webrtc类型的分机。

示例

请求

URL: http://ip:port/ccapi/v2/agents/extensions?Timestamp=1566540424&AppId=a54a8b77-f12d-4ac9-742d-5b2bef5c4d11&Sign=de3fec40c8671bcbab00b12e5254e378a53f646a
BODY:
{
    "AgentId":"10031",
    "Extensions":[1002]
}

响应

{
    "ErrCode":"000000",
    "ErrDesc":"OK",
    "Result":""
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Query

参数名称 是否必须 示例 备注
AppId 4b8dc715-05e0-4340-6cae-a6e3c39a6012 应用 ID

Body

名称类型是否必须默认值备注其他信息
AgentIdstring必须座席ID

mock: 10031

Extensionsstring []必须分机号码列表

item 类型: string

返回数据

名称类型是否必须默认值备注其他信息
ErrCodestring必须响应码

mock: 000000

ErrDescstring必须相应描述

mock: OK

Resultstring必须无意义

mock:

07.座席分机解绑

基本信息

Path: /ccapi/v2/agents/extensions

Method: DELETE

接口描述:

概述

为指定座席解绑分机,可同时解绑两种类型分机。
注意:
如果要删除座席,须先将该座席绑定的分机全部解绑,同时,将其从所在的全部普通队列中脱离。

示例

请求

URL: http://ip:port/ccapi/v2/agents/extensions?Timestamp=1566540424&AppId=a54a8b77-f12d-4ac9-742d-5b2bef5c4d11&Sign=de3fec40c8671bcbab00b12e5254e378a53f646a
BODY:
{
    "Extensions":[
        "1002"
    ],
    "AgentId":"62"
}

响应

{
  "ErrCode": "000000",
  "ErrDesc": "OK",
  ResultL:""
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Query

参数名称 是否必须 示例 备注
AppId 4b8dc715-05e0-4340-6cae-a6e3c39a6012 应用 ID

Body

名称类型是否必须默认值备注其他信息
Extensionsstring []必须分机号码列表

item 类型: string

field_36string必须

mock: 94286518751003

AgentIdstring必须座席ID

mock: 62

返回数据

名称类型是否必须默认值备注其他信息
ErrCodestring必须响应码

mock: 000000

ErrDescstring必须响应描述

mock: OK

Resultstring必须无意义

mock:

08.删除分机

基本信息

Path: /ccapi/v2/extensions

Method: DELETE

接口描述:

概述

删除分机。
注意:
被绑定到某个座席的分机不能删除,须先将其解绑。

示例

请求

URL: http://ip:port/ccapi/v2/extensions?Timestamp=1566540424&AppId=a54a8b77-f12d-4ac9-742d-5b2bef5c4d11&Sign=de3fec40c8671bcbab00b12e5254e378a53f646a
BODY:
{
    "Extension":"1002"
}

响应

{
    "ErrCode":"000000",
    "ErrDesc":"OK",
    "Result":" "
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Query

参数名称 是否必须 示例 备注
AppId 4b8dc715-05e0-4340-6cae-a6e3c39a6012 应用 ID

Body

名称类型是否必须默认值备注其他信息
Extensionstring必须分机号码

mock: 1002

返回数据

名称类型是否必须默认值备注其他信息
ErrCodestring必须响应码

mock: 000000

ErrDescstring必须响应描述

mock: OK

Resultstring必须无意义

mock:

09.创建分机

基本信息

Path: /ccapi/v2/extensions

Method: POST

接口描述:

概述

创建分机。
分机分为两种类型:0(sip,对应sip话机方式),1(webrtc,对应网页电话方式);
注意:

示例

请求

URL: http://ip:port/ccapi/v2/extensions?Timestamp=1566540424&AppId=a54a8b77-f12d-4ac9-742d-5b2bef5c4d11Sign=de3fec40c8671bcbab00b12e5254e378a53f646a
BODY:
{
    "Extension":"1002",
    "Password":"802411d4",
    "Number":"94286518751002",
    "SignalType":0
}

响应

{
    "ErrCode":"000000",
    "ErrDesc":"OK",
    "Result":{
        "Extension":"1002",
        "Password":"802411d4"
    }
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Query

参数名称 是否必须 示例 备注
AppId 4b8dc715-05e0-4340-6cae-a6e3c39a6012 应用 ID

Body

名称类型是否必须默认值备注其他信息
Extensionstring必须分机号

mock: 1032

Passwordstring必须分机密码

mock: 802411d4

Numberstring必须座席使用的sip账号

mock: 99360996521032

SignalTypeinteger必须分机类型:0(sip),1(webrtc)

mock: 0

返回数据

名称类型是否必须默认值备注其他信息
ErrCodestring必须响应码

mock: 000000

ErrDescstring必须响应描述

mock: OK

Resultobject必须
Extensionstring必须分机号

mock: 1002

Passwordstring必须分机密码

mock: 802411d4

10.获取座席的分机信息

基本信息

Path: /ccapi/v2/extensions/rerouter

Method: POST

接口描述:

概述

获取指定座席的分机信息。
如果'SignalType'参数未指定,默认返回sip类型分机的信息。

示例

请求

URL: http://ip:port/ccapi/v2/extensions?Timestamp=1566540424&AppId=a54a8b77-f12d-4ac9-742d-5b2bef5c4d11&Sign=de3fec40c8671bcbab00b12e5254e378a53f646a&AgentId=200&SignalType=0

响应

{
  "ErrCode": "000000",
  "ErrDesc": "OK",
  "Result": {
    "Extension": "1002",
    "SignalType": "0",
    "Number": "94286518751002",
    "Password": "yrw341"
  }
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Query

参数名称 是否必须 示例 备注
AppId 4b8dc715-05e0-4340-6cae-a6e3c39a6012 应用 ID

Body

名称类型是否必须默认值备注其他信息
AgentIdstring必须坐席ID

mock: 88

SignalTypestring必须信号类型

mock: 0

返回数据

名称类型是否必须默认值备注其他信息
ErrCodestring必须响应码

mock: 000000

ErrDescstring必须响应描述

mock: OK

Resultobject必须
Extensionstring必须分机号

mock: 1002

Passwordstring必须分机密码

mock: 802411d4

Numberstring必须座席使用sip账号

mock: 94286518751002

SignalTypestring必须信号类型

mock: 0

11.获取队列列表

基本信息

Path: /ccapi/v2/queues

Method: GET

接口描述:

概述

获取队列信息列表。

示例

请求

URL: http://ip:port/ccapi/v2/queues?Timestamp=1566540424&AppId=a54a8b77-f12d-4ac9-742d-5b2bef5c4d11&Sign=de3fec40c8671bcbab00b12e5254e378a53f646a

响应

{
    "ErrCode":"000000",
    "ErrDesc":"OK",
    "Result":{
        "Queues":[
            {
                "QueueId":"9001",
                "Name":"管理员测试",
                "Strategy":0,
                "Timeout":0,
                "WaitMusic":"waitmusic.wav"
            }
        ]
    }
}

请求参数

Query

参数名称 是否必须 示例 备注
AppId 4b8dc715-05e0-4340-6cae-a6e3c39a6012 应用 ID

返回数据

名称类型是否必须默认值备注其他信息
ErrCodestring必须响应码

mock: 000000

ErrDescstring必须响应描述

mock: OK

Resultobject必须
Queuesobject []必须队列列表

item 类型: object

QueueIdstring必须队列ID

mock: 9001

Namestring必须队列名称

mock: 管理员测试

Strategynumber必须队列分配策略

mock: 0

Timeoutnumber必须排队等待超时时间

mock: 0

MaxLengthstring必须队列最大排队长度

mock: 10

WaitMusicstring必须排队等待时播放的音乐

mock: waitmusic.wav

12.创建队列

基本信息

Path: /ccapi/v2/queues

Method: POST

接口描述:

概述

创建普通队列。
'Strategy'指定队列的分配策略,可选值为整数0,1,2:
0:按照座席当天上线顺序轮流分配;
1:按照座席当天的最小接听数分配,即接听数越少,优先级越高;
2:按照座席最近一次的空闲时间分配,即空闲时间越长,优先级越高;

示例

请求

URL: http://ip:port/ccapi/v2/queues?Timestamp=1566540424&AppId=a54a8b77-f12d-4ac9-742d-5b2bef5c4d11&Sign=de3fec40c8671bcbab00b12e5254e378a53f646a
BODY:
{
    "QueueId":"9008",
    "QueueName":"测试创建队列007",
    "WaitMusic":""
}

响应

{
    "ErrCode":"000000",
    "ErrDesc":"OK",
    "Result":""
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Query

参数名称 是否必须 示例 备注
AppId 4b8dc715-05e0-4340-6cae-a6e3c39a6012 应用 ID

Body

名称类型是否必须默认值备注其他信息
QueueIdstring必须队列ID

mock: 9008

QueueNamestring非必须队列名称

mock: 测试创建队列007

Strategyinteger必须队列分配策略
Timeoutstring必须排队等待超时时间
MaxLengthstring必须队列最大排队长度
WaitMusicstring必须排队等待时播放的音乐

mock:

返回数据

名称类型是否必须默认值备注其他信息
ErrCodestring必须响应码

mock: 000000

ErrDescstring必须响应描述

mock: OK

Resultstring必须无意义

mock:

13.修改队列

基本信息

Path: /ccapi/v2/queues

Method: PUT

接口描述:

概述

修改指定队列。

示例

请求

URL: http://ip:port/ccapi/v2/queues?Timestamp=1566540424&AppId=a54a8b77-f12d-4ac9-742d-5b2bef5c4d11Sign=de3fec40c8671bcbab00b12e5254e378a53f646a
BODY:
{
    "QueueId":"9009"
}

响应

{
    "ErrCode":"000000",
    "ErrDesc":"OK",
    "Result":""
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Query

参数名称 是否必须 示例 备注
AppId 4b8dc715-05e0-4340-6cae-a6e3c39a6012 应用 ID

Body

名称类型是否必须默认值备注其他信息
QueueIdstring必须队列ID

mock: 9009

QueueNamestring非必须队列名称

mock: 测试创建队列007

Strategyinteger非必须队列分配策略
Timeoutstring非必须排队等待超时时间

mock: 60

MaxLengthstring非必须队列最大排队长度

mock: 10

WaitMusicstring非必须排队等待时播放的音乐

返回数据

名称类型是否必须默认值备注其他信息
ErrCodestring必须响应码

mock: 000000

ErrDescstring必须响应描述

mock: OK

Resultstring必须无意义

mock:

14.删除队列

基本信息

Path: /ccapi/v2/queues

Method: DELETE

接口描述:

概述

删除指定队列。
注意:
有座席在列的队列不能删除。

示例

请求

URL: http://ip:port/ccapi/v2/queues?Timestamp=1566540424&AppId=a54a8b77-f12d-4ac9-742d-5b2bef5c4d11Sign=de3fec40c8671bcbab00b12e5254e378a53f646a
BODY:
{
    "QueueId":"9009"
}

响应

{
    "ErrCode":"000000",
    "ErrDesc":"OK",
    "Result":""
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Query

参数名称 是否必须 示例 备注
AppId 4b8dc715-05e0-4340-6cae-a6e3c39a6012 应用 ID

Body

名称类型是否必须默认值备注其他信息
QueueIdstring必须队列ID

mock: 9009

返回数据

名称类型是否必须默认值备注其他信息
ErrCodestring必须响应码

mock: 000000

ErrDescstring必须响应描述

mock: OK

Resultstring必须无意义

mock:

15.队列批量添加座席

基本信息

Path: /ccapi/v2/queues/agents

Method: POST

接口描述:

概述

为指定队列批量添加座席。
注意:
增量操作,不影响队列中原来在列的座席;

示例

请求

URL: http://ip:port/ccapi/v2/queues/agents?Timestamp=1566540424&AppId=a54a8b77-f12d-4ac9-742d-5b2bef5c4d11Sign=de3fec40c8671bcbab00b12e5254e378a53f646a
BODY:
{
    "QueueId":"9009",
    "AgentIds":[
        "9009",
        "9008",
        "9007",
        "9006"
    ]
}

响应

{
    "ErrCode":"000000",
    "ErrDesc":"OK",
    "Result":""
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Query

参数名称 是否必须 示例 备注
AppId 4b8dc715-05e0-4340-6cae-a6e3c39a6012 应用 ID

Body

名称类型是否必须默认值备注其他信息
QueueIdstring必须队列ID

mock: 9009

AgentIdsstring []必须座席ID列表

item 类型: string

返回数据

名称类型是否必须默认值备注其他信息
ErrCodestring必须响应码

mock: 000000

ErrDescstring必须响应描述

mock: OK

Resultstring必须无意义

mock:

16.座席批量入队

基本信息

Path: /ccapi/v2/agents/queues

Method: POST

接口描述:

概述

为指定座席批量入队。
注意:
参数'IsFull'默认置0,接口表现为增量操作,不影响座席原来所在的队列列表;
当参数'IsFull'置1时,接口表现为全量操作,可用于同三方系统的队列信息同步。

示例

请求

URL: http://ip:port/ccapi/v2/agents/queues?Timestamp=1566540424&AppId=a54a8b77-f12d-4ac9-742d-5b2bef5c4d11Sign=de3fec40c8671bcbab00b12e5254e378a53f646a
BODY:
{
    "AgentId":"1443",
    "Queues":[
        "117",
        "115",
        "113",
        "127",
        "111"
    ]
}

响应

{
    "ErrCode":"000000",
    "ErrDesc":"OK",
    "Result":""
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Query

参数名称 是否必须 示例 备注
AppId 4b8dc715-05e0-4340-6cae-a6e3c39a6012 应用 ID

Body

名称类型是否必须默认值备注其他信息
AgentIdstring必须座席ID

mock: 1443

Queuesstring []必须队列ID列表

item 类型: string

IsFullinteger非必须是否全量更新

返回数据

名称类型是否必须默认值备注其他信息
ErrCodestring必须响应码

mock: 000000

ErrDescstring必须响应描述

mock: OK

Resultstring必须无意义

mock:

17.座席批量出队

基本信息

Path: /ccapi/v2/agents/queues

Method: DELETE

接口描述:

概述

为指定座席批量出队。

示例

请求

URL: http://ip:port/ccapi/v2/agents/queues?Timestamp=1566540424&AppId=a54a8b77-f12d-4ac9-742d-5b2bef5c4d11Sign=de3fec40c8671bcbab00b12e5254e378a53f646a
BODY:
{
    "AgentId":"1443",
    "Queues":[
        "9008"
    ]
}

响应

{
    "ErrCode":"000000",
    "ErrDesc":"OK",
    "Result":""
    ]
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Query

参数名称 是否必须 示例 备注
AppId 4b8dc715-05e0-4340-6cae-a6e3c39a6012 应用 ID

Body

名称类型是否必须默认值备注其他信息
AgentIdstring必须座席ID

mock: 1443

Queuesstring []必须队列ID

item 类型: string

返回数据

名称类型是否必须默认值备注其他信息
ErrCodestring必须响应码

mock: 000000

ErrDescstring必须响应描述

mock: OK

Resultstring必须无意义

mock:

18.订阅事件

基本信息

Path: /ccapi/v2/webhooks/events

Method: POST

接口描述:

概述

订阅事件,当订阅的事件发生时,相关消息会发送到指定的回调地址。
回调地址通过后台设置。
Events参数详情如下:

category all_type 备注
agent_state acd_agent_state 座席状态事件
ext_state extension_state_update 分机状态事件
agent_call_mode agent_call_mode_change 座席使用的分机模式切换事件
call general_hangup 挂断消息
enqueue_succ 入队成功
record_stop 录音结束
hangup_cause 挂机原因事件
dequeue_succ 出队消息
start_dialout 开始外呼
voice_mail_succ 留言成功
play_succ 放音成功
dtmf_gather_succ 按键输入
asr_gather_succ 语音识别成功
consult_succ 咨询成功
end_consult_succ 咨询取消成功
three_way_succ 三方成功
substitute_succ 拦截成功
hold_agent_succ 保持成功
extern_succ 转外线成功
eavesdrop_succ 监听成功

示例

请求

URL: http://ip:port/ccapi/v2/webhooks/events?Timestamp=1566540424&AppId=a54a8b77-f12d-4ac9-742d-5b2bef5c4d11Sign=de3fec40c8671bcbab00b12e5254e378a53f646a
BODY:
{
    "Events":[
        {
            "category":"agent_state",
            "all_type":["consult_succ"]
        }
    ]
}

响应

{
    "ErrCode":"000000",
    "ErrDesc":"OK",
    "Result":[]
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Query

参数名称 是否必须 示例 备注
AppId 4b8dc715-05e0-4340-6cae-a6e3c39a6012 应用 ID
Timestamp 1566523582 时间戳

Body

名称类型是否必须默认值备注其他信息
Eventsobject []必须事件名称列表(参考备注)

item 类型: object

categorystring必须订阅事件类型

mock: agent_state

all_typestring []必须订阅事件

item 类型: string

返回数据

名称类型是否必须默认值备注其他信息
ErrCodestring必须响应码

mock: 000000

ErrDescstring必须响应描述

mock: OK

19.更新事件

基本信息

Path: /ccapi/v2/webhooks/events

Method: PUT

接口描述:

概述

更新已订阅的事件。

示例

请求

URL: http://ip:port/ccapi/v2/webhooks/events?Timestamp=1566540424&AppId=a54a8b77-f12d-4ac9-742d-5b2bef5c4d11Sign=de3fec40c8671bcbab00b12e5254e378a53f646a
BODY:
{
    "Events":[
        {
            "category":"agent_state",
            "all_type":["acd_agent_state"]
        }
    ]
}

响应

{
    "ErrCode":"000000",
    "ErrDesc":"OK",
    "Result":[]
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Query

参数名称 是否必须 示例 备注
AppId 4b8dc715-05e0-4340-6cae-a6e3c39a6012 应用 ID
Timestamp 1566523582 时间戳

Body

名称类型是否必须默认值备注其他信息
Eventsobject []必须事件名称列表(参考备注)

item 类型: object

categorystring必须

mock: agent_state

all_typestring []必须

item 类型: string

返回数据

名称类型是否必须默认值备注其他信息
ErrCodestring必须响应码

mock: 000000

ErrDescstring必须响应描述

mock: OK

20.删除事件

基本信息

Path: /ccapi/v2/webhooks/events

Method: DELETE

接口描述:

概述

退订已订阅的事件。

示例

请求

URL: http://ip:port/ccapi/v2/webhooks/events?Timestamp=1566540424&AppId=a54a8b77-f12d-4ac9-742d-5b2bef5c4d11Sign=de3fec40c8671bcbab00b12e5254e378a53f646a
BODY:
{
    "Events":[
        {
            "category":"agent_state",
            "all_type":["acd_agent_state"]
        }
    ]
}

响应

{
    "ErrCode":"000000",
    "ErrDesc":"OK",
    "Result":[]
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Query

参数名称 是否必须 示例 备注
AppId 4b8dc715-05e0-4340-6cae-a6e3c39a6012 应用 ID
Timestamp 1566523582 时间戳

Body

名称类型是否必须默认值备注其他信息
Eventsobject []必须事件名称列表(参考备注)

item 类型: object

categorystring必须

mock: agent_state

all_typestring []必须

item 类型: string

返回数据

名称类型是否必须默认值备注其他信息
ErrCodestring必须响应码

mock: 000000

ErrDescstring必须响应描述

mock: OK

Resultstring必须无意义

mock:

21.获取事件列表

基本信息

Path: /ccapi/v2/subscriptions

Method: GET

接口描述:

概述

获取已订阅的事件列表。

示例

请求

URL: http://ip:port/ccapi/v2/subscriptions?Timestamp=1566540424&AppId=a54a8b77-f12d-4ac9-742d-5b2bef5c4d11&Sign=de3fec40c8671bcbab00b12e5254e378a53f646a
body:

响应

{
    "ErrCode":"000000",
    "ErrDesc":"OK",
    "Result":{
        "callback":"http://59.110.105.200:12345",
        "enable":"false",
        "events":["acd_agent_state"],
        "name":"sub1"
    }
}

请求参数

Query

参数名称 是否必须 示例 备注
AppId 4b8dc715-05e0-4340-6cae-a6e3c39a6012 应用 ID

返回数据

名称类型是否必须默认值备注其他信息
ErrCodestring必须响应码

mock: 000000

ErrDescstring必须响应描述

mock: OK

Resultobject必须
callbackstring必须回调地址

mock: http://59.110.105.200:12345

namestring必须订阅的名字

mock: sub1

eventsstring []必须订阅事件列表

item 类型: string

enablestring必须订阅状态 true:启用,false:禁用

mock: false

22.停止自动外呼任务

基本信息

Path: /ccapi/v2/ads/task/stop

Method: POST

接口描述:

概述

停止执行指定的自动外呼任务。

示例

请求

URL: http://ip:port/ads/task/stop?Timestamp=1566540424&AppId=a54a8b77-f12d-4ac9-742d-5b2bef5c4d11Sign=de3fec40c8671bcbab00b12e5254e378a53f646a
BODY:
{
    "AdTaskId":"331"
}

响应

{
    "ErrCode":"000000",
    "ErrDesc":"OK",
    "Result":""
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Query

参数名称 是否必须 示例 备注
AppId 4b8dc715-05e0-4340-6cae-a6e3c39a6012 应用 ID

Body

名称类型是否必须默认值备注其他信息
AdTaskIdstring必须任务ID

mock: 331

返回数据

名称类型是否必须默认值备注其他信息
ErrCodestring必须响应码

mock: 000000

ErrDescstring必须响应描述

mock: OK

Resultstring必须无意义

mock:

23.强制停止自动外呼任务

基本信息

Path: /ccapi/v2/ads/task/force_stop

Method: POST

接口描述:

概述

同接口22

示例

请求

URL: http://ip:port/ads/task/force_stop?Timestamp=1566540424&AppId=a54a8b77-f12d-4ac9-742d-5b2bef5c4d11Sign=de3fec40c8671bcbab00b12e5254e378a53f646a
BODY:
{
    "AdTaskId":"331"
}

响应

{
    "ErrCode":"000000",
    "ErrDesc":"OK",
    "Result": ""
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Query

参数名称 是否必须 示例 备注
AppId 4b8dc715-05e0-4340-6cae-a6e3c39a6012 应用 ID

Body

名称类型是否必须默认值备注其他信息
AdTaskIdstring必须任务ID

mock: 331

返回数据

名称类型是否必须默认值备注其他信息
ErrCodestring必须响应码

mock: 000000

ErrDescstring必须响应描述

mock: OK

Resultstring必须无意义

mock:

24.修改自动外呼任务系数

基本信息

Path: /ccapi/v2/ads/task/update_ratio

Method: POST

接口描述:

概述

修改自动外呼系数。
系数对不同的自动外呼任务类型来说有不同意义:
比例外呼:系数表示呼叫比例;
预测外呼:系数表示呼叫强度。

示例

请求

URL: http://ip:port/task/update_ratio?Timestamp=1566540424&AppId=a54a8b77-f12d-4ac9-742d-5b2bef5c4d11Sign=de3fec40c8671bcbab00b12e5254e378a53f646a
BODY:
{
    "AdTaskId":"313",
    "AdTaskRatio":"1.0"
}

响应

{
    "ErrCode":"000000",
    "ErrDesc":"OK",
    "Result":""
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Query

参数名称 是否必须 示例 备注
AppId 4b8dc715-05e0-4340-6cae-a6e3c39a6012 应用 ID

Body

名称类型是否必须默认值备注其他信息
AdTaskIdstring必须任务ID

mock: 313

AdTaskRationumber必须自动外呼系数,取值在1.0~5.0之间,0.1递进

返回数据

名称类型是否必须默认值备注其他信息
codestring必须响应码

mock: 000000

messagestring必须响应描述

mock: OK

resultsstring必须无意义

mock:

25.获取通话记录

基本信息

Path: /ccapi/v2/calls/logs

Method: POST

接口描述:

概述

获取通话记录,可通过'CallId'参数获取指定的记录。
注意:

示例

请求

URL: http://ip:port/calls/logs?AppId=a54a8b77-f12d-4ac9-742d-5b2bef5c4d11&CallId=50def7e0-cf70-411e-9e05-4381817b441c
BODY:
{
    "CallId":"bc1cc555-0b24-4e1c-9979-a514888ea495",
    "PageSize":"10",
    "PageNum":"1",
    "EndTime":"1566320334606",
    "StartTime":"1566298669326"
}

响应

{
    "ErrCode":"000000",
    "ErrDesc":"OK",
    "Result":[
        {
            "CallLogs":{
                "CallId":"bc1cc555-0b24-4e1c-9979-a514888ea495",
                "AgentName":" ",
                "AgentId":" ",
                "SpNumber":"057128091649",
                "UNCity":" ",
                "UNProvince":" ",
                "DestNumber":"01086482889",
                "TotalDuration":"21665",
                "CallDuration":"0",
                "UserAnswerTime":"0",
                "AgentAnswerTime":"1566298674686",
                "EndTime":"1566320334606",
                "StartTime":"1566298669326",
                "HangupReason":" ",
                "HangupBy":"agent",
                "EndType":"callResult",
                "CallType":"呼出",
                "Email":" ",
                "WorkId":" ",
                "AdTaskId":" ",
                "AdCallId":" ",
                "AIRecordLen":"0",
                "RobotVars":"null",
                "AgentDevType":"voip",
                "HangupCode":" "
            }
        }
     ]
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Query

参数名称 是否必须 示例 备注
AppId 4b8dc715-05e0-4340-6cae-a6e3c39a6012 应用 ID

Body

名称类型是否必须默认值备注其他信息
CallIdstring必须呼叫ID,非空时只获取这个CallId相关的记录

mock: bc1cc555-0b24-4e1c-9979-a514888ea495

PageSizenumber必须页大小,最大100

mock: 10

PageNumnumber必须第几页

mock: 1

StartTimenumber必须定义获取记录的时间范围,开始时间

mock: 1536523582

EndTimenumber必须定义获取记录的时间范围,结束时间

mock: 1566523582

返回数据

名称类型是否必须默认值备注其他信息
ErrCodestring必须响应码

mock: 000000

ErrDescstring必须响应描述

mock: OK

Resultobject []必须

item 类型: object

CallLogsobject必须呼叫记录列表
CallIdstring必须呼叫标识

mock: bc1cc555-0b24-4e1c-9979-a514888ea495

StartTimestring必须通话开始时间

mock: 1566298669326

EndTimestring必须通话结束时间

mock: 1566320334606

AgentAnswerTimestring必须座席接听时间

mock: 1566298674686

UserAnswerTimestring必须客户接听时间

mock: 0

CallDurationstring必须通话时长,单位:秒

mock: 0

TotalDurationstring必须通话总时长,单位:秒

mock: 21665

DestNumberstring必须客户号码

mock: 01086482889

UNProvincestring必须客户号码归属省份

mock:

UNCitystring必须客户号码归属城市

mock:

SpNumberstring必须中继号码

mock: 057128091649

AgentIdstring必须座席ID

mock:

AgentNamestring必须座席姓名

mock:

WorkIdstring必须座席工号

mock:

Emailstring必须座席邮箱

mock:

CallTypestring必须通话类型, 如:呼入、呼出、呼入(转接)、呼入(监听)等

mock: 呼出

EndTypestring必须通话结果

mock: callResult

HangupBystring必须通话挂断方,客户or座席

mock: agent

HangupReasonstring必须挂机原因

mock:

HangupCodestring必须挂机返回码

mock:

AgentDevTypestring必须设备类型,ip座机”或“手机、软电话

mock: voip

RobotVarsstring必须AI 变量

mock: null

AIRecordLenstring必须AI录音时长

mock: 0

AdCallIdstring必须ads呼叫ID

mock:

AdTaskIdstring必须ads任务ID

mock:

26.获取录音记录

基本信息

Path: /ccapi/v2/calls/recfiles

Method: POST

接口描述:

概述

获取录音记录,可通过'CallId'参数获取指定的记录。
注意:

示例

请求

URL: http://ip:port/calls/recfiles?AppId=30fe35c-995d-4921-55b8-ad21b476bbb8
BODY:
{
    "CallId":"1a8462d7-00fc-4cc2-4567-038ced6ba580",
    "PageSize":"10",
    "PageNum":"1",
    "StartTime":"1566316800000",
    "EndTime":"1566316800001"
}

响应

{
    "ErrCode":"000000",
    "ErrDesc":"OK",
    "Result":[
        {
            "RecFiles":{
                "CallId":"111",
                "EndTime":"1566298669326",
                "StartTime":"1566298669326",
                "RecFileUrl":" ",
                "Duration":"1"
            }
        }
    ]
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Query

参数名称 是否必须 示例 备注
AppId 4b8dc715-05e0-4340-6cae-a6e3c39a6012 应用 ID

Body

名称类型是否必须默认值备注其他信息
CallIdstring必须呼叫ID,非空时只获取这个CallId相关的记录

mock: 975ccb60-f9b7-11e6-a902-bd8773eea397

PageSizenumber必须页大小,最大100

mock: 10

PageNumnumber必须第几页

mock: 1

StartTimenumber必须定义获取记录的时间范围,开始时间

mock: 1566316800000

EndTimenumber必须定义获取记录的时间范围,结束时间

mock: 1566316800001

返回数据

名称类型是否必须默认值备注其他信息
ErrCodestring必须响应码

mock: 000000

ErrDescstring必须响应描述

mock: OK

Resultobject []必须

item 类型: object

RecFilesobject必须录音记录列表
CallIdstring必须呼叫标识

mock: 111

StartTimestring必须录音开始时间

mock: 1566298669326

EndTimestring必须录音结束时间

mock: 1566298669326

Durationstring必须录音时长,单位:秒

mock: 1

RecFileUrlstring必须录音文件地址

mock:

27.录音记录日志

基本信息

Path: /ccapi/v2/records/logs

Method: GET

接口描述:

概述

获取录音记录,可通过'CallId'参数获取指定的记录。
注意:

示例

请求

URL: http://ip:port/records/logs?AppId=d30fe35c-995d-4921-55b8-ad21b476bbb&CallId=bc1cc555-0b24-4e1c-9979-a514888ea495&PageSize=10&PageNum=1&StartTime=1566298669326&EndTime=1566298669326

响应

{
    "ErrCode":"000000",
    "ErrDesc":"OK",
    "Result":[
        {
            "RecordLogs":{
                "Type":"begin",
                "RecordType":"ivr",
                "RecordUrl":"http://xxx.com",
                "Notify":" ",
                "Workflow":" ",
                "CallId":"bc1cc555-0b24-4e1c-9979-a514888ea495",
                "Timestamp":"1566298669326",
                "AdTaskId":"441",
                "AdCallId":"c1cc555-0b24-4e1c-9979-a514888ea49",
                "RecordId":"1"
            }
        }
    ]
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded

Query

参数名称 是否必须 示例 备注
AppId 4b8dc715-05e0-4340-6cae-a6e3c39a6012 应用 ID
CallId bc1cc555-0b24-4e1c-9979-a514888ea495 呼叫 ID,有此参数,只取这个 CallId 的记录
PageSize 10 页大小,最大 100
PageNum 1 第几页
StartTime 1566298669326 通话开始时间
EndTime 1566298669326 通话结束时间

返回数据

名称类型是否必须默认值备注其他信息
ErrCodestring必须响应码

mock: 000000

ErrDescstring必须响应描述

mock: OK

Resultobject []必须

item 类型: object

RecordLogsobject必须日志列表
Typestring必须表示座席状态:begin:开始,end:结束,agent_ringing:坐席响铃,record_stop:上报结束, angen_state:坐席变更状态

mock: begin

Timestampstring必须时间戳

mock: 1566298669326

CallIdstring必须呼叫标识

mock: bc1cc555-0b24-4e1c-9979-a514888ea495

Workflowstring必须流程,表示呼入呼出类型: out_direct 直接呼出 out_callback 网页回拨呼出 in 呼入 out_auto 机器人呼出 other 其它 inner_call 内部呼入

mock:

Notifystring必须通知

mock:

RecordUrlstring必须录音url

mock: http://xxx.com

RecordTypestring必须录音类型:(ivr录音,坐席录音)

mock: ivr

RecordIdstring必须录音ID

mock: 1

AdCallIdstring必须自动外呼呼叫ID

mock: c1cc555-0b24-4e1c-9979-a514888ea49

AdTaskIdstring必须自动外呼任务ID

mock: 441

28.获取座席状态变化记录

基本信息

Path: /ccapi/v2/agents/statelogs

Method: POST

接口描述:

概述

获取座席状态变化记录,默认返回应用所有座席状态的变更记录;如果指定参数'AgentId',则只返回此座席相关的状态变化记录。
注意:

示例

请求

URL: http://ip:port/agents/statelogs?AppId=c1cc555-0b24-4e1c-9979-a514888ea49&AgentId=8933&PageSize=10&PageNum=1&StartTime=1566298669326&EndTime=1566298669326
BODY:
{
    "AgentId":"847",
    "PageSize":"10",
    "PageNum":"1",
    "StartTime":"1566316800000",
    "EndTime":"1566316800001"
}

响应

{
    "ErrCode":"000000",
    "ErrDesc":"OK",
    "Result":[
        {
            "AgentStateLogs":{
                "AgentId":"9981",
                "WorkId":"111",
                "AgentName":" ",
                "EndTime":"1566298669326",
                "StartTime":"1566298669326",
                "CurStateSubId":"0",
                "CurState":"2",
                "OldStateSubId":"11",
                "OldState":"2",
                "Duration":"10"
            }
        }
    ]
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Query

参数名称 是否必须 示例 备注
AppId 4b8dc715-05e0-4340-6cae-a6e3c39a6012 应用 ID

Body

名称类型是否必须默认值备注其他信息
AgentIdstring非必须座席ID

mock: 8933

PageSizenumber必须页大小,最大100

mock: 10

PageNumnumber必须第几页

mock: 1

StartTimenumber必须定义获取记录的时间范围,开始时间

mock: 1565298669326

EndTimenumber必须定义获取记录的时间范围,结束时间

mock: 1566298669326

返回数据

名称类型是否必须默认值备注其他信息
ErrCodestring必须响应码

mock: 000000

ErrDescstring必须响应描述

mock: OK

Resultobject []必须

item 类型: object

AgentStateLogsobject必须
AgentIdstring必须座席ID

mock: 9981

AgentNamestring必须座席姓名

mock:

WorkIdstring必须座席工号

mock: 111

CurStatestring必须当前状态

mock: 2

CurStateSubIdstring必须当前状态子Id

mock: 0

StartTimestring必须当前状态开始时间

mock: 1566298669326

EndTimestring必须当前状态结束时间

mock: 1566298669326

Durationstring必须当前状态持续时长,单位:秒

mock: 10

OldStatestring必须前一状态

mock: 2

OldStateSubIdstring必须前一状态子Id

mock: 11

29.获取座席分机状态日志

基本信息

Path: /ccapi/v2/ext/statelogs

Method: POST

接口描述:

概述

获取指定座席的分机状态变更日志。
注意:

示例

请求

URL: http://ip:port/ext/statelogs?AppId=bc1cc555-0b24-4e1c-9979-a514888ea495&AgentId=1443&PageSize=10&PageNum=1&StartTime=1511069652789&EndTime=1511069652789
BODY:
{
    "AgentId":"845",
    "PageSize":"10",
    "PageNum":"1",
    "StartTime":"1566316800000",
    "EndTime":"1566316800001"
}

响应

{
    "ErrCode":"000000",
    "ErrDesc":"OK",
    "Result":[
        {
            "ExtStateLogs":{
                "Type":"channel_create",
                "Notify":" ",
                "AgentId":"1448",
                "Timestamp":"1511069652789",
                "Reason":" ",
                "ExtState":"0",
                "Number":"057126200670"
            }
        }
    ]
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Query

参数名称 是否必须 示例 备注
AppId 4b8dc715-05e0-4340-6cae-a6e3c39a6012 应用 ID

Body

名称类型是否必须默认值备注其他信息
AgentIdstring必须座席ID

mock: 1443

PageSizenumber必须页大小,最大100

mock: 10

PageNumnumber必须第几页

mock: 1

StartTimenumber必须定义获取记录的时间范围,开始时间

mock: 1511069652789

EndTimenumber必须定义获取记录的时间范围,结束时间

mock: 1511069652789

返回数据

名称类型是否必须默认值备注其他信息
ErrCodestring必须响应码

mock: 000000

ErrDescstring必须响应描述

mock: OK

Resultobject []必须

item 类型: object

ExtStateLogsobject必须记录列表
Typestring必须分机状态变化原因(channel_create:分机创建,channel_answer:分机应答,channel_hangup:分机挂断,register:分机注册,unregister分机注销)

mock: channel_create

Timestampstring必须时间戳

mock: 1511069652789

AgentIdstring必须座席ID

mock: 1448

Notifystring必须通知

mock:

Numberstring必须中继号

mock: 057126200670

ExtStatestring必须分机状态

mock: 0

Reasonstring必须原因

mock:

30.座席签入

基本信息

Path: /ccapi/v2/agent/login

Method: POST

接口描述:

概述

签入指定座席。
注意:

示例

请求

URL: http://ip:port/ccapi/v2/agent/login?Timestamp=1566540424&AppId=a54a8b77-f12d-4ac9-742d-5b2bef5c4d11&Sign=de3fec40c8671bcbab00b12e5254e378a53f646a
BODY:
{
    "agent_id":"10032"
}

响应

{
"ErrCode":"000000",
"ErrDesc":"OK",
"result":"",
"msg_id":"123456789",
"data":""
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Query

参数名称 是否必须 示例 备注
MsgId 111 签入时发送过来的 MsgId
AppId a54a8b77-f12d-4ac9-742d-5b2bef5c4d11 应用 ID

Body

名称类型是否必须默认值备注其他信息
agent_idstring必须座席ID

mock: 10032

work_idstring非必须座席工号

mock: 22

queue_idsstring []非必须队列标识数组

item 类型: string

numberstring非必须座席联系方式, PSTN号码或VOIP帐号

mock: 1333

statenumber非必须座席上线后的状态,0: 'Idle', 1: 'Waiting'

mock: 1

返回数据

名称类型是否必须默认值备注其他信息
ErrCodestring必须响应码
ErrDescstring必须响应描述
msg_idstring必须签入时发送过来的MsgId
result string必须
data string必须

31.座席签出

基本信息

Path: /ccapi/v2/agent/logout

Method: POST

接口描述:

概述

签出指定座席。
注意:

示例

请求

URL: http://ip:port/ccapi/v2/agent/logout?Timestamp=1566540424&AppId=a54a8b77-f12d-4ac9-742d-5b2bef5c4d11&Sign=de3fec40c8671bcbab00b12e5254e378a53f646a
BODY:
{
    "agent_id":"10032"
}

响应

{
"ErrCode":"000000",
"ErrDesc":"OK"
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Query

参数名称 是否必须 示例 备注
MsgId 签入时发送过来的 MsgId
app_id 应用 ID

Body

名称类型是否必须默认值备注其他信息
agent_idstring必须座席ID

mock: 10032

返回数据

名称类型是否必须默认值备注其他信息
ErrCodestring必须响应码
ErrDescstring必须响应描述