邀请事件订阅
邀请事件订阅,主要涉及邀请相关的事件通知,通过订阅事件,您可以实现接收pstn呼叫状态变化通知/pstn呼叫失败描述文字更新通知/rooms主动挂断成功通知/收到邀请入会通知 等功能。
1. pstn呼叫状态变化通知 (CallStateUpdated)
事件说明
1)事件解释:当用户收到该事件时,代表pstn呼叫状态有更新
2)引入版本: 3.9.150
3)所属模块(method):Event/Invite
4)事件名(sub_event):CallStateUpdated
5)触发条件: 用户通过Rooms或CSAPI会中或会前进行呼叫,都会收到这个事件通知
事件参数
参数名称 | 参数类型 | 参数描述 |
---|---|---|
dial_ui_state | int | 呼叫状态,默认值为0: |
phone_number | string | 手机号 |
error_msg | tring | 失败原因文字描述 |
type | int | 拨号逻辑状态: |
failed_type | int | 失败类型: |
user_id | string | 邀请成功后,用户id, 若有 |
nickname | string | 用户名称 |
示例
{
"sub_event": "CallStateUpdated",
"method": "Event/Invite",
"result": {
"error_code": 0,
"data": {
"dial_ui_state": 1,
"phone_number": "xxxxxxxxxxx",
"error_msg": "",
"result": 0,
"type": 0,
"user_id": "",
"failed_type": 3,
"nickname": "xxx"
},
"message": "成功"
},
"jsonrpc": "2.0"
}
2. pstn呼叫失败描述文字更新通知 (DialErrorUpdated)
事件说明
1)事件解释:当用户收到该事件时,代表pstn呼叫失败
2)引入版本: 3.9.150
3)所属模块(method):Event/Invite
4)事件名(sub_event):DialErrorUpdated
5)触发条件: 用户通过Rooms或CSAPI进行pstn呼叫失败时,都会收到这个事件通知
事件参数
无事件参数,失败返回错误消息
示例
{
"sub_event": "DialErrorUpdated",
"method": "Event/Invite",
"result": {
"error_code": 0,
"data": "呼叫失败,用户已挂断",
"message": "成功"
},
"jsonrpc": "2.0"
}
3. rooms主动挂断成功通知 (PSTNHangUp)
事件说明
1)事件解释:当用户收到该事件时,代表rooms主动挂断成功
2)引入版本: 3.9.150
3)所属模块(method):Event/Invite
4)事件名(sub_event):PSTNHangUp
5)触发条件: 用户通过Rooms或CSAPI 进行pstn呼叫时,rooms主动挂断成功,都会收到这个事件通知
事件参数
无事件参数,失败返回错误消息
示例
{
"sub_event": "PSTNHangUp",
"method": "Event/Invite",
"result": {
"error_code": 0,
"message": "成功"
},
"jsonrpc": "2.0"
}
4. 收到邀请入会通知 (ReceivedInviteJoinMeeting)
事件说明
1)事件解释:当用户收到该事件时,代表收到邀请入会
2)引入版本: 3.9.150
3)所属模块(method):Event/Invite
4)事件名(sub_event):ReceivedInviteJoinMeeting
5)触发条件: 用户通过Rooms或CSAPI收到邀请入会,都会收到这个事件通知
事件参数
参数名称 | 参数类型 | 参数描述 |
---|---|---|
inviter_nick_name | string | 邀请者用户名称 |
meeting_password | string | 会议密码 |
meeting_code | string | 会议号 |
buttons | object | 按钮信息表 |
invite_type | int | 邀请类型: |
meeting_title | string | 会议标题 |
按钮信息表(buttons)
参数名称 | 参数类型 | 参数描述 |
---|---|---|
positive | string | 确定状态按钮文案 |
negative | string | 取消状态按钮文案 |
示例
{
"jsonrpc":"2.0",
"method":"Event/Meeting",
"result":{
"error_code":0,
"message":"",
"data":[
{
"inviter_nick_name":"xxx",
"meeting_password":"xxx",
"meeting_code":"xxx",
"buttons":{
"negative":"拒绝",
"positive":"接受"
},
"invite_type":1,
"meeting_title":" xxx"
}
]
},
"sub_event": "ReceivedInviteJoinMeeting"
}
5. 邀请入会结果通知 (UpdateInviteJoinMeetingStatus)
事件说明
1)事件解释:当用户收到该事件时,代表处理邀请入会完成
2)引入版本: 3.9.150
3)所属模块(method):Event/Invite
4)事件名(sub_event):UpdateInviteJoinMeetingStatus
5)触发条件: 用户通过Rooms或CSAPI邀请入会时,都会收到这个事件通知
事件参数
参数名称 | 参数类型 | 参数描述 |
---|---|---|
status | int | 邀请入会状态: |
示例
{
"jsonrpc":"2.0",
"method":"Event/Meeting",
"sub_event":"UpdateInviteJoinMeetingStatus",
"result":{
"error_code":0,
"message":"",
"data":{
"status":0
}
}
}