Status de integridade de envio de mensagens

Este documento descreve como descobrir se você pode enviar mensagens usando um recurso de API.

Os nós a seguir têm um campo health_status:

• WhatsApp Business Account
• WhatsApp Business Phone Number
• WhatsApp Message Template

Se você solicitar o campo health_status em um desses nós, a API retornará um resumo da integridade de envio de mensagens de todos os nós envolvidos nas solicitações relacionadas usando o nó em questão. Este resumo indica se você poderá usar a API para enviar mensagens com sucesso, enviar parcialmente (devido a uma limitação em um ou mais nós) ou se não conseguirá enviar mensagens.

Sintaxe da solicitação

GET /<NODE_ID>?fields=health_status

Resposta

{
  "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>"
}

Conteúdo da resposta

Status de integridade de envio de mensagens

Diversos nós estão envolvidos em uma tentativa de envio de mensagem, incluindo o app, o portfólio empresarial proprietário ou administrador, uma WABA, um número de telefone comercial e um modelo (em caso de envio de mensagem de modelo).

Cada nó pode ter um dos seguintes status de integridade atribuídos à propriedade can_send_message.

• AVAILABLE: indica que o nó atende a todos os requisitos para o envio de mensagens.
• LIMITED: indica que o nó atende a requisitos para o envio de mensagens, mas há limitações. Se um nó tiver esse valor, a propriedade additional_info será incluída.
• BLOCKED: indica que o nó não atende a um ou mais requisitos para o envio de mensagens. Se um nó tiver esse valor, a propriedade errors será incluída, descrevendo o erro e uma possível solução.

Status geral

A propriedade de status geral de integridade (health_status.can_send_message) será definida conforme o seguinte.

• BLOCKED: status caso um ou mais nós estejam bloqueados.
• LIMITED: status caso nenhum nó esteja bloqueado, mas um ou mais tenham limitações.
• AVAILABLE: status caso todos os nós estejam disponíveis.

Exemplo de solicitação

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

Exemplo de resposta

{
  "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"
}

Propriedade additional_info

Se a propriedade can_send_message de um nó for definida como LIMITED, a propriedade additional_info será incluída, dando mais contexto sobre a limitação.

Exemplo de resposta em caso de limitação

Este é um exemplo de resposta a uma solicitação em um número de telefone comercial que pode ser usado para enviar mensagens, mas está sujeito a um limite na quantidade de mensagens que pode ser enviada, pois o nome de exibição não foi aprovado.

{
  "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"
}

Propriedade errors

Se a propriedade can_send_message de um nó for definida como BLOCKED, a propriedade errors será incluída, descrevendo o motivo do status e uma possível solução.

Exemplo de resposta em caso de bloqueio

Este é um exemplo de resposta a uma solicitação em um modelo que não pode ser enviado em mensagens porque ainda está pendente.

{
  "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"
}