Views: 622
Last Modified: 08.02.2022

Sends status "writing to..."

Revision Get current information about current API revision (platform version) – im.revision.get : 30

Parameters

Parameter Example Required Description Revision
DIALOG_ID 13 Yes Dialog ID. Format:
  • chatXXX – recipient chat, in case of chat
  • or
  • XXX – recipient ID, in case of private conversation
30

Called method and response

JavaScript

B24.callMethod(
  'im.dialog.writing',
  {},
  function(result){
    if(result.error())
    {
        console.error(result.error().ex);
    }
    else
    {
        console.log(result.data());
    }
});

Response example

true

Example of response on error

{
    "error": "CHAT_ID_EMPTY",
    "error_description": "Chat ID not passed"
}

Key description:

  • error – error code
  • error_description – error brief description

Possible error codes

Code Description
DIALOG_ID_EMPTY Parameter DIALOG_ID not passed on doesn't match to format XXX
CHAT_ID_EMPTY Parameter DIALOG_ID not passed or doesn't match the format chatXXX
ACCESS_ERROR User doesn't have access permission to this chat




Courses developed by Bitrix24