Push API v4

• Kirim notifikasi atau pesan ke satu perangkat atau daftar perangkat

• Konten push hanya dapat berupa satu objek push dalam format JSON

• Untuk fungsi terkait label/alias, silakan merujuk ke AppPushAPI.

Batas Frekuensi Permintaan

API kami memberlakukan batas frekuensi panggilan untuk memastikan stabilitas dan keadilan layanan. Batas QPS (Queries Per Second) untuk setiap AppKey adalah sebagai berikut:

• Batas Standar: Maksimal 500 permintaan per detik.
• Batas Lanjutan: Jika Anda adalah pelanggan paket berbayar dan AppKey berbayar Anda memerlukan batas QPS yang lebih tinggi, silakan hubungi tim bisnis kami: Sales@engagelab.com.

Validasi Panggilan

Untuk informasi lebih lanjut, lihat Metode Autentikasi

Alamat Panggilan

              
              POST v4/push

            

Contoh Permintaan

Header Permintaan

              
              > POST /v4/push HTTP/1.1
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

            

Body Permintaan

              
              {
    "from": "push",
    "to": "all",
    "body": {
        "platform": "web",
        "notification": {
            "alert": "Hi,MTPush !",//opsional
            "web": {
                "alert": "web_push",
                "title": "web_push",
                "url": "http://www.google.com",
                "extras": {
                    "web-key1": "web-value1"
                }
            }
        }
    },
    "request_id": "12345678",
    "custom_args": "informasi bisnis"
}

            

Parameter Permintaan

Struktur parameter push, dijelaskan secara detail pada tabel berikut.

from

Pengirim bisnis saat ini. Nilai berupa tipe String dan opsional.

Contoh Permintaan

              
              {
    "from":"push"
}

            

to

Objek perangkat push, menunjukkan daftar perangkat yang dapat dikirimi push. Konfirmasi objek perangkat push. MTPush menyediakan dua metode: Registration ID dan broadcast.

Target Push

Contoh Permintaan

• Push ke semua perangkat (broadcast)：

              
              {
  "to": "all",
}

            

• Push ke beberapa registration ID：

              
              {
  "to": {
    "registration_id": [
      "4312kjklfds2",
      "8914afd2",
      "45fdsa31"
    ]
  }
}

            

body

Isi dari permintaan. Field yang didukung sebagai berikut：

platform

MTPush saat ini hanya mendukung push platform Web, jadi kata kunci yang ditentukan oleh platform adalah "web".

              
              { "platform" : "web" }

            

notification

Objek notifikasi adalah salah satu objek konten entitas yang didorong (yang lain adalah message) dan didorong ke web sebagai notifikasi

web

Notifikasi pada platform Web

              
              {
    "notification": {
        "web": {
            "alert": "hello, Push!",
            "title": "Tes Push",
            "url":"http://www.google.com",
            "icon":"",
            "image":"",
            "extras": {
                "news_id": 134,
                "my_key": "a value"
            }
        }
    }
}

            

message

Pesan dalam aplikasi (In-App messages) atau pesan kustom. Konten ini tidak ditampilkan di browser. Setelah menerima pesan, SDK meneruskannya ke Web, dan Web memproses logika bisnis.

Pesan berisi field berikut：

Contoh：

              
              {
  "message": {
    "msg_content": "Hi,Push",
    "content_type": "text",
    "title": "msg",
    "extras": {
      "key": "value"
    }
  }
}

            

options

Opsi push. Opsi berikut tersedia：

multi_language

Field ini adalah fungsi push multi-bahasa dari layanan EngageLab Push. Anda dapat mengirimkan konten notifikasi yang disesuaikan ke pengguna dalam berbagai bahasa. Dengan menentukan beberapa bahasa beserta konten pesan, judul, dan iOS subtitle yang sesuai dalam permintaan push, Anda dapat mengirimkan notifikasi push yang sesuai dengan pengaturan bahasa pengguna.

Parameter Permintaan

Contoh Permintaan

              
                 Metode HTTP request: Post
   URL Permintaan: /v4/push
   Format data POST: json
   Contoh data POST:
   {
    "options": {
      "multi_language": {
        "en": {
          "content": "",
          "title": "",
        }
      }
    }
   }

            

Contoh Respons

              
              Berhasil:
{
   
}

Gagal:
{   
    "code":400,  
    "data":"",
  "message":"Informasi error"
}   

            

web_buttons

Gunakan parameter web_buttons untuk mendeskripsikan id, teks, ikon, dan url tombol. Deskripsi parameter sebagai berikut:

Contoh penggunaan sebagai berikut:

              
              [
  {
    "id": "like-button",
    "text": "Suka",
    "icon": "http://i.imgur.com/N8SN8ZS.png",
    "url": "https://yoursite.com"
  },
  {
    "id": "read-more-button",
    "text": "Baca selengkapnya",
    "icon": "http://i.imgur.com/MIxJp1L.png",
    "url": "https://yoursite.com"
  }
]

            

third_party_channel

Field ini digunakan untuk mengisi informasi personalisasi channel sistem Web. Nama kunci adalah w3push, dan nilainya berupa Json Object. Object hanya berisi satu field distribution opsional bertipe String

Contoh：

              
              {
  "third_party_channel":{
    "w3push":{
      "distribution":"mtpush"
    }
  }
}

            

request_id

ID dari permintaan. Pelanggan mengidentifikasi permintaan dan mengembalikan respons.

Contoh Permintaan

              
              {
      "request_id":"12345678"
}

            

Contoh Respons

custom_args

Field opsional yang ditentukan pengguna. Tidak dikembalikan saat respons, tetapi dikembalikan saat callback.

              
              {
  "custom_args":"informasi bisnis"
}

            

Parameter Respons

Respons Berhasil

              
              < HTTP/1.1 200 OK
< Content-Type: application/json
{"request_id": "18", "msg_id": "1828256757"}

            

Respons Gagal

Kode status http adalah 4xx atau 5xx dan body respons berisi field berikut.

              
              {
    "code": 3002,
    "message": "Field Push.template harus diatur dengan benar saat type adalah template"
}

            

Respons

Kode status HTTP

Referensi：HTTP-Status-Code

Kode Return

Batasan Push

Kode Multi-bahasa