Moderation

Block User#

Block User method uses to block the User from sending a message to us, it also hides our information from them. Use the below method by passing the JID of the user whom we are blocking.

caution

If Block/unblock feature is unavailable for your plan, then it will throw 403 exception

await SDK.blockUser(`TO_USER_JID`);

Request Param#

Status	Description	Type	Required
`TO_USER_JID`	JID of the To User	JID String	true

Unblock User#

To unblock the User use the below method.

caution

If Block/unblock feature is unavailable for your plan, then it will throw 403 exception

await SDK.unblockUser(`TO_USER_JID`);

Request Param#

Status	Description	Type	Required
`TO_USER_JID`	JID of the To User	JID String	true

Get Users I Blocked#

To get the list of Users whom we blocked, send a request as described below.

await SDK.getUsersIBlocked();

Response Format#

{
 statusCode: 200,
 message: "Success"
 data: [
  {
    jid: "", // String - Jid of the User
  },
  //...
];
}

Get Users Who Blocked Me#

To get the list of Users who blocked Us, send a request as described below.

await SDK.getUsersWhoBlockedMe();

Response Format#

{
 statusCode: 200,
 message: "Success"
 data: [

  {
    jid: "", // String - Jid of the User
  },
  //...
];
}

User/Group Blocked/Unblocked By Admin#

Handles Blocked/Unblocked response from Admin Console for the user/group. This response is triggered when the console admin particularly blocks/unblocks an user/group in Callback adminBlockListener . Receives Blocked User/groups 's UserId and Jid with blocked status.

Report User Or Group#

To Report a User or Group by another User.

caution

If Report feature is unavailable for your plan, then it will throw 403 exception

await SDK.reportUserOrGroup(`TO_USER_JID`, `CHAT_TYPE`, `ARRAY_OF_MESSAGE_OBJECT`);

Request Params#

Status	Description	Type	Required
`TO_USER_JID`	JID of User/Group to be reported	JID String	true
`CHAT_TYPE`	Chat type either User/Group	String	true
`ARRAY_OF_MESSAGE_OBJECT`	Message data Object that has to reported	Array of Object	true

Sample request Format#

await SDK.reportUserOrGroup(
 "12345678@xmpp.chatsystem.dev.contus.us",        // JID
 "chat",                                          // chat / groupchat
 [{
    msgId: "54333a85-2bee-4b1d-bbc3-1b8436096da7",
    message: "abc",
    msgType: "text",
    filename: "",
    timestamp: 1707309958682,
    publisherId: "919876543210"
 }])

Response Params#

Arguments	Description	Type
statusCode	Status Code	Number
message	Success/Error Message	String

Enable/Disable Media Encryption#

To enable/disable the media encryption which was storing in the storage server. By default encryption will be false.

await SDK.setMediaEncryption(`TRUE`);

Request Params#

Status	Description	Type	Required
`REASON`	true - enable the media encryption. false - disable the media encryption	Boolean	true

Response Params#

Arguments	Description	Type
statusCode	Status Code	Number
message	Success/Error Message	String