帮助中心首页
开发者文档

云呼叫中心开放接口

外呼通话接口

接口调用说明

获取token --> 坐席上线 --> 设置坐席状态 --> 查询坐席状态 --> 外呼 --> 坐席下线。

每次外呼前需要查询坐席状态，状态仅为就绪（1）可以外呼。

token在saas平台保存12小时，连续使用超过12小时需要再次更新token。

获取token编码

接口说明：

获取外呼token令牌，用于后续所有接口的访问，同一账号不允许同时登录，账号互踢。

访问方式 GET：

http://www.sobot.com/call-open/getAccessToken/4?companyId={companyId}&email={email}

请求参数：

参数名	类型	必填	说明
companyId	字符串	是	对接方在智齿的企业id
email	字符串	是	登陆saas平台的坐席账号（全局唯一）

返回数据：

参数名	类型	说明
code	字符串	执行结果码，1000代表成功。
data	字符串	token编码

返回示例：

{
    "code": "1000" ，
    "data": ""
}

呼叫坐席上线

接口说明：

访问方式 GET：

http://www.sobot.com/call-open/agentLogin/4?callWay=2&token={token}

请求参数：

参数名	类型	必填	说明
callWay	字符串	是	登录使用方式：1、网页电话2、sip 3、手机
token	字符串	是	token令牌编码

返回数据：

参数名	类型	说明
code	字符串	执行结果码，1000代表成功。
data	对象	详见下文

返回data：

参数名	类型	说明
retCode	字符串	返回编码
retMsg	字符串	返回信息
items	对象数组	空

返回示例：

{
    "data": {
        "items": [],
        "retCode": "000000",
        "retMsg": "操作成功！"
    },
    "code": "1000"
}

设置呼叫坐席状态

访问方式 GET：

http://www.sobot.com/call-open/setAgentStatus/4?agentSatus=1&token={token}

请求参数：

参数名	类型	必填	说明
agentSatus	字符串	是	坐席状态1就绪（只有此状态可以外呼）
token	字符串	是	token令牌编码

返回数据：

参数名	类型	说明
code	字符串	执行结果码，1000代表成功。
data	对象	详见下文

返回data：

参数名	类型	说明
retCode	字符串	返回编码
retMsg	字符串	返回信息
items	对象数组	空

返回示例：

{
    "data": {
        "items": [],
        "retCode": "000000",
        "retMsg": "操作成功！"
    },
    "code": "1000"
}

查询呼叫坐席状态

访问方式 GET：

http://www.sobot.com/call-open/getAgentStatus/4?token={token}

请求参数：

参数名	类型	必填	说明
token	字符串	是	token令牌编码

返回数据：

参数名	类型	说明
code	字符串	执行结果码，1000代表成功。
data	对象	详见下文

返回data：

参数名	类型	说明
retCode	字符串	返回编码
items	对象数组	空

返回示例：

{
    "code": "1000",
    "data": {
        "item": {
            "agentStatus": "1",
            "callInPop": "open",
            "callOutPop": "open",
            "callWay": "2",
            "callout": "0",
            "direction": "",
            "hold": "false",
            "mbTrsfStatus": "",
            "time": "1505807338000",
            "transfer": "0",
            "trsfFlag": "",
            "trsferStatus": "",
            "userPhone": "",
            "userhangup": "0"
        },
        "items": [],
        "retCode": "000000"
    }
}

呼叫坐席外呼

访问方式 GET：

http://www.sobot.com/call-open/agentCallOut/4?callWay=2&token={token}&calleeNumber={calleeNumber}&agentSatus=1&hiddenFlag=0

请求参数：

参数名	类型	必填	说明
callWay	字符串	是	登录方式，1、网页电话2、sip 3、手机
token	字符串	是	token
calleeNumber	字符串	是	外呼号码
agentSatus	字符串	是	1
hiddenFlag	整型	是	0

返回数据：

参数名	类型	说明
code	字符串	执行结果码，1000代表成功。
data	对象	详见下文

返回data：

参数名	类型	说明
retCode	字符串	返回编码
items	对象数组	空

返回示例：

{
    "data": {
        "items": [],
        "retCode": "000000",
        "retMsg": "操作成功！"
    },
    "code": "1000"
}

呼叫坐席下线

访问方式 GET：

http://www.sobot.com/call-open/agentLoginOut/4?callWay=2&token={token}

请求参数：

参数名	类型	必填	说明
callWay	字符串	是	登录方式，1、网页电话2、sip 3、手机
token	字符串	是	token

返回数据：

参数名	类型	说明
code	字符串	执行结果码，1000代表成功。
data	对象	详见下文

返回data：

参数名	类型	说明
retCode	字符串	返回编码
items	对象数组	空

返回示例：

{
    "data": {
        "items": [],
        "retCode": "000000",
        "retMsg": "操作成功！"
    },
    "code": "1000"
}