# wx.joinVoIPChat(Object object)
Start from base library version 2.7.0. Please remaining backward compatible.
with Promise style call: Supported
User authorization: Need scope.record
Mini Program plugin: Support, need to Mini Program base library version no less than 2.9.0
join (create) Live voice calls, more info visible Real-time voice guideUser authorization is required before invoking scope.recordUser authorization is required if room type is video room scope.camera。
# parameter
# Object object
| attribute | type | Default values | Required | Introductions |
|---|---|---|---|---|
| roomType | String | voice | no | Room type |
| signature | String | yes | Signature, used to verify the identity of the game | |
| nonceStr | String | yes | Random string needed for validation | |
| timeStamp | Number | yes | Time stamp required for validation | |
| groupId | String | yes | Little game inside this room/Group chat ID。 Same time pass in the same time groupId Users will enter the same real-time voice room. | |
| muteConfig | Object | no | Mute Settings | |
| success | function | no | Interface calls the successful callback function | |
| fail | function | no | Interface calls failed callback functions | |
| complete | function | no | Callback function at the end of an interface call (both successful and unsuccessful calls are executed) |
object.roomType Legal value
| value | Introductions | Minimum version |
|---|---|---|
| voice | Audio room for voice calls | |
| video | Video room, combined voip-room Component can display member picture |
object.muteConfig Structure
| attribute | type | Default values | Required | Introductions |
|---|---|---|---|---|
| muteMicrophone | Boolean | false | no | Mute the microphone |
| muteEarphone | Boolean | false | no | Mute headphones |
# object.success callback
# parameter
# Object object
| attribute | type | Introductions |
|---|---|---|
| openIdList | Array.<String> | The member on this call openId Name list |
| errCode | Number | Error code |
| errMsg | String | Call result |
# error
| Error code | Error message | Introductions |
|---|---|---|
| -1 | Currently in the room | |
| -2 | Recording device is occupied, may be currently using WeChat voice call or system call | |
| -3 | Quit while joining a session (could be due to user quitting voluntarily, backstage, caller, etc.), so joining failed | |
| -1000 | System error |