Set Fields for Multiple Users on the Same ConversationID

Brief Description

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

Request Method

• post

Request URL

• {API_ADDRESS}/conversation/set_conversations

Header

Header Name	Example Value	Optional	Type	Description
operationID	1646445464564	Required	string	Used for global trace tracking. It is recommended to use a timestamp, unique for each request
token	eyJhbxxxx3Xs	Required	string	Admin token

Request Parameters Example

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

Field Name	Optional	Type	Description
userIDs	Required	array	List of user IDs for whom conversation fields are to be set
conversation	Required	object	Conversation object
conversation.conversationID	Required	string	ConversationID
conversation.conversationType	Required	int	Conversation type: 1 for single chat, 3 for group chat
conversation.userID	Optional	string	Required for single chat
conversation.groupID	Optional	string	Required for group chat
conversation.recvMsgOpt	Optional	int	Mute status for the conversation
conversation.attachedInfo	Optional	string	Attached information for the conversation, reserved field
conversation.isPinned	Optional	boolean	Whether the conversation is pinned
conversation.isPrivateChat	Optional	boolean	Enables self-destruct mode for messages
conversation.ex	Optional	string	Extended field for the conversation
conversation.burnDuration	Optional	int	Self-destruct time for messages in seconds

Success Response Example

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

Success Response Parameters Description

Parameter Name	Type	Description
errCode	int	Error code, 0 indicates success
errMsg	string	Brief error message, empty if none
errDlt	errDlt	Detailed error information, empty if none
data	object	General data object, see structure below

Failure Response Example

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

Failure Response Parameters Description

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