Struct

Noise Suppression Mode (ANS).

Error code.

It can be used to record the error type and error information generated by the SDK, check the error code table on the ZEGO official website, and seek assistance from ZEGO technical support.

The audio sample rate.

The number of audio channels.

Detail description: The external download url of the media message is used for the developer to transparently transmit the media file to other users by filling in this URL when the developer uploads the media file to his own server.

Required or not: If an external URL is sent, this parameter is mandatory on the sender end.

Detail description: The unique ID of the media file.

Required or not: The sender does not need to fill in, this value is generated by the SDK.

Detail description: The filename of the media file.

Required or not: If you are sending an external URL, you need to fill in this value and include the file extension. If a local file is sent, the value is optional.

Detail description: The size of the media file.

Required or not: The sender does not need to fill in, this value is generated by the SDK.

Identifies the type of this message.

The unique ID that identifies this message.

Identifies the sending time of a message

Displays the userID of the sender of this message.

Conversation ID. Ids of the same conversation type are unique.

Used to describe whether a message is sent or received.

Describes the sending status of a message.

The type of conversation to which the message belongs.

Indicates the sequence number of the message in the conversation.

The larger the orderKey, the newer the message, and can be used for ordering messages.

SDK locally generated MessageID, developers do not need to pay attention to.

Detail description: Describes whether the message is a message inserted by the developer through [insertMessageToLocalDB].

Default: false.

Describe the receipt status of the message

Business scenario: used to determine the status of the current message in the receipt message

message extension field

The expandable message field visible only on this end can store additional information locally, Through [updateMessageLocalExtendedData] change and currently has a length limit of 128K. If you have special requirements, please contact ZEGO technical support for configuration.

Whether the message is pushed by all employees.

Whether to mention everyone. It can be presented as "@Everyone".

Whether to mention everyone. It can be presented as "@User".

Indicates the sequence number of the message in the conversation.

The number of reply messages corresponding to the root message of the reply message tree.

Information about the source message referenced by the reply message.

The latest editor's userID for this message.

The latest editing timestamp for this message.

Identify if this message is group targeted message.

The last user who pinned this message.

The last timestamp when pinned this message.

Detail description: The external download url of the media message is used for the developer to transparently transmit the media file to other users by filling in this URL when the developer uploads the media file to his own server.

Required or not: If an external URL is sent, this parameter is mandatory on the sender end.

Detail description: The filename of the media file.

Required or not: If you are sending an external URL, you need to fill in this value and include the file extension. If a local file is sent, the value is optional.

Detail description: The size of the media file.

Required or not: The sender does not need to fill in, this value is generated by the SDK.

Identifies the type of this message.

The absolute path of the file needs to be played. Currently, only full absolute paths with the suffix .mp3 or .m4a are supported. When passing in file paths in other formats, the SDK will throw an illegal file path error.

Starting audio routing type when playing.

The output path of the recording file. Currently, only full absolute paths with the suffix .mp3 or .m4a are supported. When passing in file paths in other formats, the SDK will throw an illegal file path error.

The maximum recording time, the default is 60000 ms, which is 60s. The unit of this parameter is milliseconds, and the maximum value does not exceed 300000.

The content of barrage message.

Identifies the type of this message.

The unique ID that identifies this message.

Identifies the sending time of a message

Displays the userID of the sender of this message.

Conversation ID. Ids of the same conversation type are unique.

Used to describe whether a message is sent or received.

Describes the sending status of a message.

The type of conversation to which the message belongs.

Indicates the sequence number of the message in the conversation.

The larger the orderKey, the newer the message, and can be used for ordering messages.

SDK locally generated MessageID, developers do not need to pay attention to.

Detail description: Describes whether the message is a message inserted by the developer through [insertMessageToLocalDB].

Default: false.

Describe the receipt status of the message

Business scenario: used to determine the status of the current message in the receipt message

message extension field

The expandable message field visible only on this end can store additional information locally, Through [updateMessageLocalExtendedData] change and currently has a length limit of 128K. If you have special requirements, please contact ZEGO technical support for configuration.

Whether the message is pushed by all employees.

Whether to mention everyone. It can be presented as "@Everyone".

Whether to mention everyone. It can be presented as "@User".

Indicates the sequence number of the message in the conversation.

The number of reply messages corresponding to the root message of the reply message tree.

Information about the source message referenced by the reply message.

The latest editor's userID for this message.

The latest editing timestamp for this message.

Identify if this message is group targeted message.

The last user who pinned this message.

The last timestamp when pinned this message.

count.

nextFlag.

The storage path of the cache files. Refer to the official website document for the default path.

Extended field, through which the inviter can carry information to the invitee.

Extended field, through which the inviter can carry information to the invitee.

详情描述: 离线推送配置。 是否必填：非必填。

Extended field, through which the inviter can carry information to the invitee.

Offline push configuration.

Call invite ID.

Call invitation initiator ID.

Call invitation mode.

Call invitation status.

Create a call invitation additional information.

Call invites to create a timestamp.

Call invitation end time.

The list of call member.

Invitee ID.

Extended field, through which the inviter can carry information to the invitee.

The inviter ID of the call invitation.

Extended field, through which the inviter can carry information to the invitee.

The timeout setting of the call invitation, the unit is seconds.

Extended field, through which the inviter can carry information to the invitee.

mode of the call invitation.

The creator of the call invitation is the same as the userID that calls callInvite.

The event stamp when the call invitation was created on the server, accurate to milliseconds.

List of members invited to the call.

The calling party of the current call.

End the call operator.

The pass-through field that comes with invoking the end of the call.

The mode of the call invitation.

Time stamp of the end of the call, in milliseconds. The format is UTC time stamp.

The query number is limited to up to 100.

The flag of the query list.No padding is required for the first query. After the query, callback will return a nextFlag, which can be filled in the next query to continue the query based on the last query.

The timeout setting of the call invitation, the unit is seconds.

Inviter ID.

Extended field, through which the inviter can carry information to the invitee.

mode of the call invitation.

The creator of the call invitation is the same as the userID that calls callInvite.

The event stamp when the call invitation was created on the server, accurate to milliseconds.

List of members invited to the call.

Invitee ID.

Extended field, through which the inviter can carry information to the invitee.

The timeout setting of the call invitation, the unit is seconds.

User id that has not received a call invitation.

User id that has not received a call invitation list.

Call invitation type.

The timeout setting of the call invitation, the unit is seconds. The range is [1, 600].

Extended field, through which the inviter can carry information to the invitee.

Offline push configuration.

Call invitation mode configuration. Supported Version: 2.9.0 or later.

If the pass value is true, the system checks whether the call invitation is delivered in this call and subsequent calls.

Extended field, through which the inviter can carry information to the invitee.

Timestamp of the time when the call invitation was created.

Time stamp of the person join the call invitation.

The pass-through field that comes with invoking the end of the call.

List of user information in the current call invitation.

Extended field, through which the inviter can carry information to the invitee.

Offline push configuration.

Timestamp of the time when the call invitation was created.

Time stamp of the person accepting the call invitation.

The time stamp for me to exit the call.

Additional fields for attaching custom content when sending a reject invitation.

User ID, a string with a maximum length of 32 bytes or less. It is customized by the developer. Only support numbers, English characters and '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'.

user status.

Call the additional information in user information.

List of call members whose status changes.

Error user list.

Offline push configuration.

The title of combine message

The summary of combine message

Combine ID, internal user

List of child messages

Identifies the type of this message.

The unique ID that identifies this message.

Identifies the sending time of a message

Displays the userID of the sender of this message.

Conversation ID. Ids of the same conversation type are unique.

Used to describe whether a message is sent or received.

Describes the sending status of a message.

The type of conversation to which the message belongs.

Indicates the sequence number of the message in the conversation.

The larger the orderKey, the newer the message, and can be used for ordering messages.

SDK locally generated MessageID, developers do not need to pay attention to.

Detail description: Describes whether the message is a message inserted by the developer through [insertMessageToLocalDB].

Default: false.

Describe the receipt status of the message

Business scenario: used to determine the status of the current message in the receipt message

message extension field

The expandable message field visible only on this end can store additional information locally, Through [updateMessageLocalExtendedData] change and currently has a length limit of 128K. If you have special requirements, please contact ZEGO technical support for configuration.

Whether the message is pushed by all employees.

Whether to mention everyone. It can be presented as "@Everyone".

Whether to mention everyone. It can be presented as "@User".

Indicates the sequence number of the message in the conversation.

The number of reply messages corresponding to the root message of the reply message tree.

Information about the source message referenced by the reply message.

The latest editor's userID for this message.

The latest editing timestamp for this message.

Identify if this message is group targeted message.

The last user who pinned this message.

The last timestamp when pinned this message.

The title of combine message

The summary of combine message

Identifies the type of this message.

The content of the custom message.

Identifies the type of this message.

The unique ID that identifies this message.

Identifies the sending time of a message

Displays the userID of the sender of this message.

Conversation ID. Ids of the same conversation type are unique.

Used to describe whether a message is sent or received.

Describes the sending status of a message.

The type of conversation to which the message belongs.

Indicates the sequence number of the message in the conversation.

The larger the orderKey, the newer the message, and can be used for ordering messages.

SDK locally generated MessageID, developers do not need to pay attention to.

Detail description: Describes whether the message is a message inserted by the developer through [insertMessageToLocalDB].

Default: false.

Describe the receipt status of the message

Business scenario: used to determine the status of the current message in the receipt message

message extension field

The expandable message field visible only on this end can store additional information locally, Through [updateMessageLocalExtendedData] change and currently has a length limit of 128K. If you have special requirements, please contact ZEGO technical support for configuration.

Whether the message is pushed by all employees.

Whether to mention everyone. It can be presented as "@Everyone".

Whether to mention everyone. It can be presented as "@User".

Indicates the sequence number of the message in the conversation.

The number of reply messages corresponding to the root message of the reply message tree.

Information about the source message referenced by the reply message.

The latest editor's userID for this message.

The latest editing timestamp for this message.

Identify if this message is group targeted message.

The last user who pinned this message.

The last timestamp when pinned this message.

conversationID.

conversationName is the same as the groupName/userName value corresponding to the session.

conversation type.

Session unread.

last message.

OrderKey is used to describe the order of messages in the session. The larger orderKey is, the newer it is.

session notification status.

Detail description: Conversation avatar URL. The peer to peer chat conversation avatar URL is the same as the user avatar URL, and the group chat conversation avatar URL is the same as the group avatar URL.

Use Limit: the maximum number of characters is 500 bytes. There is no limit on special characters.

Whether the conversation is pinned.

When reminded in a message or reminded to everyone in a conversation, this array will record the reminders.

After the friend remarks are set through [updateFriendAlias], this parameter is changed for each chat conversation. After setting a group alias by [updateGroupAlias], the corresponding group chat conversation's parameter will be modified synchronously.

Describes all the existing marks for the conversation.

Conversation draft, when draft set conversation will carry this parameter.

conversationID.

conversation type.

session events.

Session specific information.

Whether to delete the conversation on the server

Conversation marks. Only integers in the range [1, 20] are supported. If the list contains -1, the query result will be all marked conversation; if the list contains 0, the query result will be all unmarked conversations; if multiple markers are passed, the query result will be the union of all passed markers; if the list is empty, the query result will be all conversations.

Conversation types. Only support one-on-one and group conversations.

Whether to only query conversations with unread counts. Pass true to only query conversations with unread counts. Pass false to query without considering whether conversations have unread counts.

Session that needs to be queried.

The number of sessions to query.

Pagination token, fill in 0 initially, and then fill in the nextFlag returned from the callback to retrieve data for the next page.

The number of messages that can be retrieved in one search. It is recommended to be less than 20 to reduce performance overhead.

The number of local messages that can be retrieved for a single conversation in one search. It is recommended to be less than 10 to reduce performance overhead.

Search keywords, supports up to 5. Otherwise, an error will occur. For example, if you pass in "1" and "2", the search results will only display conversations that contain both "1" and "2" keywords in the messages.

Message types, can be used to specify message types. Support passing in multiple types.

The subtypes of custom messages have a value range of [0,200]. Developers can use this range to search for specific custom types.

Send user ID, supports up to 5. For example, if you pass in "zego2023", the search results will only display conversations where messages have been sent by the user "zego2023".

The starting point of the search, in milliseconds, with a default value of 0. The format is UTC timestamp.

The ending point of the search, which must be greater than the startTime, in milliseconds. The default value is 0 and the format is UTC timestamp.

The conversation ID of the local message to be search.

conversation type.

Total message count

Search results of messages.

Conversation marks. Only integers in the range [1, 20] are supported. If the list contains -1, the query result will be all marked conversation; if the list contains 0, the query result will be all unmarked conversations; if multiple markers are passed, the query result will be the union of all passed markers; if the list is empty, the query result will be all conversations.

Conversation types. Only support one-on-one and group conversations.

Number of sessions that were deleted.

The text content of the message.

The subtype of the message, which is used by customers to customize the usage of different custom messages.

Search fields for custom messages. Since you cannot search for a custom message by directly searching the message field, you can concatenate the content you want to be searched in the custom message (such as the title of the poll, etc.) and put it in this parameter (the length is 64 bytes by default), so that follow-up search.

Identifies the type of this message.

The unique ID that identifies this message.

Identifies the sending time of a message

Displays the userID of the sender of this message.

Conversation ID. Ids of the same conversation type are unique.

Used to describe whether a message is sent or received.

Describes the sending status of a message.

The type of conversation to which the message belongs.

Indicates the sequence number of the message in the conversation.

The larger the orderKey, the newer the message, and can be used for ordering messages.

SDK locally generated MessageID, developers do not need to pay attention to.

Detail description: Describes whether the message is a message inserted by the developer through [insertMessageToLocalDB].

Default: false.

Describe the receipt status of the message

Business scenario: used to determine the status of the current message in the receipt message

message extension field

The expandable message field visible only on this end can store additional information locally, Through [updateMessageLocalExtendedData] change and currently has a length limit of 128K. If you have special requirements, please contact ZEGO technical support for configuration.

Whether the message is pushed by all employees.

Whether to mention everyone. It can be presented as "@Everyone".

Whether to mention everyone. It can be presented as "@User".

Indicates the sequence number of the message in the conversation.

The number of reply messages corresponding to the root message of the reply message tree.

Information about the source message referenced by the reply message.

The latest editor's userID for this message.

The latest editing timestamp for this message.

Identify if this message is group targeted message.

The last user who pinned this message.

The last timestamp when pinned this message.

The text content of the message.

The subtype of the message, which is used by customers to customize the usage of different custom messages.

Search fields for custom messages. Since you cannot search for a custom message by directly searching the message field, you can concatenate the content you want to be searched in the custom message (such as the title of the poll, etc.) and put it in this parameter (the length is 64 bytes by default), so that follow-up search.

Identifies the type of this message.

The storage path of the log files. Refer to the official website document for the default path.

Error infomation description.

User ID, a string with a maximum length of 32 bytes or less. It is customized by the developer. Only support numbers, English characters and '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'.

Description Reason for the query failure.

Expiration stamp of cache cleanup.

Total file size in bytes (B).

Example Query the expiration timestamp of the cache.

Detail description: The external download url of the media message is used for the developer to transparently transmit the media file to other users by filling in this URL when the developer uploads the media file to his own server.

Required or not: If an external URL is sent, this parameter is mandatory on the sender end.

Detail description: The unique ID of the media file.

Required or not: The sender does not need to fill in, this value is generated by the SDK.

Detail description: The filename of the media file.

Required or not: If you are sending an external URL, you need to fill in this value and include the file extension. If a local file is sent, the value is optional.

Detail description: The size of the media file.

Required or not: The sender does not need to fill in, this value is generated by the SDK.

Identifies the type of this message.

The unique ID that identifies this message.

Identifies the sending time of a message

Displays the userID of the sender of this message.

Conversation ID. Ids of the same conversation type are unique.

Used to describe whether a message is sent or received.

Describes the sending status of a message.

The type of conversation to which the message belongs.

Indicates the sequence number of the message in the conversation.

The larger the orderKey, the newer the message, and can be used for ordering messages.

SDK locally generated MessageID, developers do not need to pay attention to.

Detail description: Describes whether the message is a message inserted by the developer through [insertMessageToLocalDB].

Default: false.

Describe the receipt status of the message

Business scenario: used to determine the status of the current message in the receipt message

message extension field

The expandable message field visible only on this end can store additional information locally, Through [updateMessageLocalExtendedData] change and currently has a length limit of 128K. If you have special requirements, please contact ZEGO technical support for configuration.

Whether the message is pushed by all employees.

Whether to mention everyone. It can be presented as "@Everyone".

Whether to mention everyone. It can be presented as "@User".

Indicates the sequence number of the message in the conversation.

The number of reply messages corresponding to the root message of the reply message tree.

Information about the source message referenced by the reply message.

The latest editor's userID for this message.

The latest editing timestamp for this message.

Identify if this message is group targeted message.

The last user who pinned this message.

The last timestamp when pinned this message.

Detail description: The external download url of the media message is used for the developer to transparently transmit the media file to other users by filling in this URL when the developer uploads the media file to his own server.

Required or not: If an external URL is sent, this parameter is mandatory on the sender end.

Detail description: The filename of the media file.

Required or not: If you are sending an external URL, you need to fill in this value and include the file extension. If a local file is sent, the value is optional.

Detail description: The size of the media file.

Required or not: The sender does not need to fill in, this value is generated by the SDK.

Identifies the type of this message.

Add a friend postscript.

Alias of friend.

Friend attributes. Up to 5 can be set. The key of the attribute can only be selected from k0 to k4.

friend alias.

friend attributes.

Offline push configuration

Detail description: If you are the applicant, here is the respondent information; if you are the respondent, here is the applicant information;

The wording of friend application information.

Friend add time.

Friend application status update time.

Friend application type.

Friend application state.

Total number of current queries.

The index of the current query anchor point.

Offline push configuration

Add a friend postscript.

Alias of friend.

Friend attributes. Up to 5 can be set. The key of the attribute can only be selected from k0 to k4.

Offline push configuration.

Delete type.

Detail description: UserID of the operator.

The alias of friend.

Friend attributes. Up to 5 can be set. The key of the attribute can only be selected from k0 to k4.

Friend add time.

User name, defined by you. For version 2.0.0 and onwards, the string has a maximum length of 256 bytes.

The user avatar, which is custom generated by the developer, is not restricted by special characters and has a maximum length of 500 bytes.

Extended field information of the user.

Total number of current queries.

The index of the current query anchor point.

Check type.

user ID.

Friend relationship type.

Search keyword list.

Whether to match friend aliases.

Current total number of searches.

The starting and ending index of the current search.

basic group information.

group message notification status.

the group alias defined by user, which is visible only to that user.

Group properties, up to 10 can be configured..

group notice.

The maximum number of group members.

Verification mode for joining the group.

Verification mode for invite to the group.

Verification mode for being invited to the group.

Detail description: The applicant is the applicant when applying to join, the invitee when applying to invite, and the inviter when applying by invitation.

The wording of group application information.

Group application create time.

Group application status update time.

Group application type.

Group application state.

Group information for applying to join the group.

The operator who agrees to join the group application.

count. It is advised to be no more than 30.

nextFlag.

Group attribute update action.

group properties.

The expiration date of the group gag.

Whether the group session is unavailable.

conversationID.

conversationName is the same as the groupName/userName value corresponding to the session.

conversation type.

Session unread.

last message.

OrderKey is used to describe the order of messages in the session. The larger orderKey is, the newer it is.

session notification status.

Detail description: Conversation avatar URL. The peer to peer chat conversation avatar URL is the same as the user avatar URL, and the group chat conversation avatar URL is the same as the group avatar URL.

Use Limit: the maximum number of characters is 500 bytes. There is no limit on special characters.

Whether the conversation is pinned.

When reminded in a message or reminded to everyone in a conversation, this array will record the reminders.

After the friend remarks are set through [updateFriendAlias], this parameter is changed for each chat conversation. After setting a group alias by [updateGroupAlias], the corresponding group chat conversation's parameter will be modified synchronously.

Describes all the existing marks for the conversation.

Conversation draft, when draft set conversation will carry this parameter.

Group entry type.

The timestamp of the server when joining the group.

The operator who agrees to the application to join the group or the inviter who invites the application to join the group.

basic group information.