Как добавить Примечание в сделку / API AmoCRM?

Question

[Elena_11]

Здравствуйте, передаю заявки с сайта в амо и имею следующий массив:

$data = [
   	[
       'name' => $title,
       "responsible_user_id" => (int) $user_amo,
       "pipeline_id" => (int) $pipeline_id, 
   
       "_embedded" => [

           "contacts" => [
                [
                    "first_name" => $fio,
                    "custom_fields_values" => [
                        [
                            "field_code" => "EMAIL",
                            "values" => [
                                [
                                    "enum_code" => "WORK",
                                    "value" => $email
                                ]
                            ]
                        ],
                        [
                            "field_code" => "PHONE",
                            "values" => [
                                [
                                    "enum_code" => "MOB",
                                    "value" => $phone
                                ]
                            ]
                        ],
                    ]
                ]
            ],
        ],
      ]
   ];

Сделка попадает в амо, но каким образом я могу создать примечание внутри сделки? Внутри массива можно прописать примечание? По документации я не разобралась, пробую ничего не выходит. Направьте на путь истинный. Использую $method = "/api/v4/leads/complex";

Я пробовала в массиве прописывать:

"notes" => [
            {
                "note_type" => "common",
                "params" => {
                    "text" => "Текст примечания 2"
                },
            },
        ]

Не помогло, видимо я неверно понимаю документацию. Помогите, пожалуйста, разобраться

Answer 1

[Валерий Чмых]

Одним запросом вы это не сделаете. Вам надо создать сделку, из ответа получить ее id и использовать запрос на создание примечания

Comments

[Elena_11]

Спасибо за комментарий, если бы вы мне это не написали, то из документации я бы и не догадалась, потому что документация амо по-моему совершенно не помогает... Там только примеры ответов и параметры, а примера как добавить примечание через api нет. Заявка создаётся из кода выше, но что конкретно дальше делать не понимаю. Как конкретно получить id и каким именно запросом можно создать примечание? Может какой-то рабочий пример есть

[Валерий Чмых]

Elena_11, я не согласен с вами. У них довольно хорошая документация. Вам просто нужно понять, что всё, что вы создаёте в amo, является сущностью. В документации описаны практически все сущности и принципы работы с ними.
Пример я вам дать не могу так как не знаю вашу реализацию работы с API. Но концепт будет такой
1. Вы используете Комплексное добавление сделок, то есть отправляете запрос на POST /api/v4/leads/complex в ответе вам должен придти массив объектов (если вы передаете на создания лишь одну сделку, то и массив будет из одного объекта). Предположим вы записываете ответ в переменную $response.
2. Вам надо использовать запрос на добавление примечания POST /api/v4/{entity_type}/{entity_id}/notes соответственно вам надо заменить {entity_type} на leads так как примечание добавляется в сделку и заменить {entity_id} на id созданной вами сделки - он у вас будет в $response[0]['id']

Если нужны уточнения - спрашивайте

[Elena_11]

Валерий Чмых, Большое спасибо за развёрнутый ответ по существу. Вот отрывок кода, отвечающий за добавление сделки. Там в конце как раз есть $response. Он подойдёт для того, чтобы вытащить id? Только вот как именно прописать запрос на добавление комментария я как раз и не понимаю...

$method = "/api/v4/leads/complex";

$headers = [
    'Content-Type: application/json',
    'Authorization: Bearer ' . $access_token,
];

$curl = curl_init();
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_USERAGENT, 'amoCRM-API-client/1.0');
curl_setopt($curl, CURLOPT_URL, "https://$subdomain.amocrm.ru".$method);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_HEADER, false);
curl_setopt($curl, CURLOPT_COOKIEFILE, 'amo/cookie.txt');
curl_setopt($curl, CURLOPT_COOKIEJAR, 'amo/cookie.txt');
curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, 0);
curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, 0);
$out = curl_exec($curl);
$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);
$code = (int) $code;
$errors = [
    301 => 'Moved permanently.',
    400 => 'Wrong structure of the array of transmitted data, or invalid identifiers of custom fields.',
    401 => 'Not Authorized. There is no account information on the server. You need to make a request to another server on the transmitted IP.',
    403 => 'The account is blocked, for repeatedly exceeding the number of requests per second.',
    404 => 'Not found.',
    500 => 'Internal server error.',
    502 => 'Bad gateway.',
    503 => 'Service unavailable.'
];

if ($code < 200 || $code > 204) die( "Error $code. " . (isset($errors[$code]) ? $errors[$code] : 'Undefined error') );


$Response = json_decode($out, true);
$Response = $Response['_embedded']['items'];
$output = 'ID добавленных элементов списков:' . PHP_EOL;
foreach ($Response as $v)
    if (is_array($v))
        $output .= $v['id'] . PHP_EOL;
return $output;

[Валерий Чмых]

Elena_11,
Накидал по быстрому пример, надеюсь поможет

<?php

function createAmoClient($domain, $accessToken)
{
    $headers = [
        'Content-Type: application/json',
        'Authorization: Bearer ' . $accessToken,
    ];

    return function ($method, $url, $data = null) use ($domain, $headers) {
        $curl = curl_init();
        curl_setopt($curl, CURLOPT_URL, $domain . $url);
        curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($curl, CURLOPT_CUSTOMREQUEST, $method);
        curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
        curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, 0);
        curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, 0);
        if ($data !== null) {
            curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($data));
        }
        $response = curl_exec($curl);
        $httpcode = curl_getinfo($curl, CURLINFO_HTTP_CODE);

        curl_close($curl);

        return [
            'content' => is_bool($response) ? $response : json_decode($response, 1),
            'status_code' => $httpcode
        ];
    };
}

$amoClient = createAmoClient('https://subdomain.amocrm.ru', 'Тут access token');

$response = $amoClient('POST', '/api/v4/leads/complex', [
    [
        'name' => 'Название сделки',
    ]
]);

$amoClient('POST', "/api/v4/leads/{$response['content'][0]['id']}/notes", [
    [
        'note_type' => 'common',
        'params' => [
            'text' => 'Примечание'
        ]
    ]
]);

[Elena_11]

Валерий Чмых, попробовала - заявки приходят, но примечание не добавляется



здесь точно через скобки фигурные id вставляется? редактор подсвечивает всё как обычный текст. Пробовала через точку переменную прописать, но тоже не добавляется примечание

[Валерий Чмых]

Elena_11, Конечно, это интерполяция. Код проверял - сделка и примечание создавались.
Попробуйте после создания сделки вывести через var_dump, что находится в response
А так же добавить $response для создания примечания и так же вывести

Как-то так

<?php

function createAmoClient($domain, $accessToken)
{
    $headers = [
        'Content-Type: application/json',
        'Authorization: Bearer ' . $accessToken,
    ];

    return function ($method, $url, $data = null) use ($domain, $headers) {
        $curl = curl_init();
        curl_setopt($curl, CURLOPT_URL, $domain . $url);
        curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($curl, CURLOPT_CUSTOMREQUEST, $method);
        curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
        curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, 0);
        curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, 0);
        if ($data !== null) {
            curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($data));
        }
        $response = curl_exec($curl);
        $httpcode = curl_getinfo($curl, CURLINFO_HTTP_CODE);

        curl_close($curl);

        return [
            'content' => is_bool($response) ? $response : json_decode($response, 1),
            'status_code' => $httpcode
        ];
    };
}

$amoClient = createAmoClient('https://subdomain.amocrm.ru', 'Тут access token');

$response = $amoClient('POST', '/api/v4/leads/complex', [
    [
        'name' => 'Название сделки',
    ]
]);
var_dump($response);
$response = $amoClient('POST', "/api/v4/leads/{$response['content'][0]['id']}/notes", [
    [
        'note_type' => 'common',
        'params' => [
            'text' => 'Примечание'
        ]
    ]
]);
var_dump($response);

[Elena_11]

Валерий Чмых, хочу уточнить - $domain это же subdomain имеется ввиду? который указывается при авторизации. В общем и так и так тестировала. Заявки уходят только с моим запросом (который выше присылала).

С вашим вариантом вот (токен добавляла где указано):

array(2) { ["content"]=> NULL ["status_code"]=> int(402) } array(2) { ["content"]=> array(4) { ["title"]=> string(9) "Not Found" ["type"]=> string(25) "https://httpstatus.es/404" ["status"]=> int(404) ["detail"]=> string(53) "Cannot POST https://subdomain.amocrm.ru/leads//notes!" } ["status_code"]=> int(404) }

[Валерий Чмых]

Elena_11,

$amoClient = createAmoClient('https://subdomain.amocrm.ru', 'Тут access token');

тут вам надо заменить https://subdomain.amocrm.ru на свой адрес amo например https://test23032025.amocrm.ru, и вместо Тут access token подставить ваш access token

[Elena_11]

Валерий Чмых, ураа, примечание добавилось, там просто токены же обновляются, надо было подключить require_once 'access.php'; и переменную с токеном вставить $access_token, а я секретный ключ вставляла. А в мой запрос это нельзя было интегрировать? Он не подходит по каким-то причинам или почему полностью заново переписали? Там же вроде сделка создаётся, в теории я же могу в мой код добавить кусочек с комментарием?

[Валерий Чмых]

Elena_11, можете и в свой интегрировать, но у вас как пример лишние параметры в curl CURLOPT_COOKIEFILE/CURLOPT_COOKIEJAR - это еще со времен когда была авторизация по api ключу
Так же у себя вы не закрываете соединение curl после запроса - отсутствует curl_close($curl);
Так же под каждый запрос вам приходилось бы дублировать часть кода отвечающие за запросы.

Я лишь дал пример с более "правильной" структурой кода. А пользоваться этой реализацией или переписать под то как вам удобно уже на ваше усмотрение.