update_conversation

Brief Description

• Multiple users 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	Optional	Type	Description
operationID	1646445464564	Required	string	operationID is used for global link tracking
token	eyJhbxxxx3Xs	Required	string	Administrator token

Request Sample Parameters

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

Field Name	Optional	Type	Description
userIDs	Required	string[]	list of usersn who set the conversation
conversationID	Required	string	ID of the conversation being set
conversationType	Required	int	conversation type, single chat is 1, group chat is 3
userID	Optional	string	userID, required when it's single chat
groupID	Optional	string	groupID, required when it's group chat
recvMsgOpt	Optional	int	conversation muted state
isPinned	Optional	boolean	whether conversation is pinned
isPrivateChat	Optional	boolean	whether conversation is deleted after reading
ex	Optional	string	extension
burnDuration	Optional	string	time interval for delete after reading, unit is second

Successful Return Sample

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

Successful Return Sample Explanation

Parameter Name	Type	Description
errCode	int	Error code, 0 indicates success
errMsg	string	Brief error message, empty when no error
errDlt	errDlt	Detailed error message, empty when no error

Failed Return Sample

{
  "errCode": 1001,
  "errMsg": "ArgsError",
  "errDlt": "userID is empty: 1001 ArgsError"
}

Failed Return Sample Explanation

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