外呼任务接口 - 容联七陌|开发者中心

注意，本接口的使用需要进行接口鉴权

CallCenter外呼任务接口对接

外呼任务接口简介：提供查询未完成外呼任务的能力，并能够通过接口导入外呼任务数据

1.查询未完成外呼任务接口
2.查询所有外呼任务接口
3.外呼任务导入数据接口
4.创建外呼任务接口
5.删除外呼任务接口

1.查询未完成外呼任务接口

HTTP请求方式：POST
请求地址：{HOST}/v20170704/dianxiao/queryOutboundTask/{ACCOUNTID}?sig={sig}
请求时请将{HOST}换成对接数据查询中获取到的请求域名，{ACCOUNTID}替换为账户编号，{SIG}是根据鉴权规则生成的，请看鉴权文档，查看具体的生成规则
鉴权文档：接口鉴权
请求示例:

http://apis.7moor.com/v20170704/dianxiao/queryOutboundTask/account?sig=xxx=41276A8E7767352A0FE7456D20F03D3

返回值：

返回值	含义
success	是否请求成功
message	响应信息
data	返回的数据，json格式
taskName	外呼任务名字
taskId	外呼任务id
memo	外呼任务描述
phoneTotal	外呼任务号码总数
agentsNum	外呼任务参与座席个数
createTime	外呼任务创建时间
source	外呼任务用户数据来源
lastTime	外呼任务最后更新时间
status	任务状态
assignStrategy	分配策略
questionnaire	调查问卷ID
questionnaireName	调查问卷名称

返回成功示例:

{
      "message": "there are dealing task",
      "success": true,
      "data": [
        {
          "taskName": "20171129_b",
          "taskId": "9e656890-d4b3-11e7-82ff-cbd9805b4059",
          "memo": "",
          "phoneTotal": 5,
          "agentsNum": 1,
          "createTime": "2017-11-29 11:15:57",
          "lastTime": "2017-11-29 12:02:04",
          "source": "网络",
          "status": "close",
          "assignStrategy": "manual",
          "questionnaire": "2421309c-956d-11ee-8d97-0cdd24f76926",
          "questionnaireName": "调查问卷"
        }
      ]
}

2.查询所有外呼任务接口

HTTP请求方式：POST
请求地址：{HOST}/v20170704/dianxiao/queryAllOutboundTask/{ACCOUNTID}?sig={sig}
请求时请将{HOST}换成对接数据查询中获取到的请求域名，{ACCOUNTID}替换为账户编号，{SIG}是根据鉴权规则生成的，请看鉴权文档，查看具体的生成规则
鉴权文档：接口鉴权
请求示例:

http://apis.7moor.com/v20170704/dianxiao/queryAllOutboundTask/account?sig=xxx=41276A8E7767352A0FE7456D20F03D3

请求体:


{
"status": "close"
}

请求体字段解说明：

status：dealing 进行中，close已关闭，archive已归档，如果传{} 表示获取所有状态的任务

返回值：

返回值	含义
success	是否请求成功
message	响应信息
data	返回的数据，json格式
taskName	外呼任务名字
taskId	外呼任务id
memo	外呼任务描述
phoneTotal	外呼任务号码总数
agentsNum	外呼任务参与座席个数
createTime	外呼任务创建时间
source	外呼任务用户数据来源
lastTime	外呼任务最后更新时间
status	任务状态
assignStrategy	分配策略
questionnaire	调查问卷ID
questionnaireName	调查问卷名称

返回成功示例:

{
      "message": "there are dealing task",
      "success": true,
      "data": [
        {
          "taskName": "20171129_b",
          "taskId": "9e656890-d4b3-11e7-82ff-cbd9805b4059",
          "memo": "",
          "phoneTotal": 5,
          "agentsNum": 1,
          "createTime": "2017-11-29 11:15:57",
          "lastTime": "2017-11-29 12:02:04",
          "source": "网络",
          "status": "close",
          "assignStrategy": "manual",
          "questionnaire": "2421309c-956d-11ee-8d97-0cdd24f76926",
          "questionnaireName": "调查问卷"
        }
      ]
}

3.外呼任务导入数据接口

HTTP请求方式：POST
请求地址：{HOST}/v20170704/dianxiao/insertOutboundTaskData/{ACCOUNTID}?sig={sig}
请求时请将{HOST}换成对接数据查询中获取到的请求域名，{ACCOUNTID}替换为账户编号，{SIG}是根据鉴权规则生成的，请看鉴权文档，查看具体的生成规则
鉴权文档：接口鉴权
请求示例:

https://apis.7moor.com/v20170704/dianxiao/insertOutboundTaskData/N00000000013
?sig=41276A8E7767352A0FE7456D20F03D3

请求体:

{
    "exten" : "8002",
    "isPhone" : "plan",
    "taskId" : "c371dbe0-c938-11e7-9bd0-a35d26d86723",
    "numbers" : [
        {
            "phone":"15210105523",
            "name" :"容联七陌",
            "title" :"test1"
        },
        {
            "phone":"13785127283",
            "name" :"容联七陌",
            "title" :"test2",
        }
    ]
}

请求体字段解说明：

字段	类型	是否必须	备注
exten	String	是	坐席号，创建本次导入号码任务的坐席
isPhone	String	是	号码晒重方式：global（全局，包括所有的任务、用户数据），allPlan（所有任务，所有未归档的任务），plan（当前任务，当前操作的任务），no(不筛重)
taskId	String	是	任务ID
numbers	List	是	导入的数据，此值类型为List，长度不得超过10000，单位元素结构为 {phone:xxx，name:xxx，title:xxx} phone ----联系电话 name ----用户名称 title ----描述

返回值：

外呼任务导入号码成功返回示例:

{
    "success": true,
    "code": 200,
    "message": "200 OK"
}

外呼任务导入号码失败返回示例:

{
    "success": false,
    "message": "please check your parametes!",
    "code": 400
}

4.创建外呼任务接口

HTTP请求方式：POST
请求地址：{HOST}/v20180426/call/saveCustTaskApi/{ACCOUNTID}?sig={sig}
请求时请将{HOST}换成对接数据查询中获取到的请求域名，{ACCOUNTID}替换为账户编号，{SIG}是根据鉴权规则生成的，请看鉴权文档，查看具体的生成规则
鉴权文档：接口鉴权
请求示例:

https://apis.7moor.com/v20180426/call/saveCustTaskApi/N00000000013
?sig=41276A8E7767352A0FE7456D20F03D3

请求体:

{
      "createUser":"2999",
      "taskName": "task00111",
      "memo": "示例",
      "effective": 30,
      "pattern": "1",
      "workload": 30,
      "agentsNum": [ "8001" ],
      "assignStrategy": "manual",
      "questionnaireName": "调查问卷"
}

请求体字段解说明：

字段	类型	是否必须	备注
createUser	String	否	创建人坐席工号
taskName	String	是	任务名称
memo	String	是	描述非必填
effective	number	是	有效通话时长
pattern	String	是	基础任务量 1：有效通话数；2：有效通话时长
workload	number	是	具体数值，所有坐席默认值
agentsNum	array	是	坐席工号，必填，至少一个，不传报错
assignStrategy	String	否	客户号码分配策略(电销暂不支持), manual: 手动分配; average: 平均分配。空或不传表示无分配策略（默认）
questionnaireName	String	否	调查问卷名称(电销暂不支持), 填写后任务将与对应的问卷进行关联

返回值：

外呼任务创建成功返回示例:

{
    "success": true,
    "taskID": "6b381f10-c90d-11eb-b958-3b03bb346fd3",
    "message": "200 ok!"
}

外呼任务创建失败返回示例:

{
    "success": false,
    "message": "任务名称已存在，请重新输入"
}

5.删除外呼任务接口

HTTP请求方式：POST
请求地址：{HOST}/v20210827/outboundTask/delete/{ACCOUNTID}?sig={sig}
请求时请将{HOST}换成对接数据查询中获取到的请求域名，{ACCOUNTID}替换为账户编号，{SIG}是根据鉴权规则生成的，请看鉴权文档，查看具体的生成规则
请求频次：20次/分钟
鉴权文档：接口鉴权
请求示例：

https://apis.7moor.com/v20210827/outboundTask/delete/N0000000xxx?sig=41276A8E7767352A0FE7456D20F03D3

请求体：

{
      "taskIds": ["f623b2f0-21d8-4bb0..."]
}

请求体字段解说明：

字段	类型	是否必须	备注
taskIds	[]	是	外呼任务ID数组

返回示例：

{
      "success": true,
      "code": 200
}

返回字段说明：

字段	类型	描述
code	number	响应码
success	boolean	成功与否的标识
message	string	提示信息

code响应码说明：

代码	含义
200	请求成功
400	请求参数错误
403	鉴权参数错误或接口访问频次达到上限
500	服务器错误