邀请（Invite）API接口

邀请API，主要涉及邀请相关的控制，通过API，您可以实现会前拨号/会中拨号/接收会议邀请/获取邀请信息等功能。

1. 查询邀请信息 (Query Invite)

1.1 查询邀请所有信息

接口说明

1）接口解释：用于查询邀请模块的相关信息

2）引入版本： 3.8.10

3）调用方式（method）：Query

4）调用结果：同步返回调用结果

输入参数（params）

参数名称	是否必选	参数类型	参数描述
path	是	array	模块名

输出参数（data）

参数名称	参数类型	参数描述
pstn	object	pstn电话呼叫，详见pstn电话呼叫表
rooms	object	rooms会议信息，详见rooms会议信息表

pstn电话呼叫表（pstn）

参数名称	参数类型	参数描述
IsPstnEnable	bool	rooms账号是否支持PSTN电话呼叫： true：支持 false：不支持
PtsnInfo	object	pstn信息表

pstn信息表（PtsnInfo）

参数名称	参数类型	参数描述
user_id	string	呼叫的用户id
dial_ui_state	string	呼叫状态，默认值为0： 0：拨号 1：拨号中 2：拨号成功
is_audio_on	bool	是否开启了麦克风： true：开启 false：关闭
volume	int	麦克风音量值
mute	bool	是否静音： true：是 false：否

rooms会议信息表（rooms）

参数名称	参数类型	参数描述
invite_info	array	邀请信息列表
buttons	object	按钮信息表
invite_type	int	邀请类型： 0：未知 1：Rooms邀请入会
meeting_code	string	会议码
meeting_password	string	会议密码
title	string	邀请标题
inviter_nick_name	string	邀请者名称
meeting_title	string	会议标题

按钮信息表（buttons）

参数名称	参数类型	参数描述
positive	string	确定状态按钮文案
negative	string	取消状态按钮文案

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Query",
    "params": {
        "path": ["Invite"]
    }
}

response

{
    "method": "Query",
    "result": {
        "error_code": 0,
        "data": {
            "pstn": {
                "IsPstnEnable": true,
                "PtsnInfo": {
                    "user_id": "",
                    "dial_ui_state": 0,
                    "is_audio_on": true,
                    "volume": 100,
                    "mute": false 
                }
            },
            "rooms":{
                "invite_info":[
                    {
                        "buttons":{
                            "positive": "",
                            "negative": ""
                        },
                        "invite_type": 0,
                        "meeting_code": "",
                        "meeting_password": "",
                        "title": "",
                        "inviter_nick_name": "",
                        "meeting_title": ""
                    }
                ]
            }
        },
        "message": "成功"
    },
    "id": "D3OW7JFISL7XN4U",
    "jsonrpc": "2.0"
}

1.2 查询邀请部分信息

接口说明

1）接口解释：用于查询邀请模块的相关信息

2）引入版本： 3.8.10

3）调用方式（method）：Query

4）调用结果：同步返回调用结果

输入参数（path）

详见1.1 查询邀请所有信息

输出参数（data）

详见1.1 查询邀请所有信息

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Query",
    "params": {
        "path": ["Invite", "Pstn", "Pstn"] // 查询Invite模块下的PstnInfo节点
    }
}

response

{
    "jsonrpc": "2.0",
    "method": "Query",
    "id": "xxx",
    "result": {
        "error_code": 0,
        "message": "成功",
        "data": {
            "PtsnInfo": {
                "mute": false,
                "dial_ui_state": 0,
                "volume": 22,
                "is_audio_on": false,
                "user_id": "",
                "connect_time": 0,
                "user_in_meeting": true
            }
        }
    }
}

2. 会中通过pstn电话邀请成员 (InvitePstnUser)

接口说明

1）接口解释：用于会中通过pstn电话邀请成员

2）引入版本： 3.9.150

3）调用方式（method）：Call/Invite

4）调用名（action）：InvitePstnUser

5）前置依赖：
a. Rooms需要具有PSTN能力
b. Rooms不处于投屏状态
c. Rooms需要在会中

输入参数（action_params）

参数名称	是否必选	参数类型	参数描述
phone_number	是	string	手机号
country_code	是	string	国家码
show_country_code	是	string	显示在页面的国家码
nickname	是	string	用户昵称，可为空

输出参数（data）

成功返回空消息，失败返回错误信息，错误码详见 错误码定义

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Call/Invite",
    "params": {
        "action": "`InvitePstnUser`",
        "action_params": {
            "phone_number": "xxxxxxxxxxx",
            "country_code": "0086",
            "show_country_code": "86",
            "nickname": ""
        }
    }
}

response

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Call/Invite",
    "result": {
        "error_code": 0,
        "action": "InvitePstnUser",
        "message": ""
    }
}

3. 取消会中通过pstn电话邀请成员 (CancelPstnInvite)

接口说明

1）接口解释：用于取消会中通过pstn电话邀请成员

2）引入版本： 3.9.150

3）调用方式（method）：Call/Invite

4）调用名（action）：CancelPstnInvite

5）前置依赖：
a. Rooms用户当前正在拨号中

输入参数（action_params）

参数名称	是否必选	参数类型	参数描述
phone_number	是	string	手机号

输出参数（data）

成功返回空消息，失败返回错误信息，错误码详见 错误码定义

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "AY4WDEC6E8IE5ML",
    "method": "Call/Invite",
    "params": {
        "action": "`CancelPstnInvite`",
        "action_params": {
            "phone_number": "xxxxxxxxxxx"
        }
    }
}

response

{
    "jsonrpc": "2.0",
    "id": "AY4WDEC6E8IE5ML",
    "method": "Call/Invite",
    "result": {
        "error_code": 0,
        "action": "CancelPstnInvite",
        "message": ""
    }
}

4. 非会中通过pstn呼叫 (PstnDial)

接口说明

1）接口解释：用于非会中通过pstn呼叫

2）引入版本： 3.9.150

3）调用方式（method）：Call/Invite

4）调用名（action）：PstnDial

5）前置依赖：
a. Rooms需要具有PSTN能力
b. Rooms不处于投屏状态
c. Rooms用户不处于会中
d.Rooms用户当前没有在拨号中
e.Rooms用户当前没有在使用白板

输入参数（action_params）

参数名称	是否必选	参数类型	参数描述
phone_number	是	string	手机号

输出参数（data）

成功返回空消息，失败返回错误信息，错误码详见 错误码定义

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Call/Invite",
    "params": {
        "action": "PstnDial",
        "action_params": {
            "phone_number": "xxxxxxxxxxx"
        }
    }
}

response

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Call/Invite",
    "result": {
        "error_code": 0,
        "action": "PstnDial",
        "message": ""
    }
}

5. 挂断会前通过pstn的呼叫 (PstnHangUp)

接口说明

1）接口解释：用于挂断会前通过pstn的呼叫

2）引入版本： 3.9.150

3）调用方式（method）：Call/Invite

4）调用名（action）：PstnHangUp

5）调用结果：异步返回调用结果，PSTNHangUp，需要订阅 Invite 事件，详见 3. rooms主动挂断成功通知 (PSTNHangUp)

6）前置依赖：
1、Rooms用户当前正在拨号中

输入参数（action_params）

参数名称	是否必选	参数类型	参数描述
phone_number	是	string	手机号

输出参数（data）

成功返回空消息，失败返回错误信息，错误码详见 错误码定义

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Call/Invite",
    "params": {
        "action": "PSTNHangUp",
        "action_params": {
            "phone_number": "xxxxxxxxxxx"
        }
    }
}

response

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Call/Invite",
    "result": {
        "error_code": 0,
        "action": "PSTNHangUp",
        "message": ""
    }
}

6. 会前pstn电话拨动后进入快速会议 (StartPstnQuickMeeting)

接口说明

1）接口解释：用于会前pstn电话拨动后进入快速会议

2）引入版本： 3.9.150

3）调用方式（method）：Call/Invite

4）调用名（action）：StartPstnQuickMeeting

5）前置依赖：
a. Rooms需要处于拨号成功的状态
b. Rooms需要具有PSTN能力

输入参数（action_params）

无输入参数

输出参数（data）

成功返回空消息，失败返回错误信息，错误码详见 错误码定义

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Call/Invite",
    "params": {
        "action": "StartPstnQuickMeeting"
    }
}

response

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Call/Invite",
    "result": {
        "error_code": 0,
        "action": "StartPstnQuickMeeting",
        "message": ""
    }
}

7. 挂断并离开pstn通话页面--非会中页面 (LeavePstnMeeting)

接口说明

1）接口解释：用于挂断并离开pstn通话页面--非会中页面

2）引入版本： 3.9.150

3）调用方式（method）：Call/Invite

4）调用名（action）：LeavePstnMeeting

5）前置依赖：
a. Rooms不在会中
b. Rooms当前没有开启新的拨号动作

输入参数（action_params）

参数名称	是否必选	参数类型	参数描述
phone_number	是	string	手机号

输出参数（data）

成功返回空消息，失败返回错误信息，错误码详见 错误码定义

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Call/Invite",
    "params": {
        "action": "LeavePstnMeeting",
        "action_params": {
            "phone_number": "xxxxxxxxxxx"
        }
    }
}

response

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Call/Invite",
    "result": {
        "error_code": 0,
        "action": "LeavePstnMeeting",
        "message": ""
    }
}

8. 处理会议邀请 (HandleInvitation)

接口说明

1）接口解释：用于挂断会前通过pstn的呼叫

2）引入版本： 3.9.150

3）调用方式（method）：Call/Invite

4）调用名（action）：HandleInvitation

5）调用结果：异步返回调用结果，此接口目前只支持处理Rooms 邀请 Rooms 的场景，暂不支持处理云会议邀请 Rooms，UpdateInviteJoinMeetingStatus，需要订阅 Invite 事件，详见 5. 邀请入会结果通知 (UpdateInviteJoinMeetingStatus)

6）前置依赖：
a. Rooms用户需要被邀请

输入参数（action_params）

参数名称	是否必选	参数类型	参数描述
invitation_type	是	int	邀请类型，保留的字段，暂无说明，方便后续扩展接口
invitation_action	是	int	处理动作： 0：接收邀请 1：拒绝邀请

输出参数（data）

成功返回空消息，失败返回错误信息，错误码详见 错误码定义

请求示例

request

{
    "jsonrpc":"2.0",
    "id":"xxx",
    "method":"Call/Invite",
    "params":{
        "action":"HandleInvitation",
        "action_params":{
            "invitation_type": 0,
            "invitation_action": 0
        }
    }
}

response

{
    "jsonrpc": "2.0",
    "id":"xxx",
    "method":"Call/Invite",
    "result":{
        "error_code":0,
        "message":"",
        "action":"HandleInvitation"
    }
}

下载邀请（Invite）.pdf

文章内容是否对您有帮助？

有帮助

无帮助

能否告知我们这篇文章的问题？（选填）

操作步骤描述不清晰/看不懂这个功能不好用找不到描述的入口没找到我想要了解的信息

0 / 150