发起网页回呼接口

该接口用于发起网页回呼,先呼客户,再呼客服(视为呼入)

请求方法

POST /callcenter/web_callback

请求参数


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

返回结果

属性名 类型 说明
code 整型 执行结果码
1000 # 代表成功
14500 # 请先开通呼叫中心
14501 # 请先开通智能路由
14502 # 请先开通网页回呼功能
14503 # 主叫号码不能为空
14504 # 被叫号码不能为空
14505 # 被叫号码不是当前公司的中继号码,请核对数据

示例

https://demo.udesk.cn/open_api_v1/callcenter/web_callback?f&t&email=admin@udesk.cn&timestamp=1525774685&sign=cf3c6f55893531267763db4948f78c754809d318
-X POST \
-H 'content-type:application/json' \
-d '
{
    "from_number": "13888888888",
    "to_number": "021123456",
    "variables": {
          "key1": 123,
          "key2": "13200000000"
    }

}‘

返回

{
    "code": 1000
}

获取呼叫中心中继号列表

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

请求方法

POST /callcenter/callout_number_list

请求参数


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

返回结果

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

示例

https://demo.udesk.cn/open_api_v1/callcenter/callout_number_list?email=admin@udesk.cn&timestamp=1525774685&sign=cf3c6f55893531267763db4948f78c754809d318

返回

{
    "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 字符串 客服通话状态取值说明

示例

curl -X GET \
https://demo.udesk.cn/open_api_v1/callcenter/agent_state?agent_email=agent@udesk.cn&email=admin@udesk.cn&timestamp=1525774685&sign=cf3c6f55893531267763db4948f78c754809d318

返回结果

{
    "code": 1000,
    "agent_work_state": "idle",
    "agent_call_state": "off"
}

设置客服呼叫中心状态

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

请求方法

POST /callcenter/agent_state

请求参数

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

返回结果

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

示例

curl  -X POST \
https://demo.udesk.cn/open_api_v1/callcenter/agent_state?email=admin@udesk.cn&timestamp=1494474404&sign=2f4c2c3d0b4c24cfa4feca76e237da0c368a00d8 \
-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 通话中