HeloRobo

Turkish

English

Turkish

English

Appearance

Message Template ​

Otantikasyon ​

Bu başlığı her istekte gönderiniz.

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

🔒 WhatsApp Telefon Durumu ​

Mesaj Şablonlarının gönderimi WhatsApp Phone Number durumuna bağlıdır.

GET ​

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

Response ​

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

Parameter Explanations ​

İsimAçıklama
idMesaj şablonunu oluştururken, listesini alırken ve gönderirken kullanacağınız Channel Id
statusTelefon numarasının durumu. Durum listesini ve detaylarını buradan da inceleyebilirsiniz Meta Dökümantasyon Sayfası
  • CONNECTED: Bağlı. Mesaj Şablonu göndermeye hazır.
  • FLAGGED: İşaretli. Kalite değerlendirmesi düşük olduğu durumlarda bu durum gerçekleşir..
  • RESTRICTED: Artık Mesaj Şablonu gönderemezsiniz. Kalite değerlendirmeniz düşük seyrettiği için bu durum gerçekleşir. Tekrar gönderebilmeniz için bir süre beklemeniz gerekmektedir.
quality_score7 Gün içerisindeki kalite durumu. Bu kalite durumu müşterilerin geri bildirimi üzerinden değerlendirilmektedir. Kalite değerlendirme durumları aşağıda belirtilmiştir. Resmi Meta Dökümantasoynu
  • GREEN: Yüksek kalite
  • YELLOW: Orta kalite
  • RED: Düşük kalite
messaging_limit_tier24 saat içerisinde gönderilebilecek business-initiated konuşma sayısı.
  • TIER_50
  • TIER_250
  • TIER_1K
  • TIER_10K
  • TIER_100K
  • TIER_UNLIMITED

BİLGİ

TIER_50 olduğunda 50 business-initiated olabilir demek. UNLIMITED ise sınırsız demek

BİLGİ

Business-Initiated: Sizin ( Şirket ) tarafınızdan başlatılmış konuşmalar demektir. Müşteri yazmadan sizin başlatmış olduğunuz konuşmalardır.

Siz mesaj şablonu göndermiş olsanızda 24 saatlik ücretsiz çerçeve müşteri mesaj atmadan başlamaz.

ÖNEMLİ

status -> Bu değer eğer FLAGGED olursa mesaj gönderemezsiniz.

ÖNEMLİ

quality_score -> Bu değer eğer RED olursa yine aynı şekilde mesaj gönderemezsiniz.

UYARI

Eğer ki durumunuz ( status ) FLAGGED olursa dikkatli olmalısınız. Bu şekilde seyretmesi ve müşterilerinizin geri bildirimleri olumsuz yönde olmaya devam ederse telefon numaranız kullanıma kapatılabilir. Bu durumda aşağıdaki durumları gözden geçirmeniz önerilir.

  • Kişi listesini kontrol edin. Mesaj göndermek için onayını aldığınız kişilere göndermeye çalışın.
  • Mesaj şablonunuzu kontrol edin. İçeriğin spam benzeri veya ilgi çekici olmadığı yerleri tespit edip değiştirin.

Eğer müşterileriniz göndermiş olduğunuz Mesaj Şablonlarını spam olarak işaretlemeye devam ederse; İlk olarak Kalite Değerlendirme'niz düşecektir. Sonrasında ise telefon numaranızın durumu RESTRICTED (Kısıtlanmış) olacaktır. Artık mesaj gönderemez duruma geleceksiniz ve devamında TIER'iniz düşecektir. Bu duruma bağlı olarak da 24 saat içerisinde gönderebileceğiniz Bussiness-initiated mesaj sayısı düşecektir.

BİLGİ

Eğer ki Kalite Değerlendirmeniz GREEN olarak kalmaya devam ederse TIER'iniz artacaktır. Buna bağlı olarak da 24 saat içerisinde gönderebileceğiniz Bussiness-initiated mesaj sayısı artacaktır.

🔒 Message Template Oluşturma (v1) ​

Media yükleme hakkında daha fazla bilgi için Media Upload sayfasını ziyaret edebilirsiniz.

Yeni bir mesaj şablonu oluşturmak için kullanılır.

POST ​

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

Request Body ​

json
{
  "name": "test",
  "category": "MARKETING",
  "components": [
    {
      "type": "BODY",
      "text": "body"
    },
    {
      "type": "FOOTER",
      "text": "footer"
    },
    {
      "type": "BUTTONS",
      "buttons": [
        {
          "type": "URL",
          "text": "Git",
          "url": "https://helorobo.com"
        },
        {
          "type": "PHONE_NUMBER",
          "text": "Ara",
          "phone_number": "905555555555"
        },
        {
          "type": "COPY_CODE"
        },
        {
          "type": "QUICK_REPLY",
          "text": "Yanıtla"
        }
      ]
    },
    {
      "type": "HEADER",
      "format": "TEXT",
      "text": "header"
    }
  ],
  "allow_category_change": true,
  "language": "tr",
  "channel_id": "<channel_id>"
}

🔒 Message Template Oluşturma (v2) ​

Media yükleme hakkında daha fazla bilgi için Media Upload sayfasını ziyaret edebilirsiniz.

Yeni bir mesaj şablonu oluşturmak için kullanılır. (Carousel Destekli)

POST ​

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

Request Body ​

json
{
  "message_template": {
    "name": "test555",
    "category": "MARKETING",
    "language": "tr",
    "components": [
      {
        "type": "body",
        "text": "body"
      },
      {
        "type": "carousel",
        "cards": [
          {
            "components": [
              {
                "type": "header",
                "format": "image",
                "example": {
                  "header_handle": [
                    "4:Y2FjZWMxZDJjNDEyNjliZGFhODE4Njk1ZjMzM2M5NmMuanBn:aW1hZ2UvanBlZw==:ARYCJJ34Nu5iTfMdWNEN5GJUFIj4XtTrHFChW70lk-5dYw7Kjry7qs-yw73H32L2Ou6KztYZS3f_1IkYldU9Ri2puRI1OogMHfEPParkv4sZsQ:e:1770644974:1350673098603823:0:ARZ6lLFPw7t8zrt5A8c"
                  ]
                }
              },
              {
                "type": "body",
                "text": "cart 1"
              },
              {
                "type": "buttons",
                "buttons": [
                  {
                    "type": "quick_reply",
                    "text": "Yanıtla"
                  },
                  {
                    "type": "phone_number",
                    "text": "Ara",
                    "phone_number": "+905555555555"
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  },
  "channel_id": "<channel_id>",
  "media_names": {
    "4:Y2FjZWMxZDJjNDEyNjliZGFhODE4Njk1ZjMzM2M5NmMuanBn:aW1hZ2UvanBlZw==:ARYCJJ34Nu5iTfMdWNEN5GJUFIj4XtTrHFChW70lk-5dYw7Kjry7qs-yw73H32L2Ou6KztYZS3f_1IkYldU9Ri2puRI1OogMHfEPParkv4sZsQ:e:1770644974:1350673098603823:0:ARZ6lLFPw7t8zrt5A8c": "cacec1d2c41269bdaa818695f333c96c.jpg"
  }
}

🔒 Mesaj Şablonlarını Listele ​

Mesaj Şablonlarını listelemek için kullanılır.

GET ​

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

Response ​

json
{
  "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"]]
          }
        },
        {
          "type": "BUTTONS",
          "buttons": [
            {
              "type": "URL",
              "text": "<button_text>",
              "url": "<button_url>"
            }
          ]
        }
      ],
      "language": "tr",
      "status": "<message_template_status>",
      "category": "<message_template_category>",
      "id": "<messsage_template_id>"
    }
  ]
}

🔒 Mesaj Şablonu Detayı ​

Oluşturmuş olduğunuz Mesaj Şablonun Id'si verilenin detayını dönderir.

GET ​

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

Response ​

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

🔒 Mesaj Şablonu Silme ​

ID'si verilen mesaj şablonunu silmek için kullanılır.

DELETE ​

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

Body ​

json
{
  "id": "<message_template_id>"
}

Response ​

json
{
  "success": true
}

Copyright © HeloRobo