Message Template

---

Authorization

Add this header to every request in this page

{
  "Authorization": "Bearer ${token}"
}

🔒 Check WhatsApp Phone Status

Messages can be sent depending on WhatsApp Phone Number status

GET

https://backend.helorobo.com/agent-app/message-template/template/waba-status?channel_id=<channel_id>

Response

{
  "success": true,
  "data": {
    "status": "<phone_status>",
    "id": "<phone_number_id>",
    "quality_rating": "<quality_rating>",
    "verified_name": "<phone_display_name>",
    "display_phone_number": "<phone_number>",
    "messaging_limit_tier": "<tier_limit>"
  }
}

Parameter Explanations

Name	Description
id	This is Channel Id which you are going to use while creating, getting and sending message templates
status	Status of the Phone Number. Here is the status list. Check out Meta Documentation CONNECTED: Ready to send messages FLAGGED: Your phone marked as flagged due to low quality ratings. RESTRICTED: You cant send any messages. Due to your quality rating. You have to wait some time before start sending again.
quality_rating	Rating of the messages which you have sent to your customers for seven days. Rating is determined by the feedback from your customer. Here is the quality rating lists. Check out Meta Documentation GREEN: High quality YELLOW: Medium Quality RED: Low Quality
messaging_limit_tier	Maximum number of the business-initiated conversation of phone number can send in 24h. TIER_50 TIER_250 TIER_1K TIER_10K TIER_100K TIER_UNLIMITED

CAUTION

status -> When value is FLAGGED, message cannot be sent.

CAUTION

quality_rating -> When value is RED, no message can be sent.

WARNING

When your status is FLAGGED You have to be carefull. Your phone number at risk. Check your message templates. Revise the customer list that your sending messages templates to. If your customer marks your messages as spam. First your quality rating decreases and after that your number will be RESTRICTED!!! You wont be able to send messages anymore and your TIER would decrease.

TIP

If you keep your quality rating at GREEN your messaging tier will increase.

🔒 List Message Templates

Returns message templates.

GET

https://backend.helorobo.com/agent-app/message-template/template?channel_id=<channel_id>

Response

{
  "success": true,
  "items": [
    {
      "name": "helorobo_demo",
      "components": [
        {
          "type": "HEADER",
          "format": "IMAGE",
          "example": {
            "header_handle": [
              "<image_url>"
            ]
          }
        },
        {
          "type": "BODY",
          "text": "Hello, Dear {{1}}. {{2}} How are you?",
          "example": {
            "body_text": [["example_param_1", "example_param_2"]]
          }
        }
      ],
      "language": "tr",
      "status": "<message_template_status>",
      "category": "<message_template_category>",
      "id": "<messsage_template_id>"
    }
  ]
}

🔒 Message Template Detail

Returns the previously created message template detail.

https://backend.helorobo.com/agent-app/message-template/template/get-by-id?template_id=<message_template_id>&channel_id=<channel_id>

Response

{
  "success": true,
  "data": {
    "message_template": {
      "name": "helorobo_demo",
      "components": [
        {
          "type": "HEADER",
          "format": "IMAGE",
          "example": {
            "header_handle": [
              "<image_url>"
            ]
          }
        },
        {
          "type": "BODY",
          "text": "Hello, Dear {{1}}",
          "example": {
            "body_text": [["example_param_1"]]
          }
        }
      ],
      "language": "tr",
      "status": "<message_template_status>",
      "category": "<message_template_category>",
      "id": "<messsage_template_id>"
  }
}

🔒 Delete Message Template

Deletes the messages template with given id.

DELETE

https://backend.helorobo.com/agent-app/message-template/template

Body

{
  "id": "<message_template_id>"
}

Response

{
  "success": true
}