API Dorongan Grup

Deskripsi

API ini digunakan untuk membuat push grup. Satu panggilan dapat mengirim pesan ke semua aplikasi dalam grup.

Atribut override_msg_id pada option tidak didukung.

Push grup hanya mendukung penjadwalan tugas saat melakukan push melalui konsol, namun tidak mendukung pemanggilan Schedule API untuk mengatur penjadwalan tugas.

Validasi Panggilan

Tambahkan satu field (pasangan Kunci/Nilai) pada HTTP Header (Header):

Authorization: Basic ${base64_auth_string}

              
                  Authorization: Basic ${base64_auth_string}

Tampilkan blok kode ini di jendela mengambang

Artinya, algoritma pembuatan base64_auth_string adalah base64(username:password)
Nama Header adalah "Authorization" dan nilainya adalah pasangan "username:password" yang telah dikonversi ke base64 (dengan tanda titik dua di tengahnya).
Dalam skenario API push grup, username adalah awalan "group-" ditambah GroupKey, dan password adalah Master Secret grup. Anda dapat melihat kedua informasi tersebut di menu Group management-edit pada konsol.

Alamat Panggilan

POST v4/grouppush

Contoh Permintaan

curl --insecure -X POST -v https://webpushapi-sgp.engagelab.com/v4/grouppush -H "Content-Type: application/json" -u "c96f42e0d2e662e45d035ab1:df4d59e84eac2f9d53b36f12" -d '{ "from": "push", "to": "all", "body": { "platform": "all", "notification": { "android": { "alert": "Hai, Push!", "title": "Kirim ke Android", "builder_id": 1, "extras": { "newsid": 321 } }, "ios": { "alert": "Hai, MTPush!", "sound": "default", "badge": "+1", "extras": { "newsid": 321 } } }, "message": { "msg_content": "Hai, MTPush", "content_type": "text", "title": "pesan", "extras": { "key": "value" } }, "options": { "time_to_live": 60, "apns_production": false } }, "request_id": "12345678", "custom_args": "informasi bisnis" }' > POST /v4/grouppush HTTP/1.1 > Authorization: Basic Yzk2ZjQyZTBkMmU2NjJlNDVkMDM1YWIxOmRmNGQ1OWU4NGVhYzJmOWQ1M2IzNmYxMg==

              
              curl --insecure -X POST -v https://webpushapi-sgp.engagelab.com/v4/grouppush 
-H "Content-Type: application/json" 
-u "c96f42e0d2e662e45d035ab1:df4d59e84eac2f9d53b36f12" 
-d '{
    "from": "push",
    "to": "all",
    "body": {
        "platform": "all",
        "notification": {
            "android": {
                "alert": "Hai, Push!",
                "title": "Kirim ke Android",
                "builder_id": 1,
                "extras": {
                    "newsid": 321
                }
            },
            "ios": {
                "alert": "Hai, MTPush!",
                "sound": "default",
                "badge": "+1",
                "extras": {
                    "newsid": 321
                }
            }
        },
        "message": {
            "msg_content": "Hai, MTPush",
            "content_type": "text",
            "title": "pesan",
            "extras": {
                "key": "value"
            }
        },
        "options": {
            "time_to_live": 60,
            "apns_production": false
        }
    },
    "request_id": "12345678",
    "custom_args": "informasi bisnis"
}'
> POST /v4/grouppush HTTP/1.1
> Authorization: Basic Yzk2ZjQyZTBkMmU2NjJlNDVkMDM1YWIxOmRmNGQ1OWU4NGVhYzJmOWQ1M2IzNmYxMg==

Tampilkan blok kode ini di jendela mengambang

Parameter Permintaan

Untuk informasi lebih lanjut mengenai parameter permintaan, silakan lihat Create Push API.

Contoh Respons

Berhasil

{ "0c3de43c6a6b68c9f4261b06": {"request_id":"12345678","msg_id":"2460001"}, "35c424abde12f475566ca8af": {"request_id":"12345678","msg_id":"2460001"}, "8f02a4fa717a6235734d92de": {"request_id":"12345678","msg_id":"2460001"}, "group_msgid": "cbou2uum98lps87rtic0" }

              
              {
    "0c3de43c6a6b68c9f4261b06": {"request_id":"12345678","msg_id":"2460001"},
    "35c424abde12f475566ca8af": {"request_id":"12345678","msg_id":"2460001"},
    "8f02a4fa717a6235734d92de": {"request_id":"12345678","msg_id":"2460001"},
    "group_msgid": "cbou2uum98lps87rtic0"
}

Tampilkan blok kode ini di jendela mengambang

Gagal

{ "code":400, "data":"", "message":"pesan kesalahan" }

              
              {   
    "code":400,    
    "data":"",
  "message":"pesan kesalahan"
}

Tampilkan blok kode ini di jendela mengambang

Kode

Untuk informasi lebih lanjut, silakan lihat 「Create Push API - Response」.