华为云用户手册

状态码说明 系统返回信息中的状态码为200，为正常业务信息返回。其他状态码，为异常信息返回。 表1 状态码参数说明 状态码 中文描述 说明 200 正常业务信息返回。 具体信息请查看上述接口。 401 越权或未授权访问接口。 请参考接口的鉴权算法和表2，检查鉴权字符串和请求参数是否有误。如果有疑问，联系管理员。 403 Ip被锁定。在一段时间内，请求携带的鉴权字符串信息错误次数超过允许错误的最大次数。 请参考接口的鉴权算法和表2，检查鉴权字符串和请求参数是否有误。如果有疑问，联系管理员。 表2 异常状态码参数说明 参数名称 是否必选 参数类型 说明 timestamp 是 Long 时间戳。如：1532142010247 status 是 int 状态码。如：401，403 error 是 String 错误类型。如：Forbidden表示禁止，Unauthorized表示越权/未授权 message 是 String 提示信息。如：No message available path 是 String 请求路径。如：/CCFS/resource/ccfs/queryBillData 异常状态码返回信息示例 {"timestamp":1532142010247,"status":403,"error":"Forbidden","message":"Nomessageavailable","path":"/CCFS/resource/ccfs/queryBillData"} 父主题： 附录

座席操作类型 表1 座席操作类型 操作类型 含义 操作对象 操作原因 0 座席签出CCS。 -1 1~255：客户端传入原因 256：座席与平台断连 257：座席被质检员强制签出 258：座席主动签出 259：座席重新签入前的签出 260：媒体服务器和CCS关于座席控制块握手超时 261：CCS检测到与UIS关于座席控制块握手超时 262：媒体服务器与CCS握手断连导致座席签出 263：UIS与座席握手超时 264：具有相同工号的座席正在新的客户端强制登录，导致本座席被强制签出 1 座席签入。 -1 -1 2 空闲。 -1 -1 3 示忙。 -1 1：自己示忙 2：久不应答被示忙 3：被质检员强制示忙 4：休息 5：座席电话不可用 7：座席拒接呼叫 200～250：业务自定义原因码 4 通话态。 -1 1：座席未真实退出通话态时，每个准点0分和5分输出的话单。 0：座席完全退出通话态时的话单。 说明：此通话态话单仅表示文字交谈时的话单 10 三方通话。 工号 -1 13 人工转自动，业务代表处于挂起状态。 -1 -1 20 监听/插入/耳语。 工号 0 22 放音。 -1 -1 26 座席休假(休息)。 工号 休息原因由客户端调用CCC_REQUEST_REST_EX_Msg时指定（默认0）。 27 工作状态。 -1 0：事后整理，业务侧设置自动进入工作态。 0~255：手动调整，由业务座席通过调用接口手动进入工作态。 缺省为0，即事后整理。 29 强制签出。 工号 -1 30 强制示闲。 工号 -1 31 强制示忙。 工号 -1 32 座席对用户静音。 -1 -1 38 座席保持呼叫。 工号 -1 40 座席发起内部求助。 工号 0：无组合操作 1：两方人工求助 2：三方人工求助 3：通话转被叫应答后先和业务代表通话，业务代表释放时连接主被叫用户。 4：三方通话转被叫应答后实现三方通话，业务代表释放时连接主被叫用户。 5：三方通话 6：连接呼叫 41 座席发起内部呼叫。 工号 -1 43 拦截呼叫。 工号 -1 44 暂停放音。 -1 -1 45 内部转移。 工号 -1 46 转出。 -1 -1 47 签入媒体服务器。 -1 -1 52 签出媒体服务器。 -1 -1 53 转移正在公有队列中排队的呼叫。 -1 -1 54 释放转。 -1 -1 55 转移到其他设备。 -1 -1 57 内部求助时切换保持。 -1 -1 58 座席进入“会议态”。 座席工号 -1 父主题： 附录

报文样例 请求示例 POST /CCFS/resource/ccfs/ivr/downloadFile HTTP/1.1Authorization: auth-v2/ak/2021-08-31T09:38:50.872Z/content-length;content-type;host/c12f0ed0******************94941bdd106Accept: */*Content-Type: application/json;charset=UTF-8Content-Length: 193{ "request": { "version": "2.0" }, "msgBody": { "filePath": "Y:/3rdfile/53/thirdvoicebotfile", "mode":"1" }}

响应说明 当调用本接口响应成功，则从httpresponse消息中获取文件的二进制数据生成录音文件，文件后缀名为.wav，响应中content-type字段为Application/Octet-stream;charset=UTF-8。 当调用本接口响应失败，则返回相应的错误码信息，错误码响应数据结构请查看表 响应消息response参数说明，resultData为保留字段，默认为空字符串。 表5 响应消息参数说明 序号 名称 参数类型 说明 1 resultCode String 请求返回的结果码，详见错误码参考。 2 resultDesc String 请求结果描述。 3 resultData Object 请求响应数据

错误码参考 响应码 结果码 英文描述 中文描述 处理方法 200 0 success 成功。 无需处理。 200 0300001 The value of {param} cannot be null. 参数{param}不能为空。 请检查请求字符串中参数值是否为空字符串。 200 0300002 The value of {param} cannot be an empty string. 参数{param}不能为空字符串。 请检查请求字符串中参数的值是否为空字符串。 200 0300003 The length of {param} is too long. 参数{param}长度太长。 查看参数是否大于文档限制的长度。 200 0300004 The format of {param} is incorrect. 参数{param}格式错误。 查看参数是否符合文档描述的格式。 200 0300005 The length of {param} is too short. 参数{param}长度太短。 查看参数是否小于文档限制的长度。 200 0300006 The value of version is error, current version is {param} . 版本号错误，当前版本号为{param} 查看参数中的版本号是否匹配 200 0300007 The params of requestBody is null. 参数长度不匹配 参看参数长度是否匹配 200 0300008 Reached the download flow control threshold. 达到最大下载流控点。 到达系统下载最大处理流控点，请稍后重试。 200 0300009 Reached the query flow control threshold. 达到最大查询流控点。 到达系统查询最大处理流控点，请稍后重试。 200 0300010 The date in the value of fileName is in an incorrect format. 请求参数fileName的路径中日期格式错误。 查看请求字符串的文件名称是否有效。文件名称格式：/{nodeId}/{ccId}/record/{appId}/{accountId}/{yyyymmdd}/{agentId}/{原始文件主名}.文件扩展名。请检查{yyyymmdd}部分是否正确。 200 0300011 The file does not exist. 该文件不存在。 请求的文件不存在，请检查请求的文件是否有误。 200 0300012 No data found. 没有数据被找到。 查看参数fileName参数是否有误。文件名称格式： 盘符:/ vdn号/0是呼入,1是呼出/日期/座席号/当天时间毫秒值.V3 200 0300013 The beginTime cannot be later than the endTime. 开始时间不能小于结束时间。 请检查请求参数beginTime和endTime。 200 0300014 The maximum duration between the beginTime and endTime is {param} days. 开始时间到结束时间之间最多跨{param}天。 查看请求字符串的beginTime和endTime是否在有效范围内。默认最大是3天内。 200 0300015 The local storage or voice path does not exist. 本地存储路径或录音路径未配置 配置文件中以下配置项配置合理路径 ccfs.common.local.store.path ccfs.common.local.voice.path 200 0300016 The value of {param} is greater than current time. 查询时间不能大于当前系统时间 请检查查询时间。 200 0300017 Specify ccId. 请传入ccId参数值。 查询到多条数据，需要多传入ccId进行更精确的查询。 200 0300018 This record belongs to another developer. 该条记录属于其他开发者。 查询的录音记录的开发者和请求开发者信息对应不上，请检查appId传入是否正确。 200 0300019 Specify at least one of fileName and callId. fileName或者callId参数值至少传入一个。 请检查是否传入了fileName或者callId参数值。 200 0300020 Only one record is required but multiple records are obtained. 只需要一条记录，实际得到多条记录。 根据条件查询到多条记录，而实际只需要一条录音，请联系管理员。 200 0300021 The {param} in fileName does not match the {param} in the directory. 请求参数中fileName的路径中{param} 和请求参数{param}不匹配。 查看请求字符串的文件名称是否有效。文件名称格式：/{nodeId}/{ccId}/record/{appId}/{accountId}/{yyyymmdd}/{agentId}/{原始文件主名}.文件扩展名。请检查{appId}，record，{nodeId}是否正确。 200 0300022 The parameter {param} value contains illegal characters. 请求参数{param}包含非法字符。 请求参数包含了非法特殊字符。如： 下载话单和录音索引接口中参数billFileName只能由“a-zA-Z0-9.-_”组成。 下载录音文件接口中参数fileName只能由“a-zA-Z0-9/.”组成。 下载录音变成文字的文件接口中参数fileName只能由“a-zA-Z0-9/.”组成。 查询并下载录音文件接口中参数fileName只能由“a-zA-Z0-9:/.”组成。 200 0300023 The file name does not match the path configured in the configuration file. 文件名与配置文件中配置的路径不匹配。 下载IVR留言录音时，请求参数中fileName的路径中vdnId后的文件夹和配置项中配置的路径不匹配，修改系统级参数：IVR留言录音文件中vdnId后的目录为合理文件路径。 200 0300024 The file path is not canonical path. 文件路径不是一个标准路径 请检查路径是否是标准路径。 200 0300025 Internal system error. 系统内部错误。 请联系管理员处理。 200 0300026 Authentication failed. 开发者accountId或vdnId鉴权失败 请检查accountId或vdnId是否有误。 200 0300027 Parameter {param} is empty. 参数为空。 请检查参数是否为空或空字符串。 200 0300028 Parameter {param} is error. 参数错误。 请检查参数是否符合文档描述的要求。 200 0300029 File does not exist. 获取的文件不存在。 请检查fileName参数是否有误，请求回放录音文件接口和回放录音文件接口请求播放的文件不存在。 200 0300030 Failure of system processing. 下载失败。 请联系管理员处理。 200 0300031 Invalid oiap fileName, fileName Length is not legal. fileName长度不合法。 请检查参数fileName的长度。 200 0300032 file path is invalid. 文件路径不合法。 请检查文件路径是否合法。 200 0300033 locationId is empty CTI的pool模式下，locationId不能为空 请检查参数是否为空或空字符串。 200 0300034 tenantId is empty tenantId为空 请检查参数是否为空或空字符串。 200 0300047 Upload file to OBS/LSS failed 上传 OBS/LSS失败 请OBS/LSS服务是否正常。 200 0300048 In CTI pool mode,the value of ccfs.uap.id cannot be empty CTI的pool模式下，CCFS后台配置文件的配置项ccfs.uap.id的值不能为空 请检查/home/ccfsapp/webapps/ccfsapp/WEB-INF/classes/config/servicecloud.base.properties配置文件的配置项ccfs.uap.id的值是否为空。 200 0300049 In CTI pool mode,the value format of ccfs.uap.id is incorrect CTI的pool模式下，CCFS后台配置文件的配置项ccfs.uap.id的值格式不正确 请检查/home/ccfsapp/webapps/ccfsapp/WEB-INF/classes/config/servicecloud.base.properties配置文件的配置项ccfs.uap.id的值格式是否正确。 配置规则：{挂载目录},{uap节点标识} 父主题： 附录

静态鉴权 在agentgateway/WEB-INF/config/basic.properties中修改配置： AUTHMODE = 1 座席调用登录接口登录成功后，可以从请求的响应头中获取到名称为Set-GUID的header，值例如为“JSESSIONID=27************f5.AgentGateway0”，其中27************f5.AgentGateway0为guid，这个guid就是这个座席的鉴权信息。座席调用其他接口时需要将该guid设置到http请的header中，header的名称必须为guid。CC-Gateway会从请求的header中获取guid进行比较，判断是否合法用户，如果不是合法用户，则返回结果码为100-006或000-003。

响应说明 当调用本接口响应成功，则返回0和operate success。 当调用本接口响应失败，则返回相应的错误码信息，错误码响应数据结构请查看表5，resultData为保留字段，默认为空字符串。 表5 响应消息参数说明 序号 名称 参数类型 说明 1 resultCode String 请求返回的结果码，详见错误码参考。 2 resultDesc String 请求结果描述。 3 resultData Object 请求响应数据，参数说明详见表6。 表6 响应 resultData 说明 序号 名称 参数类型 说明 3.1 hashValue String 放音文件 SHA256 编码后的字符串

报文样例 请求示例 POST /CCFS/resource/ccfs/ivr/getFileHash HTTP/1.1Authorization: auth-v2/ak/2021-08-31T09:38:50.872Z/content-length;content-type;host/c12f0ed0******************494941bdd106Accept: */*Content-Type: application/json;charset=UTF-8Content-Length: 193{ "request": { "version": "2.0" }, "msgBody": { "fileName": "Y:/3rdfile/2/thirdvoicebotfile/5dckNDei_1647502396161.wav" }} 响应示例 { "resultData": { "hashValue": "2b67748fe335617******************cf19f28bb8" }, "resultCode": "0", "resultDesc": "success"}

报文样例 请求示例 POST /CCFS/resource/ccfs/ivr/deleteFile HTTP/1.1Authorization: auth-v2/ak/2021-08-31T09:38:50.872Z/content-length;content-type;host/c12f0ed0******************941bdd106Accept: */*Content-Type: application/json;charset=UTF-8Content-Length: 193{ "request": { "version": "2.0" }, "msgBody": { "fileName": "Y:/3rdfile/2/thirdvoicebotfile/5dckNDei_1647502396161.wav" }} 响应示例 { "resultData": null, "resultCode": "0", "resultDesc": "success"}

响应说明 当调用本接口响应成功，则返回0和operate success。 当调用本接口响应失败，则返回相应的错误码信息，错误码响应数据结构请查看表5，resultData为保留字段，默认为空字符串。 表5 响应消息参数说明 序号 名称 参数类型 说明 1 resultCode String 请求返回的结果码，详见错误码参考。 2 resultDesc String 请求结果描述。 3 resultData Object 请求响应数据

报文样例 请求示例 POST /CCFS/resource/ccfs/ivr/upload?vdnId=xx HTTP/1.1Authorization: auth-v2/ak/2021-08-31T09:38:50.872Z/content-length;content-type;host/c12f0ed******************941bdd106Accept: */*Content-Type: application/json;charset=UTF-8Content-Length: 193{ "request": { "version": "2.0" }, "msgBody": { "data":"base64" }} 响应示例 { "resultData": { "fileName": "Y:/3rdfile/53/thirdvoicebotfile/8fSsBaEb_1631869974029.wav", "locationId": [ "0", "256" ] }, "resultCode": "0", "resultDesc": "success"}

触发事件 如果签入时status参数设置3（示忙态），触发如下事件： 座席签入成功（AgentOther_InService） 示闲（AgentState_Ready） 示忙成功（AgentState_SetNotReady_Success） 如果签入时status参数设置4（空闲态），触发如下事件 座席签入成功（AgentOther_InService） 示闲（AgentState_Ready） 如果签入时status参数设置5（整理态），触发如下事件： 座席签入成功（AgentOther_InService） 示闲（AgentState_Ready） 工作中（AgentState_Work） 如果签入时开启话机联动，会额外触发如下事件： 联动能力事件（AgentEvent_linkageCapability）

报文样例 消息头 Content-Type:application/json; charset=UTF-8 请求参数 { "password": "", "phonenum": "40038", "status": "4", "releasephone": "false", "agenttype": "4"} 响应参数 { "message": "", "retcode": "0", "result": { "vdnid": 1, "workno": "291", "mediatype": "TTF", "loginTime": "1471585949806", "isForceChange": "false", "serverName": "AgentGateway", "timeRemaining": "9" }}

请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 password string True CTI平台的工号密码（最大长度为32）。 2 phonenum string True 软电话号码（最大长度为24） 3 autoanswer boolean False 是否自动应答，默认为true。 4 autoenteridle boolean False 通话结束后是否自动进入空闲态，默认为true。 5 releasephone boolean False 座席挂机后是否进入非长通态(呼叫结束后话机挂断)：默认为true。 6 agenttype int False 签入的座席类型，默认为4。 4：pc+phone座席 11：pc+phone视频座席 7 status int False 签入后的状态，默认为空闲态。 3：示忙 4：空闲 5：整理态 8 ip string False 座席ip，默认127.0.0.1（最大长度为15），暂不支持IPV6 9 entryIp string False 座席客户端应用网关IP 10 phonelinkage boolean False 是否启动话机联动（接续和硬话机联动控制，目前仅支持 CC组网下的 espace 7910 话机）。 默认为false。 11 checkInWebm boolean False 是否签入Webm媒体服务器。 默认为true。 12 checkInMailm boolean False 是否签入Mailm媒体服务器。 默认为false。 13 vcPhoneNumber string False VC号码（最大长度为24） 14 listenStatus boolean False 质检员是否侦听座席登录和登出的操作。 默认为false。 15 callBackUri string False 事件回调地址（事件回调地址） 接口定义可参考“推送事件回调接口”章节 16 serviceToken string False 认证码（最大长度50，不能包含特殊字符） 17 serviceworkid string False 业务工号（最大长度为30）。 callBackUri和serviceToken同时传入时才代表使用事件推送模式，否则依旧使用事件轮询模式。

响应说明 表4 响应头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。 3 Set-GUID string True 值例如为“JSESSIONID=279fe2*****************0f5.AgentGateway0”其中279fe2*****************0f5.AgentGateway0为Guid 表5 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result Map 查询成功后，返回结果信息的对象。 该对象的参数说明请参见表6。 表6 result对象参数说明 序号 名称 参数类型 说明 3.1 vdnid string 虚拟呼叫中心ID。 3.2 workno string 座席工号。 3.3 mediatype string 签入媒体服务器是否成功，T表示成功，F表示失败，三位分别表示CTIServer、WebM、MailM。如：TTF，表示CTIServer、WebM签入成功，MailM签入失败。 只有签入CTIServer成功，才能进行语音业务处理；只有签入WebM成功，才能进行文字交谈业务处理；当前不支持签入MailM。 3.4 loginTime string 签入时间，格式为时间戳。 3.5 isForceChange string 是否需要强制修改密码，如果为true，则座席登录后，必须修改密码。修改密码请调用修改密码(扩展)。 说明： 如果为true，没有修改密码，该座席无法进行通话。 3.6 serverName string 登录的CC-Gateway的集群名称。 3.7 timeRemaining string 密码剩余过期时间。 空字符串则表示座席密码永不过期。取值范围为0~180（天）。

报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 无 响应参数 { "result": [ { "name": "defaultMediaSkill", "id": 1, "mediatype": 53 } ], "message": "success", "retcode": "0"}

请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid 动态鉴权（AUTHMODE = 2）座席心跳接口返回header中的Guid。 3 service_token string False 自定义，最大长度为50，不能包含特殊字符，否则会返回100-001，建议1分钟动态刷新一次。 消息体 无

接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/handshake 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。

接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/agentskills 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。

响应说明 表3 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result array 查询成功后，返回结果信息的对象。 该对象的参数说明请参见表4。 表4 result对象参数说明 序号 名称 参数类型 说明 3.1 name string 技能名称 。 3.2 id int 技能ID。 3.3 mediatype int 媒体类型。其中： 1：文字交谈 2：点击通话 4：回呼请求 5：普通音视频电话 15：预测呼出 16：预浏览呼出 17：消息呼叫 19：视频普通呼叫 51：多媒体Web Chat 53：Social Chat

报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "agentIds": [ 31002, 31003 ], "content": "hello"} 响应参数 { "result": null, "message": "success", "retcode": "0"}

报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 无 响应参数 { "result": [ { "name": "defaultMediaSkill", "id": 1, "mediatype": 53 }, { "name": "defaultAudioSkill", "id": 3, "mediatype": 5 } ], "message": "success", "retcode": "0"}

接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/sendnoteletex 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。

请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 agentIds int True 接收便签消息座席工号。 最大可以传100个座席工号。 2 content string True 便签内容。 大小为0~1023个字节，内容可为空，支持中文内容。

接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/agentskillsbyworkno/{workno} 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 workno string True 待查询的座席工号，取值范围为101～59999。 该座席工号必须与前面agentid为同一vdn下面的座席。

响应说明 表3 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result array 查询成功后，返回结果信息的对象。 该对象的参数说明请参见表4。 表4 result对象参数说明 序号 名称 参数类型 说明 3.1 name string 技能名称 。 3.2 id int 技能ID。 3.3 mediatype int 媒体类型。其中： 1：文字交谈 2：点击通话 4：回呼请求 5：普通音视频电话 15：预测呼出 16：预浏览呼出 17：消息呼叫 19：视频普通呼叫 51：多媒体Web Chat 53：Social Chat

报文样例 消息头 Content-Type:application/json; charset=UTF-8 请求参数 { "password": "", "phonenum": "40038", "status": "4", "releasephone": "false", "agenttype": "4"} 响应参数 { "result": { "workno": "49191", "loginTime": "1639623440728", "vdnid": 41, "serverName": "AgentGateway1", "timeRemaining": "89", "isForceChange": "false", "mediatype": "TTF" }, "message": "success", "retcode": "0"}

触发事件 如果签入时status参数设置3（示忙态），触发如下事件： 座席签入成功（AgentOther_InService） 示闲（AgentState_Ready） 示忙成功（AgentState_SetNotReady_Success） 如果签入时status参数设置4（空闲态），触发如下事件 座席签入成功（AgentOther_InService） 示闲（AgentState_Ready） 如果签入时status参数设置5（整理态），触发如下事件： 座席签入成功（AgentOther_InService） 示闲（AgentState_Ready） 工作中（AgentState_Work） 如果签入时开启话机联动，会额外触发如下事件： 联动能力事件（AgentEvent_linkageCapability）

请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 消息体 表3 消息体参数说明 序号 名称 参数类型 选取原则 说明 1 password string True CTI平台的工号密码（最大长度为32）。 2 phonenum string True 软电话号码（最大长度为24） 3 autoanswer boolean False 是否自动应答，默认为true。 4 autoenteridle boolean False 是否自动进入空闲态，默认为true。 5 releasephone boolean False 座席挂机后是否进入非长通态(呼叫结束后话机挂断)：默认为false。 6 agenttype int False 签入的座席类型，默认为4。4：pc+phone座席，11：pc+phone视频座席 7 status int False 签入后的状态，默认为空闲态。3：示忙态，4：空闲，5：整理态 8 ip string False 座席ip，默认127.0.0.1（最大长度为15），暂不支持IPV6 9 entryIp string False 座席客户端应用网关IP 10 phonelinkage boolean False 是否启动话机联动（接续和硬话机联动控制）。 默认为false 11 checkInWebm boolean False 是否签入Webm媒体服务器。 默认为true。 12 checkInMailm boolean False 是否签入Mailm媒体服务器。 默认为false。 13 vcPhoneNumber string False VC号码（最大长度为24） 14 listenStatus boolean False 质检员是否侦听座席登录和登出的操作。 默认为false。 15 callBackUri string False 事件回调地址（最大长度200） 接口定义可参考“推送事件回调接口”章节 16 serviceToken string False 认证码（最大长度50，不能包含特殊字符） callBackUri和serviceToken同时传入时才代表使用事件推送模式，否则依旧使用事件轮询模式。

响应说明 表4 响应头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。 3 Set-GUID string True 值例如为“JSESSIONID=279fe2*****************0f5.AgentGateway0”其中279fe2*****************0f5.AgentGateway0为Guid 表5 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result Map 查询成功后，返回结果信息的对象。 该对象的参数说明请参见表6。 表6 result对象参数说明 序号 名称 参数类型 说明 3.1 vdnid string 虚拟呼叫中心ID。 3.2 workno string 座席工号。 3.3 mediatype string 签入媒体服务器是否成功，T表示成功，F表示失败，三位分别表示CTIServer、WebM、MailM。如：TTF，表示CTIServer、WebM签入成功，MailM签入失败。 只有签入CTIServer成功，才能进行语音业务处理；只有签入WebM成功，才能进行文字交谈业务处理；当前不支持签入MailM。 3.4 loginTime string 签入时间，格式为时间戳。 3.5 isForceChange string 是否需要强制修改密码，如果为true，则座席登录后，必须修改密码。修改密码请调用修改密码(扩展)。 说明： 如果为true，没有修改密码，该座席无法进行通话。 3.6 serverName string 登录的CC-Gateway的集群名称。 3.7 timeRemaining string 密码剩余过期时间。 空字符串则表示座席密码永不过期。取值范围为0~180（天）。