Управление аккаунтами WhatsApp Business

После создания процесса регистрации на сайте следует интегрировать необходимые конечные точки API.

Это руководство посвящено управлению аккаунтами WhatsApp Business со стороны партнеров по решениям.

Получение ID общих аккаунтов WhatsApp Business с помощью маркера доступа

Когда компания встроит механизм регистрации, вы можете получить ID общих аккаунтов WhatsApp Business с помощью возвращенного маркера accessToken, используя конечную точку Debug Token. Добавьте свой маркер доступа системного пользователя в заголовок запроса с указанием в начале Authorization: Bearer для этого вызова API.

Синтаксис запроса

GET https://graph.facebook.com/<API_VERSION>/debug_token
  ?input_token=<TOKEN_RETURNED_FROM_SIGNUP_FLOW>

Пример запроса

curl \
'https://graph.facebook.com/v21.0/debug_token?input_token=EAAFl...' \
-H 'Authorization: Bearer EAAJi...'

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

{
  "data" : {
    "app_id" : "670843887433847",
    "application" : "JaspersMarket",
    "data_access_expires_at" : 1672092840,
    "expires_at" : 1665090000,
    "granular_scopes" : [
      {
        "scope" : "whatsapp_business_management",
        "target_ids" : [
          "102289599326934", // ID of newest WABA to grant app whatsapp_business_management
          "101569239400667"
        ]
      },
      {
        "scope" : "whatsapp_business_messaging",
        "target_ids" : [
          "102289599326934",
          "101569239400667"
        ]
      }
    ],
    "is_valid" : true,
    "scopes" : [
       "whatsapp_business_management",
       "whatsapp_business_messaging",
       "public_profile"
    ],
    "type" : "USER",
    "user_id" : "10222270944537964"
  }
}

Каждый объект в массиве granular_scopes определяет ID каждого аккаунта WhatsApp Business, который дал вашему приложению определенное разрешение (scope). Первыми отображаются ID аккаунтов WhatsApp Business, зарегистрированных недавно. Для области whatsapp_business_management необходимо взять первый ID в массиве target_ids.

Получение списка общих аккаунтов WhatsApp Business

После прохождения встроенной регистрации конечная точка client_whatsapp_business_accounts возвращает список всех аккаунтов WhatsApp Business, которые назначены или предоставлены вашему аккаунту Business Manager.

Периодически обращайтесь к ней, чтобы отслеживать новые доступные аккаунты WhatsApp Business. Это альтернатива конечной точке Debug-Token, описанной в руководстве по управлению аккаунтами WhatsApp Business.

Список полей, которые можно запросить у этой конечной точки, см. в справке по аккаунтам WhatsApp Business.

Синтаксис запроса

GET https://graph.facebook.com/<API_VERSION>/<BUSINESS_MANAGER_ACCOUNT_ID>/client_whatsapp_business_accounts 

Пример запроса

curl \
'https://graph.facebook.com/v21.0/805021500648488/client_whatsapp_business_accounts/' \
-H 'Authorization: Bearer EAAJi...'

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

{
  "data": [
    {
      "id": 1906385232743451, 
      "name": "My WhatsApp Business Account", 
      "currency": "USD", 
      "timezone_id": "1", 
      "message_template_namespace": "abcdefghijk_12lmnop" 
    },
    {
      "id": 1972385232742141, 
      "name": "My Regional Account", 
      "currency": "INR", 
      "timezone_id": "5", 
      "message_template_namespace": "12abcdefghijk_34lmnop" 
    },
  ],
  "paging": {
    "cursors": {
      "before": "abcdefghij",
      "after": "klmnopqr"
    }
  }
}

Общие аккаунты WhatsApp Business

Разрешения

У партнера по решениям есть разрешения на выполнение следующих действий в общем аккаунте WhatsApp Business:

• добавление номеров телефонов;
• создание шаблонов сообщений;
• отправка сообщений клиентам;
• назначение пользователей аккаунту;
• доступ к метрикам;
• просмотр платежной информации.

Компаниям, которые подключаются посредством встроенной регистрации, доступны следующие возможности:

Партнеры по решениям не могут отключать доступные компаниям возможности и настраивать представления для них.

Дополнительную информацию для компаний см. в статье Как управлять разрешениями поставщика решения для WhatsApp Business?

Уведомления

Партнеры по решениям получают актуальные уведомления через Webhooks и Business Manager. Уведомления отправляются, когда:

• компания предоставляет доступ к аккаунту WhatsApp Business;
• для аккаунта WhatsApp Business клиента меняются ограничения числа сообщений или показатели качества;
• отображаемое имя номера телефона или шаблон получают одобрение.

Если компания прошла встроенную регистрацию не до конца, то может случиться так, что доступ к аккаунту WhatsApp Business уже предоставлен, однако сертификат скачать нельзя. В таком случае свяжитесь с компанией и помогите ей завершить регистрацию.

Получение списка аккаунтов WhatsApp Business, которыми вы владеете

Чтобы получить список аккаунтов WhatsApp Business, которыми владеет ваша компания, используйте конечную точку owned_whatsapp_business_accounts. В запросе укажите маркер доступа системного пользователя.

Синтаксис запроса

GET https://graph.facebook.com/<API_VERSION>/<BUSINESS_MANAGER_ACCOUNT_ID>/owned_whatsapp_business_accounts 

Пример запроса

curl \
'https://graph.facebook.com/v21.0/805021500648488/owned_whatsapp_business_accounts/' \
-H 'Authorization: Bearer EAAJi...'

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

{
  "data": [
    {
      "id": 1906385232743451, 
      "name": "My WhatsApp Business Account", 
      "currency": "USD", 
      "timezone_id": "1", 
      "message_template_namespace": "abcdefghijk_12lmnop" 
    },
    {
      "id": 1972385232742141, 
      "name": "My Regional Account", 
      "currency": "INR", 
      "timezone_id": "5", 
      "message_template_namespace": "12abcdefghijk_34lmnop" 
    },
  ],
  "paging": {
    "cursors": {
      "before": "abcdefghij",
      "after": "klmnopqr"
    }
  }
}

Фильтрация аккаунтов WhatsApp Business по времени создания

Аккаунты WhatsApp Business, принадлежащие клиенту и компании, можно фильтровать по времени создания. Для этого запроса используются перечисленные ниже параметры.

Синтаксис запроса

GET https://graph.facebook.com/<API_VERSION>/<BUSINESS_MANAGER_ACCOUNT_ID>/owned_whatsapp_business_accounts
  ?filtering=<FILTERING>

Значение filtering может быть массивом, который содержит одиночный объект со следующими свойствами:

Фильтрация свойств объекта

Пример объекта

[
  {
    "field" : "creation_time",
    "operator" : "GREATER_THAN",
    "value" : "1604962813"
  }
]

Пример запроса

curl \
'https://graph.facebook.com/v21.0/805021500648488/owned_whatsapp_business_accounts' \
-H 'Authorization: Bearer EAAJi...' \
-H 'Content-Type: application/json' \
-d '[{"field":"creation_time","operator":"GREATER_THAN","value":"1604962813"}]'

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

{
  "data": [
    {
      "id": “12312321312”,
      "name": "test",
      "currency": "USD",
      "timezone_id": "1",
      "message_template_namespace": "46fe_814"
    }
  ],
  "paging": {
    "cursors": {
      "before": "QVFIUm9",
      "after": "QVFIUklX"
    },
    "next": "https://graph.facebook.com/v21.0/“
  }
}

Сортировка аккаунтов WhatsApp Business по времени создания

Общие и принадлежащие компании аккаунты WhatsApp Business можно сортировать по времени создания.

Синтаксис запроса

GET https://graph.facebook.com/<API_VERSION>/<BUSINESS_MANAGER_ACCOUNT_ID>/owned_whatsapp_business_accounts
  ?sort=<SORT>

Значением sort может быть creation_time_ascending или creation_time_descending.

Пример запроса

curl \
'https://graph.facebook.com/v21.0/805021500648488/owned_whatsapp_business_accounts?sort=creation_time_ascending' \
-H 'Authorization: Bearer EAAJi...'

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

{
  "data": [
    {
      "id": 1906385232743451,
      "name": "My WhatsApp Business Account",
      "currency": "USD",
      "timezone_id": "1",
      "message_template_namespace": "abcdefghijk_12lmnop"
    },
    {
      "id": 1972385232742141,
      "name": "My Regional Account",
      "currency": "INR",
      "timezone_id": "5",
      "message_template_namespace": "12abcdefghijk_34lmnop"
    },
  ],
  "paging": {
    "cursors": {
      "before": "abcdefghij"
      "after": "klmnopqr"
    }
  }
}

Получение статуса проверки аккаунта WhatsApp Business

Статус проверки аккаунта WhatsApp Business можно получить, запросив поле account_review_status.

Синтаксис запроса

GET https://graph.facebook.com/<API_VERSION>/<WABA_ID>
  ?fields=account_review_status

Пример запроса

curl \
'https://graph.facebook.com/v21.0/106526625562206?fields=account_review_status' \
-H 'Authorization: Bearer EAAJi...' \

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

{
  "account_review_status": "APPROVED",
  "id": "1111111111111"
}

Возможные значения для свойства account_review_status: PENDING, APPROVED и REJECTED.

См. также

• WhatsApp Business Management API
• Справка: компании
• Справка: аккаунт WhatsApp Business