- News and Announcements
- Product Introduction
- Purchase Guide
- Development Guidelines
- Demo Zone
- Download
- Chat Interaction (UI Included)
- TUIKit Library
- Getting Started
- Integrating TUIKit
- Only integrate chat
- Build Basic Interfaces
- Modifying UI Themes
- Setting UI Styles
- Implementing Local Search
- Integrating Offline Push
- User Online Status
- Typing Status
- Message Read Receipt
- Message Reactions
- Message Quotation
- Internationalization
- Adding Custom Messages
- Emoji & Stickers
- Custom UI components
- Video Call (UI Included)
- Overview (TUICallKit)
- Activate Service（TUICallKit）
- Integration(TUICallKit)
- UI Customization (TUICallKit)
- Additional Features(TUICallKit)
- API Documentation(TUICallKit)
- Release Notes (TUICallKit)
- Push Feature
- Desk
- More Practices
- No UI Integration
- SDK Integration
- Initialization
- Login and Logout
- Message
- Message Overview
- Sending Message
- Receiving Message
- Historical Message
- Forwarding Message
- Modifying Message
- Message Inserting
- Deleting Message
- Clearing Messages
- Recalling Message
- Online Message
- Read Receipt
- Querying Message
- Group @ Message
- Targeted Group Message
- Notification Muting
- Message Extension
- Message Reaction
- Message Translation
- Voice-to-Text
- Message Pinning
- Conversation
- Group
- Community Topic
- User Profile and Relationship Chain
- Offline Push
- Local Search
- Signaling
- Client APIs
- Server APIs
- Generating UserSig
- RESTful APIs
- RESTful API Overview
- RESTful API List
- Message Related
- Session Related
- Group Related
- Group Management
- Group Information
- Group Member Management
- Group Member Information
- Group Custom Attributes
- Live Group Management
- Setting Live Streaming Group Robots
- Deleting Live Streaming Group Robots
- Setting/Deleting Live Streaming Group Administrators
- Obtaining the List of Live Streaming Group Administrators
- Checking Whether Users Are in a Live Streaming Group
- Getting the Number of Online Users in an Audio-Video Group
- Getting the List of Online Members in Audio-Video Group
- Setting Audio-Video Group Member Marks
- Getting the List of Banned Group Members
- Community Management
- Creating Topic
- Deleting Topic
- Getting Topic Profile
- Modifying Topic Profile
- Importing Topic Profiles
- Permission Group Management
- Creating Permission Groups
- Terminating Permission Groups
- Modifying Permission Group Information
- Obtaining Permission Group Information
- Adding Topic Permissions
- Modifying Topic Permissions
- Deleting Topic Permissions
- Obtaining Topic Permissions
- Adding Members to a Permission Group
- Deleting Permission Group Members
- Obtaining Permission Group Member List
- Group Counter
- User Management
- Global Mute Management
- Operations Management
- Chatbots
- Official Account Management
- Webhooks
- Webhook Overview
- Webhook Command List
- Operations Management Callbacks
- Online Status Webhooks
- Relationship Chain Webhooks
- One-to-One Message Webhooks
- Group Webhooks
- Before a Group Is Created
- After a Group Is Created
- Before Applying to Join a Group
- Before Inviting a User to a Group
- After a User Joins a Group
- After a User Leaves a Group
- Before Group Message Is Sent
- After a Group Message Is Sent
- After a Group Is Full
- After a Group Is Disbanded
- After Group Profile Is Modified
- Callback After Recalling Group Messages
- Webhook for Online and Offline Status of Audio-Video Group Members
- Webhook for Exceptions When Group Messages Are Sent
- Before a Topic Is Created
- After a Topic Is Created
- After a Topic Is Deleted
- Topic Profile Change Webhook
- Callback After Group Member Profile Changed
- Callback After Group Attribute Changed
- Callback After Read Receipt
- Callback After the Group Owner Changed
- Webhooks related to the Official Account
- Before a Official Account Is Created
- After a Official Account Is Created
- After Official Account Profile Is Modified
- After Official Account Is Destroyed
- Before Official Account Is Subscribed
- After Official Account Is Subscribed
- After a Official Account Is Full
- After Official Account Is Unsubscribed
- Before Official Account Message Is Sent
- Callback After Sending an Official Account Message
- Webhook After Recalling Official Account Messages
- Console Guide
- FAQs
- Security Compliance Certification
- Chat Policies
- Migration
- Error Codes
- Contact Us
- News and Announcements
- Product Introduction
- Purchase Guide
- Development Guidelines
- Demo Zone
- Download
- Chat Interaction (UI Included)
- TUIKit Library
- Getting Started
- Integrating TUIKit
- Only integrate chat
- Build Basic Interfaces
- Modifying UI Themes
- Setting UI Styles
- Implementing Local Search
- Integrating Offline Push
- User Online Status
- Typing Status
- Message Read Receipt
- Message Reactions
- Message Quotation
- Internationalization
- Adding Custom Messages
- Emoji & Stickers
- Custom UI components
- Video Call (UI Included)
- Overview (TUICallKit)
- Activate Service（TUICallKit）
- Integration(TUICallKit)
- UI Customization (TUICallKit)
- Additional Features(TUICallKit)
- API Documentation(TUICallKit)
- Release Notes (TUICallKit)
- Push Feature
- Desk
- More Practices
- No UI Integration
- SDK Integration
- Initialization
- Login and Logout
- Message
- Message Overview
- Sending Message
- Receiving Message
- Historical Message
- Forwarding Message
- Modifying Message
- Message Inserting
- Deleting Message
- Clearing Messages
- Recalling Message
- Online Message
- Read Receipt
- Querying Message
- Group @ Message
- Targeted Group Message
- Notification Muting
- Message Extension
- Message Reaction
- Message Translation
- Voice-to-Text
- Message Pinning
- Conversation
- Group
- Community Topic
- User Profile and Relationship Chain
- Offline Push
- Local Search
- Signaling
- Client APIs
- Server APIs
- Generating UserSig
- RESTful APIs
- RESTful API Overview
- RESTful API List
- Message Related
- Session Related
- Group Related
- Group Management
- Group Information
- Group Member Management
- Group Member Information
- Group Custom Attributes
- Live Group Management
- Setting Live Streaming Group Robots
- Deleting Live Streaming Group Robots
- Setting/Deleting Live Streaming Group Administrators
- Obtaining the List of Live Streaming Group Administrators
- Checking Whether Users Are in a Live Streaming Group
- Getting the Number of Online Users in an Audio-Video Group
- Getting the List of Online Members in Audio-Video Group
- Setting Audio-Video Group Member Marks
- Getting the List of Banned Group Members
- Community Management
- Creating Topic
- Deleting Topic
- Getting Topic Profile
- Modifying Topic Profile
- Importing Topic Profiles
- Permission Group Management
- Creating Permission Groups
- Terminating Permission Groups
- Modifying Permission Group Information
- Obtaining Permission Group Information
- Adding Topic Permissions
- Modifying Topic Permissions
- Deleting Topic Permissions
- Obtaining Topic Permissions
- Adding Members to a Permission Group
- Deleting Permission Group Members
- Obtaining Permission Group Member List
- Group Counter
- User Management
- Global Mute Management
- Operations Management
- Chatbots
- Official Account Management
- Webhooks
- Webhook Overview
- Webhook Command List
- Operations Management Callbacks
- Online Status Webhooks
- Relationship Chain Webhooks
- One-to-One Message Webhooks
- Group Webhooks
- Before a Group Is Created
- After a Group Is Created
- Before Applying to Join a Group
- Before Inviting a User to a Group
- After a User Joins a Group
- After a User Leaves a Group
- Before Group Message Is Sent
- After a Group Message Is Sent
- After a Group Is Full
- After a Group Is Disbanded
- After Group Profile Is Modified
- Callback After Recalling Group Messages
- Webhook for Online and Offline Status of Audio-Video Group Members
- Webhook for Exceptions When Group Messages Are Sent
- Before a Topic Is Created
- After a Topic Is Created
- After a Topic Is Deleted
- Topic Profile Change Webhook
- Callback After Group Member Profile Changed
- Callback After Group Attribute Changed
- Callback After Read Receipt
- Callback After the Group Owner Changed
- Webhooks related to the Official Account
- Before a Official Account Is Created
- After a Official Account Is Created
- After Official Account Profile Is Modified
- After Official Account Is Destroyed
- Before Official Account Is Subscribed
- After Official Account Is Subscribed
- After a Official Account Is Full
- After Official Account Is Unsubscribed
- Before Official Account Message Is Sent
- Callback After Sending an Official Account Message
- Webhook After Recalling Official Account Messages
- Console Guide
- FAQs
- Security Compliance Certification
- Chat Policies
- Migration
- Error Codes
- Contact Us
Common
TUIResult
Name | Type | Description |
code | String | If the code is empty "", it means the call succeeded, if the code is not empty "", it means the call failed. |
message | String | Error message |
TUIRoomId
Room ID for audio and video in a call.
Note：
(1)
intRoomId and strRoomId are mutually exclusive. If you choose to use strRoomId, intRoomId needs to be filled in as 0. If both are filled in, the SDK will prioritize intRoomId.(2) Do not mix
intRoomId and strRoomId because they are not interchangeable. For example, the number 123 and the string "123" represent two completely different rooms.Value | Type | Description |
intRoomId | int | Numeric room ID. |
strRoomId | String | String room number. |
VideoRenderParams
VideoEncoderParams
Name | Type | Description |
resolution | Video resolution | |
resolutionMode | Video aspect ratio mode |
TUICallParams
Name | Type | Description |
roomId | Room Id. | |
offlinePushInfo | Offline push info configuration information | |
timeout | String | Call timeout period, default: 30s, unit: seconds. |
userData | String | An additional parameter. |
TUIOfflinePushInfo
Name | Type | Description |
title | String | title |
desc | String | description |
ignoreIOSBadge | bool | Offline push ignores the badge count (only valid for iOS). If set to true, this message will not increase the unread count of the app icon on the iOS receiving end. |
iOSSound | String | Offline push sound settings (only valid for iOS). When sound = IOS_OFFLINE_PUSH_NO_SOUND, it means no sound will be played when receiving. When sound = IOS_OFFLINE_PUSH_DEFAULT_SOUND, it means playing system sound when receiving. If you want to customize iOSSound, you need to link the voice file into the Xcode project first, and then set the voice file name (with suffix) to iOSSound |
androidSound | String | Push sound settings offline (only valid for Android, supported by IMSDK 6.1 and above).
FCM push to set the sound prompt on Android 8.0 and above, you must call setAndroidFCMChannelID to set the channelID to take effect |
androidOPPOChannelID | String | Offline push setting channel ID of OPPO mobile phone 8.0 system and above |
androidVIVOClassification | int | VIVO push message classification (to be discarded interface, VIVO push service will optimize the message classification rules on April 3, 2023, it is recommended to use setAndroidVIVOCategory to set the message category). 0: operation message 1: system message, the default value is 1 |
androidXiaoMiChannelID | String | Channel ID of Xiaomi mobile phone system 8.0 and above |
androidFCMChannelID | String | Channel ID of FCM channel mobile phone system 8.0 and above |
androidHuaWeiCategory | String | Huawei Push Message Classification |
isDisablePush | bool | Whether to turn off push (by default, push is enabled) |
iOSPushType | iOS offline push type, default: APNs |
TUICallRecords
Call recording information
Value | Type | Description |
callId | String | Call recording ID. |
inviter | String | Inviter ID. |
inviteList | List<String> | List of invited user IDs. |
scene | Call scenario. | |
mediaType | Media type. | |
groupId | String | Group ID. |
role | Role. | |
result | Call result type. | |
beginTime | int | Start time. |
totalTime | int | Total time. |
TUICallRecentCallsFilter
Call recording filtering conditions.
Value | Type | Description |
begin | double | Start time. |
end | double | End time. |
resultType | Call result type. |
Enum definition
TUICallMediaType
Name | Value | Description |
none | 0 | None |
audio | 1 | Audio Calls |
video | 2 | Video Calls |
TUICallRole
Name | Value | Description |
none | 0 | None |
caller | 1 | Caller |
called | 2 | Called |
TUICallStatus
Name | Value | Description |
none | 0 | None |
waiting | 1 | waiting calls |
accept | 2 | calls answered |
TUICallScene
Name | Value | Description |
groupCall | 0 | Group Call |
multiCall | 1 | Multi calls (not supported yet, stay tuned) |
singleCall | 2 | one-to-one call |
TUINetworkQuality
Name | Value | Description |
unknown | 0 | Unkown |
excellent | 1 | The current network is very good |
good | 2 | The current network is good |
poor | 3 | The current network is poor |
bad | 4 | The urrent network is bad |
vBad | 5 | The current network is very poor |
down | 6 | The current network is unavailable |
FillMode
Name | Value | Description |
fill | 0 | Filling mode: the content of the screen will be centered and scaled proportionally to fill the entire display area, and the part beyond the display area will be cropped, and the screen may be incomplete in this mode. |
fit | 1 | Fit mode: scale according to the long side of the screen to fit the display area, and the short side will be filled with black. In this mode, the image is complete but there may be black borders. |
Rotation
Name | Value | Description |
rotation_0 | 0 | Rotate 0 degrees clockwise |
rotation_90 | 1 | Rotate 90 degrees clockwise |
rotation_180 | 2 | Rotate 180 degrees clockwise |
rotation_270 | 3 | Rotate 270 degrees clockwise |
ResolutionMode
Name | Value | Description |
landscape | 0 | Landscape resolution，for example : eResolution.Resolution_640_360 + ResolutionMode.Landscape = 640 × 360。 |
portrait | 1 | Portrait resolution，for example : Resolution.Resolution_640_360 + ResolutionMode.Portrait = 360 × 640。 |
Resolution
Name | Value | Description |
resolution_640_360 | 0 | aspect ratio 16:9；resolution 640x360；recommended bitrate（VideoCall）500kbps |
resolution_640_480 | 1 | aspect ratio 4:3；resolution 640x480；recommended bitrate（VideoCall）600kbps |
resolution_960_540 | 2 | aspect ratio 16:9；resolution 960x540；recommended bitrate（VideoCall）850kbps |
resolution_960_720 | 3 | aspect ratio 4:3；resolution 960x720；recommended bitrate（VideoCall）1000kbps |
resolution_1280_720 | 4 | aspect ratio 16:9；resolution 1280x720；recommended bitrate（VideoCall）1200kbps |
resolution_1920_1080 | 5 | aspect ratio 16:9；resolution 1920x1080；recommended bitrate（VideoCall）2000kbps |
TUICallIOSOfflinePushType
Name | Value | Description |
APNs | 0 | APNS Push |
VoIP | 1 | VoIP Push |
TUICamera
Camera type.
Type | Value | Description |
front | 0 | Front camera. |
back | 1 | Rear camera. |
TUIAudioPlaybackDevice
Audio playback device.
Type | Value | Description |
speakerphone | 0 | Speaker |
earpiece | 1 | Earpiece |
TUICallResultType
Call recording type.
Type | Value | Description |
unknown | 0 | Unknown |
missed | 1 | Missed |
incoming | 2 | Incoming call |
outgoing | 3 | Outgoing Call |
Yes
No
Was this page helpful?