注意，本接口是固话外呼，如需小号外呼，请查看小号外呼接口七陌云小号接口
1 接口概述
第三方系统需要发送接口请求来调用平台外呼功能，通过此接口可以在用户自己系统中实现点击外呼的功能。
2 接口请求
-
HTTP请求方式：POST
-
请求url：{HOST}/v20180426/call/dialout/{ACCOUNTID}?sig={SIG}
-
请求时请将{HOST}换成对接数据查询中获取到的请求域名，{ACCOUNTID}替换为账户编号，{SIG}是根据鉴权规则生成的，请看鉴权文档，查看具体的生成规则
-
鉴权方式：接口鉴权
3 接口参数
| 参数名 | 是否必填 | 值 | 参数释义 |
|---|---|---|---|
| FromExten | 是 | 坐席工号 | 例：假设8001@gs是坐席登陆账号，8001才是坐席工号 |
| Exten | 是 | 被叫号码 | 被叫号码；对于手机号，系统会自动判断是否本地号码，从而自动在号码前加0，使用者不需要处理，只需传手机号即可，如138*。对于固话，如果是外地号码使用者需要将区号带上，如010* |
| ExtenType | 是 | Local/sip/gateway | 外呼时强制坐席使用该接听方式进行外呼。Local为“手机”,”gateway为“语音网关” |
| ActionID | 否 | 唯一字符串（可随机） | 随机码，用户用来标识请求的操作，服务器返回的Response中会带有对应Action的ActionID；在通话事件中会带有该字段；该字段最大长度是40个字节 |
| DialoutStrVar | 否 | 外呼自定义参数 | 用户可在此字段中自定义参数，在事件推送中会推送该字段，支持推送ison格式(需要转义)的参数如DialoutStrVar={"name":"John"}若自定义字段的值有中文，需要先 UrlEncode编码后在赋值 |
| OutShow | 否 | 指定外呼外显号码 | 注意：此号码必须为账号线路配置里的真实号码。最新的通话服务器才支持该功能，如果需使用此功能可提前找群内对接技术确认。 |
4 系统返回
返回Json对象，样例：
{
"Response": "Dialout",
"ActionID": "34534jh9i23",
"Succeed": false,
"Message": "401PBXnotfound"
}
返回值字段说明:
| 字段名称 | 值 | 说明 |
| Response | Dialout | 对应Action的名称 |
| ActionID | 唯一字符串 | 对应操作的唯一标记 |
| Succeed | 处理结果 | 请求是否成功，当不成功时会在Message字段中给出原因 |
| Message | 结果说明 |
400 Error action：请求有误，请检查传递的参数是否合法 401 PBX not found：账户配置问题 402 Agent mobile not found：坐席未绑定手机号，请检查对应手机号是否存在 403 Not allowed：用户账户或验证码无效或过期，请技术支持修改账户属性，允许这个账户使用外呼接口 403 forbbiden：鉴权失败 404 Agent not found：坐席未找到，请检查FromExten字段中的坐席分机号是否传递正确 407 Agent can not take call 坐席无法接听电话（坐席没有登录），可通过传ExtenType解决该问题 408 Agent Busy：坐席忙碌，无法接听（坐席已经有一通电话在进行中）。如果是话机方式（gateway）,可能是话机掉注册了，请检查一下话机状态 409 Agent extenType not available：调用者指定的接听方式，不可用。可能原因：软电话未登陆，网关未绑定或未注册，未绑定手机号 500 Server error：服务器错误 user sip number of current login type：对应接听方式不可用，可能原因：软电话未登陆，网关未绑定或未注册，未绑定手机号 |