更新时间:2023-09-27 GMT+08:00

获取连接信息:getconnectinfo

场景描述

H5视频呼叫的场景下,坐席异常断连,重新加入视频会议时,需要重新获取连接信息。

接口方法

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

接口URI

https://ip:port/agentgateway/resource/mediacall/{agentid}/getconnectinfo

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

表1 URI中携带的参数说明

序号

参数名

数据类型

选取原则

说明

1

agentid

string

True

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

日志中的方法名

getConnectInfo

请求说明

  • 消息头
    表2 请求头参数说明

    序号

    名称

    参数类型

    是否必选

    说明

    1

    Content-Type

    string

    True

    消息主体编码方式,缺省值:application/json; charset=UTF-8

    2

    Guid

    string

    True

    静态鉴权(AUTHMODE = 1)签入接口返回的Guid;动态鉴权(AUTHMODE = 2)轮询事件接口返回的Guid。

  • 消息体
    表3 消息体参数说明

    序号

    名称

    参数类型

    是否必选

    说明

    1

    userType

    string

    True

    用户类型。

    默认为“agent”代表座席

    2

    callid

    string

    True

    呼叫标识。

响应说明

表4 消息体参数说明

序号

名称

参数类型

说明

1

retcode

string

消息发送结果。

  • 0:成功
  • 非0:失败

2

message

string

描述

3

result

object

查询成功后,返回连接信息对象。

该对象的参数说明请参见表5

表5 result对象参数说明

序号

名称

参数类型

说明

1

userId

string

坐席工号

2

ctime

string

过期时间

3

channelId

string

频道ID(房间ID)

4

role

string

角色

5

ip

string

媒体服务器接入点IP地址

6

port

string

媒体服务器接入点端口

7

signalingDomainIn

string

内侧信令domain;

格式:https://域名:端口

8

signalingDomainOut

string

外侧信令domain;

格式:https://域名:端口

9

locationId

string

节点

10

signature

string

签名

11

appId

string

用户标识

触发事件

错误结果码

  • 106-011
  • 106-015
  • 100-007

报文样例

  • 消息头
    Content-Type:application/json; charset=UTF-8
    Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
  • 请求参数
    {
    "callid":"1552524689-16797284",
    "userType":"agent"
    }
  • 响应参数
    {
    "message": "success",
    "retcode": "0",
    "result":
    {
                "userId": "坐席工号",
                "ctime": "过期时间",
                "channelId": "15945185-345",
                "appId": "8345234631",
                "ip": "xxx.xxx.xxx.xxx",
                "port": "6500",
                "role": "0",
                "signalingDomainIn": "https: //in.isdpdomain.com",
                "signalingDomainOut": "https: //out.isdpdomain.com",
                "locationId": "65535",
                "signature": "xxx",
                "appId": "sdcp0BPcVGymItWppGX6XqrZGTCYa13d"
            }
    
    }