Documentation

imopenlines.crm.chat.get

Scope: imopenlines Permissions: for all

Gets active chats for CRM entity.

Parameters

Parameter Required Description
CRM_ENTITY_TYPE yesCRM entity type (lead/deal/company/contact).
CRM_ENTITY yesCRM entity ID.

Example

BX24.callMethod('imopenlines.crm.chat.get', {
	CRM_ENTITY_TYPE: 'deal', //lead|deal|company|contact
	CRM_ENTITY: 288,
}, function(result) {
	if(result.error())
	{
		console.error(result.error().ex);
	}
	else
	{
		console.log(result.data());
	}
});

Response

Array with objects containg chat ID, connector ID and name.

Response example

{
	"result": [
		{
			"CHAT_ID": "9852",
			"CONNECTOR_ID": "livechat",
			"CONNECTOR_TITLE": "\u041e\u043d\u043b\u0430\u0439\u043d-\u0447\u0430\u0442"
		}
	]
}

Possible error codes

Code Description
ACCESS_DENIED Current user doesn't have access.
ERROR_ARGUMENT One of arguements isn't specified or specified incorrectly.


© «Bitrix24», 2001-2024