# 普通外呼
#### 前置条件
- 座席已签入
- 座席当前无正在接听的呼叫（不包括保持后的呼叫）
- 如果您需要使用单向视频能力来指定用户视频方向，如用户只接收视频不发送视频、用户只发送视频不接收视频，请登录UAP9600的客户端CDE执行下面MML命令修改参数。
  1. 查询软参**P978** 的**比特位** 、**比特位值** 是否都为**0** 。
     ```
     LST SFP: ID=P978;
     ```
     
  
  2. 若不是执行如下命令修改。
     ```
     MOD SFP: ID=P978, MODTYPE=P1, BIT=0, BITVAL=0;
     ```
     
   
 
#### 场景描述
座席登录以后通过外呼接口呼叫外呼用户。
#### 接口方法
设置成"PUT"。该接口仅支持PUT方法，不支持POST、GET和DELETE等方法。
#### 接口URI
https://ip:port/agentgateway/resource/voicecall/{agentid}/callout
![](https://support.huaweicloud.com/api-ccfs-cec/public_sys-resources/note_3.0-zh-cn.png)
如果CC-Gateway单机部署，IP地址为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号，默认值为8043；如果CC-Gateway采用集群模式部署，IP请配置为NSLB地址， Port请配置为默认值8043。
NSLB上的CC-Gateway端口号，请以nslb用户登录任意一个NSLB节点，执行./nslbctl l查询，查询结果中，如下端口表示CC-Gateway通过NSLB面向第三方系统开放的端口。
![](https://support.huaweicloud.com/api-ccfs-cec/figure/zh-cn_image_0000002204207349.png)
SaaS场景下请咨询运维人员获取IP和Port。
表1URI中携带的参数说明 
| 序号 | 参数名     | 数据类型   | 选取原则 | 说明                     |
|:---|:---|:---|:---|:---|
| 1  | agentid | string | True | 座席的工号，取值范围：101～999999。 |
   
#### 日志中的方法名
callout
#### 请求说明
- 消息头
  表2请求头参数说明 
  | 序号 | 名称           | 参数类型   | 是否必选 | 说明                                                             |
  |:---|:---|:---|:---|:---|
  | 1  | Content-Type | string | True | 消息主体编码方式，缺省值：application/json; charset=UTF-8                   |
  | 2  | Guid         | string | True | 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。 |
     
  

- 消息体
  表3消息体参数说明 
  | 序号 | 名称                 | 参数类型   | 是否必选  | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
  |:---|:---|:---|:---|:---|
  | 1  | caller             | string | False | 主叫号码。内容可为空，为空时为平台默认主叫号码，0-24位数字 说明： 座席具有不可填写外呼主叫权限时，此字段不生效。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
  | 2  | called             | string | True  | 被叫号码。内容不可为空，1-24位数字或\*或#                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
  | 3  | skillid            | int    | False | 技能ID。数字类型，内容可为空，为空时为平台配置默认的技能队列ID。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
  | 4  | callappdata        | string | False | 随路数据信息。可为空，最大长度为16k。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
  | 5  | mediaability       | int    | False | 媒体能力，默认为0。0：音频，1：视频，2：以最大能力呼叫，由主机与终端进行协商。 说明： 视频呼音频，接听后会导致通话直接挂断，原因是媒体协商失败，推荐视频外呼时，mediaability配置为2，以最大能力呼叫。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
  | 6  | userVideoDirection | int    | False | 用户视频方向。取值范围： - 1：用户只接收视频不发送视频  - 2：用户只发送视频不接收视频  - 3：用户既发送也接收视频  - 4：不设置接收发送方向   缺省值：4。 说明： 仅在mediaability配置为1时，可使用该参数。 |
  | 7  | uuiData            | string | False | IE数据，可为空，最大字节数不超过2048 说明： OpenEye限制为1004                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
     
  
 
#### 响应说明
表4消息体参数说明 
| 序号 | 名称      | 参数类型   | 说明                                                                                                                                                                                                                           |
|:---|:---|:---|:---|
| 1  | message | string | 描述                                                                                                                                                                                                                           |
| 2  | retcode | string | 错误码。取值如下： 0：成功 非0：失败 |
| 3  | result  | string | 呼叫成功后，返回呼叫唯一标识callid。 呼叫失败不返回该项。                                                                                         |
   
#### 触发事件
- 物理话机振铃（AgentOther_PhoneAlerting）
- 物理话机摘机（AgentOther_PhoneOffhook）
- 座席忙中（AgentState_Busy）
- 对方振铃（AgentEvent_Customer_Alerting）
- 座席进入Talking（AgentEvent_Talking）
- 外呼失败（AgentEvent_Call_Out_Fail）
- 外呼失败检测失败原因事件（OUTBOUND_DETECT_EVENT）
![](https://support.huaweicloud.com/api-ccfs-cec/public_sys-resources/note_3.0-zh-cn.png)
若"Web配置台 \> 系统配置 \> 高级参数 \> 软参"中设置了参数"P18"为1时（默认为0），座席外呼流程会先将座席状态变为工作态，再拉座席话机。当外呼座席占用失败（座席状态没有变为工作态），系统将直接返回外呼失败，不再拉起座席话机，此时不会触发以下事件：
- 物理话机振铃（AgentOther_PhoneAlerting）
- 物理话机摘机（AgentOther_PhoneOffhook）
 
#### 错误结果码
- 000-002
- 100-006
- 100-007
- 200-001
 
#### 报文样例
- 消息头
  ```
  Content-Type:application/json; charset=UTF-8
  Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
  ```
  
- 请求参数
  ```
  {
      "caller": "40038",
      "called": "40040",
      "skillid": 25,
      "callappdata": "",
      "mediaability": 1,
      "userVideoDirection": 4
  }
  ```
  
- 响应参数
  ```
  {
      "message": "",
      "retcode": "0",
      "result": "1455885056-1095"
  }
  ```