呼叫中心接口 - Udesk | 开发者中心

发起网页回呼接口

该接口用于发起网页回呼，先呼客户，再呼客服（视为呼入）

请求方法

POST /callcenter/web_callback

请求参数

参数名	必填	类型	说明
from_number	是	字符串	主叫号码（客户号码）
to_number	是	字符串	被叫号码（中继号）
variables	否	JSON	随路自定义变量(可在智能路由ivr路径中作为变量配置使用，变量的value只能是字符串或者数字)

返回结果

属性名	类型	说明
code	整型	执行结果码 1000 # 代表成功

示例

curl https://demo.udesk.cn/open_api_v1/callcenter/web_callback?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X POST \
-H 'content-type:application/json' \
-d '
{
"from_number": "13666666666",
"to_number": "01086465040",
"variables": {
"key1": 123,
"key2": "13200000000"
}
} '

{
    "code": 1000
}

获取呼叫中心中继号列表

该接口用于获取呼叫中心中继号列表

请求方法

GET /callcenter/callout_number_list

请求参数

参数名	必填	类型	说明	限制
page	否	整型	页码，从1开始，默认为1
per_page	否	整型	每页数量，默认10，最大100

返回结果

属性名	类型	说明
code	整型	执行结果码，1000代表成功
items	数组	号码列表, 详见数据结构-中继号
meta	对象	分页信息，详见通用数据

示例

curl https://demo.udesk.cn/open_api_v1/callcenter/callout_number_list?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2

{
    "code": 1000,
    "items": [
        {
            "id": 1,
            "number": "01086465044",
            "name": "测试测试",
            "memo": "备注备注",
            "type": null,
            "province": "北京",
            "supplier": null,
            "pstn": null,
            "call_limit": 10
        },
        {
            "id": 2,
            "number": "66666666",
            "name": "fakenumber",
            "memo": "fake",
            "type": null,
            "province": null,
            "supplier": null,
            "pstn": null,
            "call_limit": 10

        },
        {
            "id": 3,
            "number": "05712620039",
            "name": "udesk号码 ·",
            "memo": "测试·",
            "type": null,
            "province": null,
            "supplier": null,
            "pstn": null,
            "call_limit": 10

        }
    ],
    "meta": {
        "current_page": 1,
        "total_pages": 1,
        "total_records": 3
    }
}

获取客服呼叫中心状态

该接口用于获取客服的呼叫中心状态

请求方法

GET /callcenter/agent_state

请求参数

参数名	必填	类型	说明
agent_email	是	字符串	客服邮箱

返回结果

属性名	类型	说明
code	整型	执行结果码，1000代表成功
agent_work_state	字符串	客服在线状态取值说明
agent_call_state	字符串	客服通话状态取值说明
agent_work_state_des	字符串	客服通话状态中文说明

示例

curl https://demo.udesk.cn/open_api_v1/callcenter/agent_state?agent_email=agent@udesk.cn&email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2

返回结果

{
    "agent_work_state": "resting",
    "agent_call_state": "ring",
    "agent_work_state_des": "午休",
    "code": 1000
}

设置客服呼叫中心状态

该接口用于设置客服的呼叫中心状态

请求方法

POST /callcenter/agent_state

请求参数

参数名	必填	类型	说明
agent_email	是	字符串	客服邮箱
agent_work_state	是	字符串	客服在线状态取值说明

返回结果

属性名	类型	说明
code	整型	执行结果码，1000代表成功

示例

curl https://demo.udesk.cn/open_api_v1/callcenter/agent_state?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
 \
-X POST \
-H 'content-type: application/json' \
-d '{
"agent_email": "agent@udesk.cn",
"agent_work_state": "idle"
}'

返回结果

{
    "code": 1000
}

数据结构-中继号

属性	说明	示例	类型
id	号码id	1	整型
number	号码	'01086465044'	字符串
name	号码名称	'udesk号码'	字符串
memo	号码备注	'这是测试号码'	字符串
type	号码类型	"udesk"	字符串
province	归属地	"北京"	字符串
supplier	供应商	"udesk"	字符串
pstn	运营商	"cmcc"	字符串
call_limit	并发数	100	整型

pstn取值说明

取值	中文名称
cmcc	中国移动
unicom	中国联通
telecom	中国电信

type取值说明

取值	中文名称
udesk	udesk号码
no_udesk	非udesk号码

agent_work_state取值说明

取值	中文名称
offline	离线
idle	空闲
busy	忙碌
resting	小休
neaten	整理
自定义小休状态码	坐席是自定义小休时返回的小休的状态码

agent_call_state取值说明

取值	中文名称
off	未通话
ring	振铃中
in	通话中

code错误码说明

错误码	message信息	exception:message信息	描述
2009	该公司未开通呼叫中心	无	此公司未开通呼叫中心业务模块
5006	当前呼叫中心系统不支持获取中继号	无	当前呼叫中心系统不支持获取中继号，请联系技术支持
14500	请先开通呼叫中心	无	此公司未开启呼叫中心业务
14501	请先开通智能路由	无	此公司未开启智能路由业务
14502	请先开通网页回呼功能	无	此公司未开启网页回呼功能
14503	主叫号码不能为空	无	必填参数{from_number}未填写或为空值
14504	被叫号码不能为空	无	必填参数{to_number}未填写或为空值
14505	被叫号码不是当前公司的中继号码，请核对数据	同message	，参数{to_number}错误
22001	存在不合法邮箱	无	必填参数{agent_email}未填写或值错误
50046	未知的客服工作状态(正常工作状态为offline, idle, busy, resting, neaten)	无	参数{agent_work_state}的值不在取值范围内
206201	参数page不合法	无	参数{page}格式错误或超出取值范围
206202	参数per_page不合法	无	参数{per_page}格式错误或超出取值范围
501019	公司自定义休息状态未开启	无	此公司未开启自定义休息状态功能（关联参数variables）

获取通话记录列表

该接口用于一次获取多个通话记录信息

请求方法

GET /callcenter/calllogs

请求参数（Query String）

参数名	必填	说明
start_time	是	查询开始时间
end_time	否	查询结束时间
customer_phone	否	客户电话号码
page	否	页码，从1开始，默认为1
page_size	否	每页数量，默认30，最大100

start_time 和 end_time 的格式为：“YYYY-MM-DD hh:mm:ss”，也可省略时间部分：“YYYY-MM-DD”。
start_time 参数必须提供，否则会返回空数据，另外时间获取记录时间跨度限制为30天以下。

返回数据

属性名	类型	说明
status	整型	执行结果码，0代表成功
message	字符串	执行结果说明
size	整型	本次返回数量
total	整型	数据总数
total_pages	整型	数据总页数
items	数组	通话记录数组

item 元素的数据结构

属性名	类型	说明
id	整型	唯一标识
note_id	整型	业务记录id
call_start_at	日期时间	通话开始时间
call_type	字符串	通话类型(“呼入”,“呼出”)
call_number	字符串	主叫号码
mobile_area	字符串	号码归属地
trunk_number	字符串	中继号
user_name	字符串	客户姓名
user_id	整型	客户id
call_source	字符串	通话来源(“客服: xx”、“队列: xx”、“负责人: xx”、“未选择队列”)
queue_type	字符串	排队状态(“排队成功”、“放弃排队”、“排队超时”、“无客服在线”)
queue_time	整型	排队时间
agent_id	整型	客服ID
agent_nick_name	字符串	客服姓名
agent_email	字符串	客服邮箱
device_info	字符串	设备状态(“ip座机”、“手机”)
call_result	字符串	通话结果(“客户未接”、“客户接听”、“客服未接”、“客服拒接”、“客服接听”、“未选择队列”)
ring_time	整型	振铃时间
drop_side	字符串	挂断方，“客户”、“客服”
call_time	整型	通话时间
record_url	字符串	录音文件地址
leave_message	字符串	留言
organization_id	字符串	客户所属公司id
satisfaction	字符串	满意度评价，“满意”、“不满意”、“未评价”或“无需评价” （仅支持快速路由的默认满意度评价，请尽量使用survey字段）
survey	字符串	满意度评价（新的满意度评价字段，支持智能路由的自定义满意度评价，且兼容快速路由的默认满意度评价）
ivr_time	整型	ivr时长
has_subsequent_call	boolean	后续通话情况（true, false, null)
queue_overflow	字符串	溢出队列
ad_task_name	字符串	自动外呼任务名称
ivr_variables	字符串	ivr变量
defeat_cause	字符串	外呼失败原因（开通后显示）
outline_phone_number	字符串	外线号码
multi_ring_count	整型	顺振次数
tickets	字符串数组	工单编号
has_subsequent_call	boolean	后续通话
outline_phone_number	字符串	外线号码
call_id	字符串	通话唯一标识

示例

curl https://demo.udesk.cn/open_api_v1/callcenter/calllogs?timestamp=1644891490&sign=872bfa7b074e7cfdafaa75ae10b07aacb6a35123&nonce=c02f0bff-ea00-4d1c-ab0a-7c8bd4a3e456&sign_version=v2&page=1&per_page=20&email=XXXXX@udesk.cn&start_time=2022-02-01&end_time=2022-02-14&customer_phone=15212345678

注： curl请求，url里的空格用%20替换

{
    "code": 1000,
    "message": "成功",
    "items": [
        {
            "id": 70295,
            "note_id": null,
            "call_start_at": "2022-02-07 09:35:42",
            "call_type": "呼出",
            "call_number": "15212345678",
            "mobile_area": null,
            "trunk_number": "Cat中继号 043262201234",
            "user_name": null,
            "user_id": null,
            "call_source": null,
            "queue_type": null,
            "queue_time": null,
            "agent_id": 19,
            "agent_nick_name": "cc-cat",
            "agent_email": "XXX@cat.cn",
            "device_info": "网页电话",
            "call_result": "客户未接",
            "ring_time": 20,
            "drop_side": "客服",
            "call_time": 0,
            "record_url": null,
            "leave_message": "否",
            "satisfaction": "无需评价",
            "survey": "无需评价",
            "organization_id": null,
            "ivr_time": null,
            "queue_overflow": "无溢出",
            "ad_task_name": null,
            "ivr_variables": null,
            "defeat_cause": null,
            "tickets": [],
            "multi_ring_count": 0,
            "has_subsequent_call": null,
            "outline_phone_number": null,
            "call_id": "0dde52ed-8261-4b59-9cad-1b3e8591XXXX",
            "dtmf": null,
            "callout_task_id": [],
            "callout_task_name": []
        }
    ],
    "size": 1,
    "total": 1,
    "total_pages": 1
}

获取通话记录详情

该接口用于通过call_id获取通话记录详情

请求方法

GET /callcenter/call_log

请求参数（Query String）

参数名	必填	说明
call_id	否	通话记录id
conversation_id	否	会话id

call_id 和 conversation_id 至少传入一个且不可为空，同时传入conversation_id优先级更高

该接口的鉴权方法与官网其他OpenAPI一致，参看鉴权方法

返回数据

属性名	类型	说明
code	整型	执行结果码，1000代表成功
message	字符串	执行结果说明
call_log	数组	通话记录信息

call_log的数据结构

属性名	类型	说明
id	整型	唯一标识
note_id	整型	业务记录id
call_start_at	日期时间	通话开始时间
call_type	字符串	通话类型(“呼入”,“呼出”)
call_number	字符串	主叫号码
mobile_area	字符串	号码归属地
trunk_number	字符串	中继号
user_name	字符串	客户姓名
user_id	整型	客户id
call_source	字符串	通话来源(“客服: xx”、“队列: xx”、“负责人: xx”、“未选择队列”)
queue_type	字符串	排队状态(“排队成功”、“放弃排队”、“排队超时”、“无客服在线”)
queue_time	整型	排队时间
agent_id	整型	客服ID
agent_nick_name	字符串	客服姓名
agent_email	字符串	客服邮箱
device_info	字符串	设备状态(“ip座机”、“手机”)
call_result	字符串	通话结果(“客户未接”、“客户接听”、“客服未接”、“客服拒接”、“客服接听”、“未选择队列”)
ring_time	整型	振铃时间
drop_side	字符串	挂断方，“客户”、“客服”
call_time	整型	通话时间
record_url	字符串	录音文件地址
leave_message	字符串	留言
organization_id	字符串	客户所属公司id
satisfaction	字符串	满意度评价，“满意”、“不满意”、“未评价”或“无需评价” （仅支持快速路由的默认满意度评价，请尽量使用survey字段）
survey	字符串	满意度评价（新的满意度评价字段，支持智能路由的自定义满意度评价，且兼容快速路由的默认满意度评价）
ivr_time	整型	ivr时长
has_subsequent_call	boolean	后续通话情况（true, false, null)
queue_overflow	字符串	溢出队列
ad_task_name	字符串	自动外呼任务名称
ivr_variables	字符串	ivr变量
defeat_cause	字符串	外呼失败原因（开通后显示）
outline_phone_number	字符串	外线号码
multi_ring_count	整型	顺振次数
tickets	字符串数组	工单编号
has_subsequent_call	boolean	后续通话
outline_phone_number	字符串	外线号码
call_id	字符串	通话唯一标识
### 示例

curl 'http://kunapp.cat.tryudesk.com/open_api_v1/callcenter/call_log?timestamp=1672917025&sign=6f7bb081e31431efd4c7f37a9a7fb33b0fd6b791&nonce=0.80705304386402&sign_version=v2&email=XXXXX@udesk.cn&call_id=c9b00273-f2ec-4718-8d3b-f65f6536d7e6&conversation_id=76688'

注： curl请求，url里的空格用%20替换

{
    "code": 1000,
    "message": "SUCCESS",
    "call_logs": [
        {
            "id": 76688,
            "note_id": null,
            "call_start_at": "2022-11-09 10:17:36",
            "call_type": "呼入（三方）",
            "call_number": "01056195632",
            "mobile_area": "北京 北京",
            "trunk_number": "Cat中继号 043262205149",
            "user_name": "ce1ec4b939a54714",
            "user_id": 26865,
            "call_source": "客服：Testerkun",
            "queue_type": null,
            "queue_time": 6,
            "agent_id": 1917,
            "agent_nick_name": "下划线1",
            "agent_email": "xiahua_xian@udesk.cn",
            "device_info": "手机",
            "call_result": "客服接听",
            "ring_time": 7,
            "drop_side": "客服",
            "call_time": 7,
            "record_url": "https://pro-ccrecords.kefutoutiao.com//3c31d817-4d37-46d8-6c09-1be54dda3c03/cc_recordings/20221109101736_c9b00273-f2ec-4718-8d3b-f65f6536d7e6_04295577-94ef-42b6-9f05-49e6fe8247cb.wav?OSSAccessKeyId=bPexlr6MCcadDhfu&Expires=1673003425&Signature=5ZNp5Op8kiInPje8zN%2FEcFjUgRI%3D",
            "leave_message": "否",
            "satisfaction": "未评价",
            "survey": "已评价；新满意度 -不满意",
            "organization_id": null,
            "ivr_time": 217,
            "queue_overflow": "无溢出",
            "ad_task_name": null,
            "ivr_variables": "name:我的名字是是活动ID会死的第三的,safe:跨境电商看见啥开户费ueuueue",
            "defeat_cause": null,
            "tickets": [],
            "multi_ring_count": 0,
            "has_subsequent_call": null,
            "outline_phone_number": null,
            "call_id": "c9b00273-f2ec-4718-8d3b-f65f6536d7e6",
            "dtmf": null,
            "callout_task_id": [],
            "callout_task_name": []
        }
    ]
}

Keys	Action
`?`	Open this help
`n`	Next page
`p`	Previous page
`s`	Search

发起网页回呼接口

请求方法

请求参数

返回结果

示例

获取呼叫中心中继号列表

请求方法

请求参数

返回结果

示例

获取客服呼叫中心状态

请求方法

返回结果

示例

返回结果

设置客服呼叫中心状态

请求方法

返回结果

示例

返回结果

数据结构-中继号

pstn取值说明

type取值说明

agent_work_state取值说明

agent_call_state取值说明

code错误码说明

获取通话记录列表

请求方法

请求参数（Query String）

返回数据

item 元素的数据结构

示例

返回

获取通话记录详情

请求方法

请求参数（Query String）

返回数据

返回

文档反馈