Group Push API
ภาพรวมฟีเจอร์
API นี้ใช้สำหรับสร้างการพุชสำหรับกลุ่มแอปพลิเคชัน โดยการเรียกใช้งานครั้งเดียว สามารถพุชข้อความไปยังแอปพลิเคชันทั้งหมดในกลุ่มได้
- ขณะนี้ยังไม่รองรับพร็อพเพอร์ตี้
override_msg_idในoption- สำหรับการพุชแบบกลุ่ม สามารถกำหนดเวลางานได้เฉพาะเมื่อพุชจากคอนโซลเท่านั้น และยังไม่รองรับการตั้งค่างานตามกำหนดเวลาผ่าน Schedule API
การยืนยันตัวตน
เพิ่มคู่คีย์/ค่า ต่อไปนี้ลงใน HTTP header:
Authorization: Basic ${base64_auth_string}
Authorization: Basic ${base64_auth_string}
โค้ดนี้โชว์เป็นหน้าต่างลอย
อัลกอริทึมสำหรับสร้าง base64_auth_string ข้างต้นคือ base64(username:password)
ชื่อ header คือ Authorization และค่าคือคู่ username:password ที่แปลงเป็น Base64 แล้ว (โดยมีเครื่องหมายโคลอนคั่นกลาง)
ในกรณีของการใช้งาน Group Push API, username คือคำนำหน้า group- ตามด้วย GroupKey และ password คือ Group Master Secret โดยสามารถดูทั้งสองค่านี้ได้ในคอนโซลที่ [การจัดการกลุ่ม] - [แก้ไข]

Endpoint
POST v4/grouppush
POST v4/grouppush
โค้ดนี้โชว์เป็นหน้าต่างลอย
ตัวอย่างคำขอ
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": "web",
"notification": {
"alert": "Hi,MTPush !",
"web": {
"title": "web_push",
"url": "http://www.google.com",
"extras": {
"web-key1": "web-value1"
}
}
}
},
"request_id": "12345678",
"custom_args": "business info"
}'
> 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": "web",
"notification": {
"alert": "Hi,MTPush !",
"web": {
"title": "web_push",
"url": "http://www.google.com",
"extras": {
"web-key1": "web-value1"
}
}
}
},
"request_id": "12345678",
"custom_args": "business info"
}'
> POST /v4/grouppush HTTP/1.1
> Authorization: Basic Yzk2ZjQyZTBkMmU2NjJlNDVkMDM1YWIxOmRmNGQ1OWU4NGVhYzJmOWQ1M2IzNmYxMg==
โค้ดนี้โชว์เป็นหน้าต่างลอย
พารามิเตอร์คำขอ
สำหรับพารามิเตอร์คำขอ โปรดดู Create Push API
ตัวอย่างการตอบกลับ
การตอบกลับเมื่อสำเร็จ
{
"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"
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
การตอบกลับเมื่อล้มเหลว
{
"error": {
"code": 21037,
"message": "group_key is not a 24 size string or does not exist"
}
}
{
"error": {
"code": 21037,
"message": "group_key is not a 24 size string or does not exist"
}
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
รหัสข้อผิดพลาด
สำหรับรายละเอียด โปรดดู "Create Push API - Response"
