Создать цифровое рабочее место crm.automatedsolution.add

Scope: crm

Кто может выполнять метод: администратор Битрикс24 или пользователь с правом «Редактирование» или «Разрешить изменять настройки» в разделе «Цифровые рабочие места» прав доступа CRM

Метод crm.automatedsolution.add создает цифровое рабочее место.

В облачном Битрикс24 максимальное количество цифровых рабочих мест зависит от тарифа. В коробочной версии лимит задается опцией automated_solution_limit модуля crm, по умолчанию — 200. В лимит входят все рабочие места, в том числе установленные из Витрины.

Параметры методаПараметры метода

Обязательные параметры отмечены *

"fields": {
    "title": "значение",
    "typeIds": []
}

Параметр fieldsПараметр fields

Обязательные параметры отмечены *

Примеры кодаПримеры кода

Как использовать примеры в документации

1. Создать цифровое рабочее место и сразу привязать к нему смарт-процессы

   cURL (Webhook)

   cURL (OAuth)

   JS (TS)

   JS (UMD)

   Python

   PHP

   Go

   curl -X POST \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -d '{"fields":{"title":"HR","typeIds":[1,2,3]}}' \
   https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.automatedsolution.add
   

   curl -X POST \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -d '{"fields":{"title":"HR","typeIds":[1,2,3]},"auth":"**put_access_token_here**"}' \
   https://**put_your_bitrix24_address**/rest/crm.automatedsolution.add
   

   // This snippet is an ES module: top-level await requires type="module" or a bundler.
   // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
   import { Text } from '@bitrix24/b24jssdk'
   import type { B24Frame } from '@bitrix24/b24jssdk'
   
   declare const $b24: B24Frame
   
   // Shape of the payload returned in result (match the "response handling" section of the page)
   type AutomatedSolutionAddResult = {
     automatedSolution: {
       id: number
       title: string
       typeIds: number[]
     }
   }
   
   try {
     const response = await $b24.actions.v2.call.make<AutomatedSolutionAddResult>({
       method: 'crm.automatedsolution.add',
       params: {
         fields: {
           title: 'HR',
           typeIds: [1, 2, 3],
         },
       },
       requestId: Text.getUuidRfc4122()
     })
   
     // The payload is available only on a successful response
     if (!response.isSuccess) {
       console.error(response.getErrorMessages().join('; '))
     } else {
       const result = response.getData()!.result
       console.info(result.automatedSolution)
     }
   } catch (error) {
     // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
     console.error(error)
   }
   

   <!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
   <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
   <script>
     async function addAutomatedSolution() {
       try {
         // Initialize the SDK inside a Bitrix24 frame
         const $b24 = await B24Js.initializeB24Frame()
   
         const response = await $b24.actions.v2.call.make({
           method: 'crm.automatedsolution.add',
           params: {
             fields: {
               title: 'HR',
               typeIds: [1, 2, 3],
             },
           },
           requestId: B24Js.Text.getUuidRfc4122()
         })
   
         // The payload is available only on a successful response
         if (!response.isSuccess) {
           console.error(response.getErrorMessages().join('; '))
           return
         }
   
         const result = response.getData().result
         console.info(result.automatedSolution)
       } catch (error) {
         // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
         console.error(error)
       }
     }
   
     document.addEventListener('DOMContentLoaded', addAutomatedSolution)
   </script>
   

   from b24pysdk.errors import BitrixAPIError, BitrixSDKException
   
   try:
       bitrix_response = client.crm.automatedsolution.add(
           fields={
               "title": "HR",
               "typeIds": [
                   1,
                   2,
                   3,
               ],
           },
       ).response
       result = bitrix_response.result
       print(result)
   except BitrixAPIError as error:
       print(
           "Ошибка Bitrix API",
           f"error: {error.error}",
           f"error_description: {error.error_description}",
           sep="\n",
       )
   except BitrixSDKException as error:
       print(f"Ошибка Bitrix SDK: {error.message}")
   except Exception as error:
       print(f"Непредвиденная ошибка: {error}")
   

   require_once('crest.php');
   
   $result = CRest::call(
       'crm.automatedsolution.add',
       [
           'fields' =>
           [
               'title' => 'HR',
               'typeIds' => [1, 2, 3]
           ]
       ]
   );
   
   echo '<PRE>';
   print_r($result);
   echo '</PRE>';
   

   // client и ctx уже созданы — см. раздел «SDK для Go»
   res, err := client.Core().Call(ctx, "crm.automatedsolution.add", b24.Params{
   	"fields": b24.Params{
   		"title":   "HR",
   		"typeIds": []int{1, 2, 3},
   	},
   })
   if err != nil {
   	return fmt.Errorf("crm.automatedsolution.add: %w", err)
   }
   
   // Метод заворачивает ответ в объект с ключом "automatedSolution".
   raw, ok := b24.Unwrap(res.Result, "automatedSolution")
   if !ok {
   	return fmt.Errorf("в ответе нет ключа automatedSolution")
   }
   
   var item struct {
   	ID    b24.ID `json:"id"`
   	Title string `json:"title"`
   }
   if err := json.Unmarshal(raw, &item); err != nil {
   	return fmt.Errorf("разбор ответа: %w", err)
   }
   fmt.Println(item.ID, item.Title)
   

2. Создать цифровое рабочее место без смарт-процессов

   cURL (Webhook)

   cURL (OAuth)

   JS (TS)

   JS (UMD)

   Python

   PHP

   Go

   curl -X POST \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -d '{"fields":{"title":"HR"}}' \
   https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.automatedsolution.add
   

   curl -X POST \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -d '{"fields":{"title":"HR"},"auth":"**put_access_token_here**"}' \
   https://**put_your_bitrix24_address**/rest/crm.automatedsolution.add
   

   // This snippet is an ES module: top-level await requires type="module" or a bundler.
   // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
   import { Text } from '@bitrix24/b24jssdk'
   import type { B24Frame } from '@bitrix24/b24jssdk'
   
   declare const $b24: B24Frame
   
   // Shape of the payload returned in result (match the "response handling" section of the page)
   type AutomatedSolutionAddResult = {
     automatedSolution: {
       id: number
       title: string
       typeIds: number[]
     }
   }
   
   try {
     const response = await $b24.actions.v2.call.make<AutomatedSolutionAddResult>({
       method: 'crm.automatedsolution.add',
       params: {
         fields: {
           title: 'HR',
         },
       },
       requestId: Text.getUuidRfc4122()
     })
   
     // The payload is available only on a successful response
     if (!response.isSuccess) {
       console.error(response.getErrorMessages().join('; '))
     } else {
       const result = response.getData()!.result
       console.info(result.automatedSolution)
     }
   } catch (error) {
     // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
     console.error(error)
   }
   

   <!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
   <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
   <script>
     async function addAutomatedSolution() {
       try {
         // Initialize the SDK inside a Bitrix24 frame
         const $b24 = await B24Js.initializeB24Frame()
   
         const response = await $b24.actions.v2.call.make({
           method: 'crm.automatedsolution.add',
           params: {
             fields: {
               title: 'HR',
             },
           },
           requestId: B24Js.Text.getUuidRfc4122()
         })
   
         // The payload is available only on a successful response
         if (!response.isSuccess) {
           console.error(response.getErrorMessages().join('; '))
           return
         }
   
         const result = response.getData().result
         console.info(result.automatedSolution)
       } catch (error) {
         // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
         console.error(error)
       }
     }
   
     document.addEventListener('DOMContentLoaded', addAutomatedSolution)
   </script>
   

   from b24pysdk.errors import BitrixAPIError, BitrixSDKException
   
   try:
       bitrix_response = client.crm.automatedsolution.add(
           fields={
               "title": "HR",
           },
       ).response
       result = bitrix_response.result
       print(result)
   except BitrixAPIError as error:
       print(
           "Ошибка Bitrix API",
           f"error: {error.error}",
           f"error_description: {error.error_description}",
           sep="\n",
       )
   except BitrixSDKException as error:
       print(f"Ошибка Bitrix SDK: {error.message}")
   except Exception as error:
       print(f"Непредвиденная ошибка: {error}")
   

   require_once('crest.php');
   
   $result = CRest::call(
       'crm.automatedsolution.add',
       [
           'fields' =>
           [
               'title' => 'HR'
           ]
       ]
   );
   
   echo '<PRE>';
   print_r($result);
   echo '</PRE>';
   

   // client и ctx уже созданы — см. раздел «SDK для Go»
   res, err := client.Core().Call(ctx, "crm.automatedsolution.add", b24.Params{
   	"fields": b24.Params{
   		"title": "HR",
   	},
   })
   if err != nil {
   	return fmt.Errorf("crm.automatedsolution.add: %w", err)
   }
   
   // Метод заворачивает ответ в объект с ключом "automatedSolution".
   raw, ok := b24.Unwrap(res.Result, "automatedSolution")
   if !ok {
   	return fmt.Errorf("в ответе нет ключа automatedSolution")
   }
   
   var item struct {
   	ID    b24.ID `json:"id"`
   	Title string `json:"title"`
   }
   if err := json.Unmarshal(raw, &item); err != nil {
   	return fmt.Errorf("разбор ответа: %w", err)
   }
   fmt.Println(item.ID, item.Title)
   

Обработка ответаОбработка ответа

HTTP-статус: 200

{
    "result": {
        "automatedSolution": {
            "id": 1,
            "title": "HR",
            "typeIds": [
                1,
                2,
                3
            ]
        }
    },
    "time": {
        "start": 1715849396.642359,
        "finish": 1715849396.954623,
        "duration": 0.31226396560668945,
        "processing": 0.0068209171295166016,
        "date_start": "2024-05-16T11:49:56+03:00",
        "date_finish": "2024-05-16T11:49:56+03:00",
        "operating_reset_at": 1715849996,
        "operating": 0
    }
}

Возвращаемые данныеВозвращаемые данные

Объект automatedSolutionОбъект automatedSolution

Обработка ошибокОбработка ошибок

HTTP-статус: 400

{
    "error": "BX_EMPTY_REQUIRED",
    "error_description":"Не заполнено обязательное поле \"Название\""
}

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Продолжите изучениеПродолжите изучение

• Цифровые рабочие места: обзор методов
• Изменить цифровое рабочее место crm.automatedsolution.update
• Получить данные о цифровом рабочем месте по id crm.automatedsolution.get
• Получить список цифровых рабочих мест crm.automatedsolution.list
• Удалить цифровое рабочее место crm.automatedsolution.delete
• Получить поля цифрового рабочего места crm.automatedsolution.fields