METHOD_StartTyping

This method sends a notification to BEMS that the user is typing a message in the chat.

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

Parameter

Type

 Required

Description

contactId

String

 √

This parameter specifies the SIP address of the user that is typing the message.

chatId

String

 √

This parameter specifies the unique identifier for the chat session.

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.
The following table lists the message results based on the response for the contactId and chatId from the BlackBerry Connect app. You must have the correct chatId and contactId to send a message to the recipient successfully.

contactId

chatId

Result

correct

correct

Success

correct

in-correct

Success

in-correct

correct

Error message received

in-correct

in-correct

Error message received

BEMS response and notification

The following table describes the parameters that BEMS and the notification to send to the BlackBerry Connect app when the user starts typing in a chat session.

Parameter

Type

Description

method

String

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

contactId

String

This parameter specifies the SIP address of the user that is typing the message.

Code sample

The following code example sends a notification to BEMS that the user is typing a message in a chat.

{
  "id":"c12",
  "method":"StartTyping",
  "params":
   {
      "contactId":"sip:user1@example.com",
      "chatId":"dbc2e7b6-25e8-450e-9670-c9e4f32341bb"
   },
  "jsonrpc":"2.0"
}

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

{
 "id": "c12",
 "error": null,
 "result": 
  {
   "data": 
    {
     "method":"StartTyping",
     "state":"PROCESSING"
    }
  },
  "jsonrpc":"2.0",
  "background":false
}
If there are no errors, BEMS sends the following notification to the BlackBerry Connect app and the user types the message. 
{
 "id": "c12",
 "sequence":1018698700000065,
 "result": 
   {
    "data": 
     {
      "method":"StartTyping",
      "state":"COMPLETE"
     }
   },
  "jsonrpc":"2.0"
}