座席状态推送订阅接口
场景描述
遵从度座席状态推送任务订阅
接口方法
该接口仅支持POST方法,不支持PUT、GET和DELETE等方法。
接口URI
https://IP:Port/agentgateway/resource/config/sys/agentstatus/register
其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。
日志中的方法名
registerAgentStatus
请求消息
- 消息头
表1 消息头参数说明 序号
名称
参数类型
是否必选
说明
1
Content-Type
string
True
消息主体编码方式,缺省值:application/json; charset=UTF-8
2
Guid
string
True
Guid的取值为C5 智能辅助类接口鉴权方式接口返回的guid。
- 请求消息示例
表2 消息体参数说明 序号
名称
参数类型
是否必选
说明
1
id
number
True
vdnId,0-系统配置,[1-5000]-VDN配置
取值范围:0~5000
2
channelDesc
String
false
配置描述,最大长度20
3
callbackUrl
String
True
推送地址,最大长度100,校验正常url格式
4
drCallbackUrl
String
True
容灾推送地址,最大长度100,校验正常url格式
5
authUrl
String
true
鉴权地址,最大长度100,校验正常url格式
6
drAuthUrl
String
False
容灾鉴权地址,最大长度100,校验正常url格式
7
authUserName
String
True
鉴权用户名,最大长度128
8
authPassWord
String
True
鉴权密码,最大长度128
9
drAuthUserName
String
False
鉴权用户名,最大长度128
10
drAuthPassWord
String
False
鉴权密码,最大长度128
11
pushTimeout
int
False
推送超时时长,范围1000-5000,默认值3000,单位ms
12
tokenRefreshMinutes
Int
False
Token刷新时间间隔,范围10-120,默认值50,单位分钟
响应消息
|
序号 |
名称 |
参数类型 |
说明 |
|---|---|---|---|
|
1 |
message |
string |
返回消息。 |
|
2 |
retcode |
string |
操作的结果原因码。 取值类型为整数。
|
报文样例
- 消息头
Content-Type:application/json; charset=UTF-8 Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
- 请求参数
{ "id":52, "channelDesc":"sys", "callbackUrl":"https://10.244.135.28/agentstatus/register", "drCallbackUrl":"https://10.244.135.28/agentstatus/register", "authUrl":"https://10.244.135.28/agentstatus/auth", "drAuthUrl":"https://10.244.135.28/agentstatus/auth", "authUserName":"sys0226", "authPassWord":"Cti_1234", "drAuthUserName":"", "drAuthPassWord":"", "pushTimeout":"2000", "tokenRefreshMinutes":120 } - 响应参数
{ "message": "success", "retcode": "0" }