État du service de messagerie

Ce document vous explique comment déterminer si vous pouvez ou non envoyer des messages via une ressource d’API donnée.

Les nœuds suivants possèdent un champ health_status :

• Compte WhatsApp Business
• Numéro de téléphone WhatsApp Business
• Modèle de message WhatsApp

Si vous interrogez le champ health_status d’un de ces nœuds, l’API renvoie un résumé de l’état du service de messagerie de tous les nœuds impliqués dans les requêtes de messagerie utilisant le nœud ciblé. Ce résumé indique si l’API peut distribuer les messages que vous envoyez, si elle ne peut les distribuer que partiellement en raison des limitations d’un ou de plusieurs nœuds ou si elle ne peut distribuer aucun de vos messages.

Syntaxe de la requête

GET /<NODE_ID>?fields=health_status

Réponse

{
  "health_status": {
    "can_send_message": "<OVERALL_MESSAGING_STATUS>",
    "entities": [
    
      /* Only included if targeting a business phone number */
      {
        "entity_type": "PHONE_NUMBER",
        "id": "<BUSINESS_PHONE_NUMBER_ID>",
        "can_send_message": "<BUSINESS_PHONE_NUMBER_MESSAGING_STATUS>"
      },
      
      /* Only included if targeting a template */
      {
        "entity_type": "MESSAGE_TEMPLATE",
        "id": "<TEMPLATE_ID>",
        "can_send_message": "<TEMPLATE_MESSAGING_STATUS>"
      },
      
      /* WABA, business, and app always included */
      {
        "entity_type": "WABA",
        "id": "<WABA_ID>",
        "can_send_message": "<WABA_MESSAGING_STATUS>"
      },
      {
        "entity_type": "BUSINESS",
        "id": "<BUSINESS_PORTFOLIO_ID>",
        "can_send_message": "<BUSINESS_PORTFOLIO_MESSAGING_STATUS>"
      },
      {
        "entity_type": "APP",
        "id": "<APP_ID>",
        "can_send_message": "<APP_MESSAGING_STATUS>"
      }
    ]
  },
  "id": "<NODE_ID>"
}

Contenu de la réponse

État du service de messagerie

Lorsque vous tentez d'envoyer un message, plusieurs nœuds sont concernés, dont l'application, le portefeuille business qui la possède ou l'a revendiquée, un compte WhatsApp Business, un numéro de téléphone professionnel et un modèle (si le message à envoyer est basé sur un modèle).

Chacun de ces nœuds possède une propriété can_send_message qui peut être associée à l’un des états de messagerie suivants :

• AVAILABLE : indique que le nœud répond à toutes les exigences de messagerie.
• LIMITED : indique que le nœud répond aux exigences de messagerie, mais qu’il est soumis à certaines limitations. Lorsqu’un nœud donné est associé à cette valeur, des informations complémentaires sont incluses.
• BLOCKED : indique que le nœud ne répond pas à une ou plusieurs des exigences de messagerie. Lorsqu’un nœud donné est associé à cette valeur, la propriété errors est incluse pour décrire l’erreur rencontrée et une éventuelle solution.

État général

La propriété d’état général du service (health_status.can_send_message) sera définie comme suit :

• Si un ou plusieurs nœuds sont bloqués, elle sera définie sur BLOCKED.
• Si aucun nœud n’est bloqué, mais qu’un ou plusieurs nœuds sont limités, elle sera définie sur LIMITED.
• Si tous les nœuds sont disponibles, elle sera définie sur AVAILABLE.

Exemple de requête

curl 'https://graph.facebook.com/v21.0/106540352242922?fields=health_status' \
-H 'Authorization: Bearer EAAJB'

Exemple de réponse

{
  "health_status": {
    "can_send_message": "AVAILABLE",
    "entities": [
      {
        "entity_type": "PHONE_NUMBER",
        "id": "106540352242922",
        "can_send_message": "AVAILABLE"
      },
      {
        "entity_type": "WABA",
        "id": "102290129340398",
        "can_send_message": "AVAILABLE"
      },
      {
        "entity_type": "BUSINESS",
        "id": "506914307656634",
        "can_send_message": "AVAILABLE"
      },
      {
        "entity_type": "APP",
        "id": "634974688087057",
        "can_send_message": "AVAILABLE"
      }
    ]
  },
  "id": "106540352242922"
}

Propriété des informations complémentaires

Lorsque la propriété can_send_message d’un nœud donné est définie sur LIMITED, la propriété additional_info est incluse pour indiquer le contexte de la limitation.

Exemple de réponse pour une messagerie limitée

Voici un exemple de réponse à une requête sur un numéro de téléphone professionnel qui peut être utilisé pour envoyer des messages, mais en nombre limité, parce que son nom à l’écran n’a pas été approuvé.

{
  "health_status": {
    "can_send_message": "LIMITED",
    "entities": [
      {
        "entity_type": "PHONE_NUMBER",
        "id": "106540352242922",
        "can_send_message": "LIMITED",
        "additional_info": [
          "Your display name has not been approved yet. Your message limit will increase after the display name is approved."
        ]
      },
      {
        "entity_type": "WABA",
        "id": "102290129340398",
        "can_send_message": "AVAILABLE"
      },
      {
        "entity_type": "BUSINESS",
        "id": "506914307656634",
        "can_send_message": "AVAILABLE"
      },
      {
        "entity_type": "APP",
        "id": "634974688087057",
        "can_send_message": "AVAILABLE"
      }
    ]
  },
  "id": "105154286024403"
}

Propriété des erreurs

Lorsque la propriété can_send_message d’un nœud donné est définie sur BLOCKED, la propriété errors est incluse pour indiquer la raison de cet état et une éventuelle solution.

Exemple de réponse pour une messagerie bloquée

Voici un exemple de réponse à une requête sur un modèle qui ne peut pas servir de base à un message à envoyer, parce que son état est toujours en attente.

{
  "health_status": {
    "can_send_message": "BLOCKED",
    "entities": [
      {
        "entity_type": "MESSAGE_TEMPLATE",
        "id": "2632273056924580",
        "can_send_message": "BLOCKED",
        "errors": [
          {
            "error_code": 141002,
            "error_description": "Message templates can only be sent out if they are approved.",
            "possible_solution": "Edit or appeal the message template review decision."
          }
        ]
      },
      {
        "entity_type": "WABA",
        "id": "102290129340398",
        "can_send_message": "AVAILABLE"
      },
      {
        "entity_type": "BUSINESS",
        "id": "506914307656634",
        "can_send_message": "AVAILABLE"
      },
      {
        "entity_type": "APP",
        "id": "634974688087057",
        "can_send_message": "AVAILABLE"
      }
    ]
  },
  "id": "2632273056924580"
}