Group Push API

อัพเดทล่าสุด ：ประมาณ 3 ปีที่ผ่านมา

คำอธิบายฟีเจอร์

API นี้ใช้สำหรับสร้างการแจ้งเตือนแบบพุชสำหรับกลุ่มแอปพลิเคชัน โดยเรียกใช้งานเพียงครั้งเดียวก็สามารถพุชข้อความไปยังทุกแอปพลิเคชันในกลุ่มได้

ขณะนี้ยังไม่รองรับแอตทริบิวต์ override_msg_id ใน option

Group Push รองรับงานตามกำหนดเวลาเฉพาะเมื่อส่งข้อความจากคอนโซลเท่านั้น และไม่รองรับการตั้งค่างานตามกำหนดเวลาด้วยการเรียกใช้ 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 โดยสามารถดูทั้งสองค่านี้ได้จากคอนโซลที่ Group Management > Edit

URL คำขอ

POST v4/grouppush

              
              POST v4/grouppush

โค้ดนี้โชว์เป็นหน้าต่างลอย

ตัวอย่างคำขอ

curl --insecure -X POST -v https://pushapi-sgp.engagelab.com/v4/grouppush -H "Content-Type: application/json" -u "c96f42e0d2e662e45d035ab1:df4d59e84eac2f9d53b36f12" -d '{ "from": "push", "to": "all", "body": { "platform": "all", "notification": { "android": { "alert": "Hi, Push!", "title": "Send to Android", "builder_id": 1, "extras": { "newsid": 321 } }, "ios": { "alert": "Hi, MTPush!", "sound": "default", "badge": "+1", "extras": { "newsid": 321 } }, "hmos": { "alert": "Hi, MTPush!", "title": "", "category": "", "intent": {"url": ""}, "badge_add_num": 1, "test_message": true, "receipt_id": "", "extras": {}, "style": 0, "inbox_content": [], "push_type": 0, "extra_data": "", "display_foreground": "" } } }, "options": { "time_to_live": 60, "apns_production": false }, "request_id": "12345678", "custom_args": "business info" }' > POST /v4/grouppush HTTP/1.1 > Authorization: Basic Yzk2ZjQyZTBkMmU2NjJlNDVkMDM1YWIxOmRmNGQ1OWU4NGVhYzJmOWQ1M2IzNmYxMg==

              
              curl --insecure -X POST -v https://pushapi-sgp.engagelab.com/v4/grouppush -H "Content-Type: application/json" -u "c96f42e0d2e662e45d035ab1:df4d59e84eac2f9d53b36f12" -d 
'{
    "from": "push",
    "to": "all",
    "body": {
        "platform": "all",
        "notification": {
            "android": {
                "alert": "Hi, Push!",
                "title": "Send to Android",
                "builder_id": 1,
                "extras": {
                    "newsid": 321
                }
            },
            "ios": {
                "alert": "Hi, MTPush!",
                "sound": "default",
                "badge": "+1",
                "extras": {
                    "newsid": 321
                }
            },
            "hmos": {
                "alert": "Hi, MTPush!",
                "title": "",
                "category": "",
                "intent": {"url": ""},
                "badge_add_num": 1,
                "test_message": true,
                "receipt_id": "",
                "extras": {},
                "style": 0,
                "inbox_content": [],
                "push_type": 0,
                "extra_data": "",
                "display_foreground": ""
            }
        }
    },
    "options": {
        "time_to_live": 60,
        "apns_production": false
    },
    "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-character string or does not exist" } }

              
              {
    "error": {
        "code": 21037,
        "message": "group_key is not a 24-character string or does not exist"
    }
}

โค้ดนี้โชว์เป็นหน้าต่างลอย

รหัสข้อผิดพลาด

สำหรับรายละเอียด โปรดดู Create Push API - Call Response