Status Kesehatan Berkirim Pesan

Dokumen ini menjelaskan cara menentukan apakah Anda berhasil mengirim pesan menggunakan sumber daya API tertentu.

Node berikut memiliki kolom health_status:

• Akun WhatsApp Business
• Nomor Telepon WhatsApp Business
• Template Pesan WhatsApp

Jika Anda meminta kolom health_status di salah satu node ini, API akan menampilkan ringkasan kesehatan berkirim pesan dari semua node yang terlibat dalam permintaan berkirim pesan jika menggunakan node bertarget. Ringkasan ini menunjukkan jika Anda akan berhasil menggunakan API untuk mengirim pesan, jika keberhasilan Anda terbatas akibat beberapa batasan pada satu atau beberapa node, atau jika Anda tidak bisa berkirim pesan sepenuhnya.

Sintaksis Permintaan

GET /<NODE_ID>?fields=health_status

Tanggapan

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

Konten Tanggapan

Status Kesehatan Berkirim Pesan

Ketika Anda mencoba mengirim pesan, beberapa node akan terlibat, termasuk aplikasi, portofolio bisnis yang memiliki atau telah mengklaimnya, WABA, nomor telepon bisnis, dan template (jika mengirim pesan template).

Setiap node ini dapat memiliki salah satu status kesehatan berikut yang ditetapkan ke properti can_send_message:

• AVAILABLE: Menunjukkan bahwa node memenuhi semua persyaratan berkirim pesan.
• LIMITED: Menunjukkan bahwa node memenuhi persyaratan berkirim pesan, tetapi memiliki beberapa batasan. Jika node tertentu memiliki nilai ini, info tambahan akan disertakan.
• BLOCKED: Menunjukkan bahwa node tidak memenuhi satu atau beberapa persyaratan berkirim pesan. Jika node tertentu memiliki nilai ini, properti kesalahan akan disertakan, yang mendeskripsikan kesalahan adan kemungkinan solusi.

Status Keseluruhan

Properti status kesehatan secara keseluruhan (health_status.can_send_message) akan diatur sebagai berikut:

• Jika satu atau beberapa node terblokir, ini akan diatur ke BLOCKED.
• Jika tidak ada node yang terblokir, tetapi satu atau beberapa node dibatasi, ini akan diatur ke LIMITED.
• Jika semua node tersedia, ini akan diatur ke AVAILABLE.

Contoh Permintaan

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

Contoh Tanggapan

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

Properti Info Tambahan

Jika properti can_send_message dari node tertentu diatur ke LIMITED, properti additional_info akan disertakan, yang memberikan konteks tambahan untuk batasan.

Contoh Tanggapan Terbatas

Ini merupakan contoh tanggapan atas permintaan pada nomor telepon bisnis yang dapat digunakan untuk mengirim pesan, namun memiliki batasan pada jumlah yang dapat dikirimi karena nama tampilannya belum disetujui.

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

Properti Kesalahan

Jika properti can_send_message dari node tertentu diatur ke BLOCKED, properti errors akan disertakan, yang mendeskripsikan alasan status dan kemungkinan solusi.

Contoh Tanggapan Terblokir

Ini adalah contoh tanggapan terhadap permintaan atas template yang tidak dapat dikirim dalam pesan template karena masih berstatus tertunda.

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