METHOD_RemoveContactFromGroup

This method sends a request to BEMS to remove a contact from the user's a group.

The following table describes the parameters that you can include in this method.

Parameter

Type

 Required

Description

contactId

String

 √

This parameter specifies the ID of the contact to remove from the group.

groupId

String

 —

This parameter specifies the ID of the group from which the contact is to be removed from.

dependencies String — This parameter specifies the other methods that this method is dependent on. It specifies the comma delimited dependent request ids.
reconnect String — This parameter specifies that the BlackBerry Connect app re-establish the existing session. For example, if BlackBerry Connect goes to the background, when it comes to the foreground the same session is continued.

BEMS response and notification

The following table describes the parameters that BEMS returns and the notification to send to the BlackBerry Connect app when a contact is removed from a group.

Parameter

Type

Description

method

String

This parameter specifies the invoked method (for example, RemoveContactFromGroup).

state String This parameter specifies the state of the request to BEMS (for example, Processing or Complete).
message String

This parameter specifies the message that is sent to the BlackBerry Connect app.

Example code

The following example sends a request to BEMS to remove "user1" from a group.

{
  "method":"RemoveContactFromGroup",  
  "params":
    {     
     "contactId":"sip:user1@example.com",
     "groupId":"1"
    },
  "id":"c58",
  "jsonrpc":"2.0"
}

If the request is successful, BEMS sends the following response to the BlackBerry Connect app and processes the request.

{
  "id":"c58",  
  "error": null,
  "result": 
   {
     "data": 
       {
         "method":"RemoveContactFromGroup",
         "state":"PROCESSING"
       }
   },
 "jsonrpc":"2.0",
 "background":false
}
If there are no errors, BEMS sends the following notification to the BlackBerry Connect app and the contact is removed from the group. 
{
  "id":"c58",
  "sequence":1018691400000048,
  "result": 
   {
    "data": 
     {
       "message":"Remove contact from group success.",
       "method":"RemoveContactFromGroup",
       "state":"COMPLETE"
     }
   },
  "jsonrpc":"2.0"
}