计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
威胁检测服务 MTD
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
应用身份管理服务 OneAccess
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive

签入

更新时间:2024-08-02 GMT+08:00

前置条件

场景描述

座席签入。

座席签入后立即调用轮询方式获取单座席事件接口进行事件轮询,若2分钟内无事件将座席签出。

说明:

单个座席:

  • 签出接口未响应不能调用签入接口
  • 签入接口未响应不能调用签出接口

接口方法

设置成“PUT”。该接口仅支持PUT方法,不支持POST、GET和DELETE等方法。

接口URI

https://ip:port/agentgateway/resource/onlineagent/{agentid}

其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号

表1 URI中携带的参数说明

序号

参数名

数据类型

选取原则

说明

1

agentid

string

True

座席的工号,取值范围:101~59999。

日志中的方法名

login

请求说明

  • 消息头
    表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(天)。

触发事件

如果签入时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)

错误结果码

  • 100-001
  • 100-002
  • 100-003
  • 100-004
  • 100-007
  • 100-012
  • 100-015
  • 100-016
  • 110-016
  • 999-001

报文样例

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

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容