Set Fields for Multiple Users in the Same Conversation

Brief Description

• Allows multiple users to selectively set fields for the same conversation.

Request Method

• post

Request URL

• http://x.x.x.x:10002/conversation/set_conversations

Header

Header Name	Example Value	Required	Type	Description
operationID	1646445464564	Required	string	The operationID is used for global tracing.
token	eyJhbxxxx3Xs	Required	string	Admin token

Request Parameter Example

{
  "userIDs": [
    "6965946400"
  ],
  "conversation": {
    "conversationID": "si_4365007572_6965946400",
    "conversationType": 1,
    "userID": "4365007572",
    "groupID": "",
    "recvMsgOpt": 0,
    "isPinned": false,
    "isPrivateChat": true,
    "ex": "",
    "burnDuration": 30
  }
}

Field Name	Required	Type	Description
userIDs	Required	array	List of user IDs for whom the conversation fields will be set.
conversation	Required	object	Conversation object.
conversation.conversationID	Required	string	Conversation ID.
conversation.conversationType	Required	int	Conversation type, 1 for single chat, 3 for group chat.
conversation.userID	Optional	string	Required if the conversation type is single chat.
conversation.groupID	Optional	string	Required if the conversation type is group chat.
conversation.recvMsgOpt	Optional	int	Conversation do-not-disturb status.
conversation.isPinned	Optional	boolean	Whether the conversation is pinned.
conversation.isPrivateChat	Optional	boolean	Whether the private chat (self-destructing messages) feature is enabled.
conversation.ex	Optional	string	Conversation extension field.
conversation.burnDuration	Optional	string	Set the self-destruct timer for the conversation, in seconds.

Successful Response Example

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": ""
}

Successful Response Parameters Description

Parameter Name	Type	Description
errCode	int	Error code, 0 indicates success.
errMsg	string	Brief error message, empty if there is no error.
errDlt	string	Detailed error message, empty if there is no error.
data	object	Common data object, see below for the specific structure.

Failed Response Example

{
  "errCode": 1004,
  "errMsg": "RecordNotFoundError",
  "errDlt": ": [1004]RecordNotFoundError"
}

Failed Response Parameters Description

Parameter Name	Type	Description
errCode	int	Error code, refer to the global error code documentation for details.
errMsg	string	Brief error message.
errDlt	string	Detailed error message.