Подключение номера телефона
Тело запроса является необязательным. Включайтеcatalog_id только в том случае, если агент должен использовать определенный каталог Meta.
Справочник API: POST Onboard Agent · GET Get Settings
403 обычно означает, что доступ к продукту или принятие условий не завершены. Ошибка 404 при последующих операциях на уровне номера телефона может означать, что Phone Number ID неверен или что у этого тенанта YCloud нет активной привязки агента Public API.
Настройка передачи оператору и последующих сообщений
Задайте эти сообщения и временные интервалы в рамках конфигурации агента до тестирования сценария передачи диалога человеку. Справочник API: GET Get Settings · PUT Replace Settings
Значением
followup_interval_in_seconds должно быть одно из следующих: 0, 300, 900, 1800, 3600, 7200, 28800 или 86400. Если handoff.message_selection имеет значение CUSTOM, укажите handoff.message.
YCloud обновляет только те параметры, которые переданы в запросе. Опустите never_say_phrases, чтобы сохранить текущий список. Отправьте пустой массив для его очистки или непустой массив для полной замены списка.
Настройка информации о компании
Используйте блок информации о компании для постоянных данных, актуальных для любых вопросов клиентов. Справочник API: GET Get Business Info · PUT Replace Business Info · DELETE Delete Business InfoДобавление часто задаваемых вопросов
Закрепляйте за каждым вопросом FAQ только одно намерение клиента. Обновляйте или удаляйте устаревшие ответы вместо добавления похожих дубликатов. Справочник API: GET List FAQs · POST Create FAQ · GET Get FAQ · PATCH Update FAQ · DELETE Delete FAQДобавление веб-сайтов и файлов
Используйте веб-сайты и файлы только тогда, когда их содержимое актуально и подходит для ответов клиентам. Справочник по API веб-сайтов: GET List Websites · POST Create Website · GET Get Website · PATCH Update Website · DELETE Delete Website Справочник по API файлов: GET List Files · POST Upload File · GET Get File · DELETE Delete File Создайте источник веб-сайта с егоurl. Используйте /websites/{websiteId}, чтобы получить, обновить или удалить его. Ответы по веб-сайту могут включать crawl_status, pages_crawled, last_crawled_at и created_at. Сканирование выполняется асинхронно, поэтому успешный ответ на создание не означает, что каждая страница уже проиндексирована.
Загрузите файл в виде multipart/form-data с одной частью с именем file:
/files; получить или удалить отдельный файл — по адресу /files/{fileId}.
Добавление поведенческих навыков
Навыки объясняют, как агент должен решать задачу. База знаний объясняет, какие факты верны. Справочник по API: GET List Skills · POST Create Skill · GET Get Skill · PATCH Update Skill · DELETE Delete Skillchannel, created_at и строковые метаданные.
Ставьте перед каждым навыком одну цель. Указывайте, когда его использовать, помещайте обязательные правила перед примерами и определяйте, что делать при отсутствии информации. Храните часто меняющиеся факты в информации о компании, FAQ, на веб-сайтах или в файлах.
Добавление навыков интерфейса (UI Skills)
UI Skills управляют тем, какие интерактивные компоненты WhatsApp может отображать агент. Поведенческие навыки определяют, как агент должен решать задачу. Справочник по API: GET List UI Skills · POST Create UI Skill · GET Get UI Skill · PATCH Update UI Skill · DELETE Delete UI Skill
Поддерживаемые типы компонентов:
carousel_quick_reply, carousel_url, cta_url, flow, image, interactive_list, interactive_reply_buttons, location и location_request.
Эндпоинт обновления изменяет только title, status и instruction. Создайте новый UI Skill, если вам требуется другой тип компонента или привязка к Flow. Запросы на получение списка поддерживают before, after и limit. Продолжайте постраничную навигацию, пока присутствует paging.next. Метки времени в ответе указаны в секундах эпохи Unix.
Добавление коннекторов и инструментов только при необходимости
Коннектор определяет внешнюю службу HTTP или удаленный сервер MCP. Инструмент определяет одну операцию, которую агент может вызвать на этом коннекторе. Не добавляйте эти ресурсы, если достаточно статических знаний.Настройка коннектора
Справочник по API коннекторов: GET List Connectors · POST Create Connector · GET Get Connector · PATCH Update Connector · POST Refresh MCP Connector Tools · DELETE Delete Connector Справочник по API учетных данных: PUT Upsert API Key · PUT Upsert OAuth Credentials · PUT Upsert Certificatename, description, base_url и auth_type обязательны для запросов на создание и обновление. Стандартные типы аутентификации: OAUTH2_CLIENT_CREDENTIALS, API_KEY и NONE. Meta может отклонить другое значение схемы, если оно не включено для аккаунта.
Для аутентификации по API-ключу передавайте значения в headers, query_params или body_params. Каждый элемент требует непустых field_name и value; поле prefix необязательно. Должен присутствовать хотя бы один элемент.
Для OAuth client credentials требуются token_url, scopes_to_request, client_id и client_secret. При указании поле token_request_content_type должно иметь значение application/x-www-form-urlencoded или application/json. Для mTLS предоставьте PEM-текст в client_certificate и client_key; поле ca_certificate необязательно. Никогда не логируйте тела запросов с учетными данными.
Используйте /connectors для получения списка или создания коннекторов. Используйте /connectors/{connectorId} для получения, обновления или удаления коннектора. Заменяйте учетные данные через его подресурсы /credentials/apiKey, /credentials/oauth или /credentials/certificate.
Для MCP-коннектора вызовите /connectors/{connectorId}/refreshMCPTools с идентификатором Meta Connector ID, возвращенным Connector API, чтобы запросить у Meta повторное обнаружение инструментов. Не передавайте тело запроса. Ответ HTTP 200 возвращает текущий коннектор, но это не всегда означает успешное завершение обнаружения. Проверьте mcp_tool_sync.status: READY означает, что обнаружение завершено, PENDING — что оно еще выполняется, а ERROR — что удаленное обнаружение или подготовка завершились сбоем. У операции нет ключа идемпотентности. Не повторяйте ее автоматически; при таймауте запросите коннектор повторно, так как результат обновления не определен.
Определение инструментов
Справочник по API инструментов: GET List Connector Tools · POST Create Connector Tool · GET Get Connector Tool · PATCH Update Connector Tool · DELETE Delete Connector Tool
Создавайте и просматривайте список инструментов с помощью
/connectors/{connectorId}/tools. Получайте, обновляйте или удаляйте инструмент с помощью /tools/{toolId}.
Определения параметров включают type данных, понятное человеку description, флаг обязательности и необязательный binding. Привязка может предоставлять фиксированное значение, макрос или входные данные среды выполнения.
Запросы на создание и обновление требуют name, description, request_definition и user_auth_required. Определение запроса требует method и path. Тело требует content_type=application/json и объект params. При указании user_auth_action_config требует user_action_tool_type (auth или refresh) и user_auth_token_path; expires_at_type должно быть absolute или relative_seconds. Недопустимые определения коннекторов или инструментов возвращают HTTP 400 без перенаправления на вышестоящий уровень.
Преобразование ответов инструментов
Ненулевойtransformation_spec требует наличия version=1 и steps, содержащих не более пяти упорядоченных шагов.
Каждый шаг требует kind. Необязательные поля target и params принимают строки или null; params содержит
JSON-объект, закодированный в виде строки. Выражение math поддерживает не более четырех уровней вложенности.
Поддерживаемые типы: allowlist, case, catalog, decorate_url, dedupe, dehydrate, filter,
first_nonempty, first_nonnull, first_nonzero, format, html_escape, lookup, math,
proxy_image, reshape, shadow_allowlist, string_replace и truncate.
При создании пропуск или null означает отсутствие преобразования. При обновлении эти три варианта различаются:
WHATSAPP_PHONE_NUMBER, WHATSAPP_PHONE_NUMBER_NATIONAL,
WHATSAPP_IDENTITY_HASH, WHATSAPP_CURRENT_STATUS_ID, WHATSAPP_BSUID, USER_MESSAGE,
WHATSAPP_CONVERSATION_ID, WHATSAPP_MESSAGE_ID, INSTAGRAM_IGSID и
INSTAGRAM_CONVERSATION_ID. Принятие макроса Instagram не включает сущности Instagram
и не гарантирует его значение для пользователя WhatsApp.
Проверка состояния обнаружения MCP
MCP использует ту же конечную точку и поля аутентификации. Успешный ответ коннектора может содержатьmcp_tool_sync.status=ERROR; это означает сбой обнаружения инструментов. Создание коннектора не
означает, что инструменты готовы к работе. Время первого обнаружения и специфические ограничения на редактирование MCP
еще не были проверены. Используйте операцию обновления выше, когда Meta требуется повторно обнаружить инструменты коннектора.
Далее: Тестирование и оценка
Проверьте ответы и типовые бизнес-сценарии.

