Реализуемый метод API

GET /api/v4/account

Официальная докуметация метода

Описание

Метод позволяет получить необходимую информацию по аккаунту, например: ID, название, справочник типов задач, группы пользователей и другие параметры.

Ограничения

Метод доступен всем пользователям аккаунта.

Различия

В документации метода AmoCRM сообщается о возможном необязательном параметре $string. На данный момент библиотека WT Amocrm его не поддерживает.

Возвращаемые значения

HTTP 200 Успешный ответ

Возвращаемое значение соответствует документации AmoCRM для этого метода.

Пример ответа

stdClass Object
(
    [id] => 29145784564
    [name] => yoursubdomian
    [subdomain] => yoursubdomian
    [created_at] => 1673927032
    [created_by] => 0
    [updated_at] => 1673927032
    [updated_by] => 0
    [current_user_id] => 6520033
    [country] => RU
    [currency] => RUB
    [currency_symbol] => ₽
    [customers_mode] => disabled
    [is_unsorted_on] => 1
    [mobile_feature_version] => 0
    [is_loss_reason_enabled] => 1
    [is_helpbot_enabled] => 
    [is_technical_account] => 1
    [contact_name_display_order] => 1
    [_links] => stdClass Object
        (
            [self] => stdClass Object
                (
                    [href] => https://yoursubdomian.amocrm.ru/api/v4/account
                )

        )

)

HTTP 40x Неудачный ответ

Официальная документация говорит о возможном коде ответа 401 Пользователь не авторизован. Библиотека WT Amocrm возвращает объект ошибки следующей структуры (пример для кода 404):

stdClass Object
(
    [error_code] => 404
    [error_message] => getAccountInfo function: Error while trying to get Account info from Amo CRM. Amo CRM API response: title: Not Found
type: https://httpstatus.es/404
status: 404
detail: Cannot GET https://yoursubdomain.amocrm.ru/account1!

)

Пример использования в коде

$amocrm = new Amocrm();
$result_amo_crm = $amocrm->getAccountInfo();
if(isset($result_amo_crm->error_code) && !empty($result_amo_crm->error_code)){
	return '<div class="alert alert-danger row">
				<div class="col-2 h1">'.$result_amo_crm->error_code.'</div>
				<div class="col-10">'.$result_amo_crm->error_message.'</div>
			</div>';
}
if(count((array)$result_amo_crm) > 0){
	$current_user_id = $result_amo_crm->current_user_id;
}