PHP Класс Bitrix24\CRM\Contact

Наследование: extends Bitrix24\Bitrix24Entity
Показать файл Открыть проект

Открытые методы

Метод Описание
add ( array $fields = [], array $params = [] ) : array Add a new contact to CRM
delete ( integer $bitrix24UserId ) : array Deletes the specified contact
fields ( ) : array get list of contact fields with description
get ( integer $bitrix24UserId ) : array Get contact by identifier
getList ( array $order = [], array $filter = [], array $select = [], integer $start ) : array Get list of contact items.
update ( integer $contactId, array $fields = [], array $params = [] ) : array

Описание методов

add() публичный Метод

Add a new contact to CRM
public add ( array $fields = [], array $params = [] ) : array
$fields array array of fields
$params array array of params
Результат array

delete() публичный Метод

Deletes the specified contact
public delete ( integer $bitrix24UserId ) : array
$bitrix24UserId integer contact identifier
Результат array

fields() публичный Метод

get list of contact fields with description
public fields ( ) : array
Результат array

get() публичный Метод

Get contact by identifier
public get ( integer $bitrix24UserId ) : array
$bitrix24UserId integer contact identifier
Результат array

getList() публичный Метод

Get list of contact items.
public getList ( array $order = [], array $filter = [], array $select = [], integer $start ) : array
$order array - order of task items
$filter array - filter array
$select array - array of collumns to select
$start integer - entity number to start from (usually returned in 'next' field of previous 'crm.contact.list' API call)
Результат array

update() публичный Метод

public update ( integer $contactId, array $fields = [], array $params = [] ) : array
$contactId integer Specifies the contact ID
$fields array An array in format array("field"=>"value"[, ...]) containing values for the fields that need to be updated. The fields can be one or more of those returned by crm.contact.fields.
$params array Set of parameters. REGISTER_SONET_EVENT - performs registration of a change event in a contact in the Activity Stream. The contact's Responsible person will also receive notification.
Результат array