API การ Push แบบกลุ่ม

คำอธิบาย

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

ไม่รองรับแอตทริบิวต์ override_msg_id ในตัวเลือก

การ push แบบกลุ่มรองรับเฉพาะการตั้งค่างานที่กำหนดเวลาเมื่อ push ในคอนโซล แต่ไม่รองรับการเรียกใช้ Schedule API เพื่อตั้งค่าการทำงานตามกำหนดเวลา

การตรวจสอบการเรียกใช้

เพิ่มฟิลด์ (คู่ Key/Value) ใน HTTP Header (ส่วนหัว):

Authorization: Basic ${base64_auth_string}

              
                  Authorization: Basic ${base64_auth_string}

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

นั่นคือ อัลกอริทึมการสร้าง base64_auth_string คือ base64(username:password)
ชื่อ Header คือ "Authorization" และค่าคือคู่ "username:password" ที่แปลงเป็น base64 (มีเครื่องหมายโคลอนตรงกลาง)
ในกรณีของ API push กลุ่ม username คือคำนำหน้า "group-" บวกกับ GroupKey และรหัสผ่านคือ Master Secret ของกลุ่ม คุณสามารถดูทั้งสองรายการนี้ได้ในส่วนการจัดการกลุ่ม-แก้ไขในคอนโซล
!https://res.theengagelab.com/docs/yuque/0/2023/png/21780123/1677824167887-5aaa9006-ef22-4656-9be5-5e2f50135155.png

ที่อยู่การเรียกใช้

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": "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 } } }, "message": { "msg_content": "Hi,MTPush", "content_type": "text", "title": "msg", "extras": { "key": "value" } }, "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://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": "Hi, Push!",
                "title": "Send to Android",
                "builder_id": 1,
                "extras": {
                    "newsid": 321
                }
            },
            "ios": {
                "alert": "Hi, MTPush!",
                "sound": "default",
                "badge": "+1",
                "extras": {
                    "newsid": 321
                }
            }
        },
        "message": {
            "msg_content": "Hi,MTPush",
            "content_type": "text",
            "title": "msg",
            "extras": {
                "key": "value"
            }
        },
        "options": {
            "time_to_live": 60,
            "apns_production": false
        }
    },
    "request_id": "12345678",
    "custom_args": "business info"
}'
> POST /v4/grouppush HTTP/1.1
> Authorization: Basic Yzk2ZjQyZTBkMmU2NjJlNDVkMDM1YWIxOmRmNGQ1OWU4NGVhYzJmOWQ1M2IzNmYxMg==

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

พารามิเตอร์คำขอ

สำหรับข้อมูลเพิ่มเติมเกี่ยวกับพารามิเตอร์คำขอ โปรดดูที่ /docs/web-push/rest-api/create-a-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"
}

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

ล้มเหลว

{ "code":400, "data":"", "message":"ข้อความแสดงข้อผิดพลาด" }

              
              {   
    "code":400,    
    "data":"",
  "message":"ข้อความแสดงข้อผิดพลาด"
}

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

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

สำหรับข้อมูลเพิ่มเติม โปรดดูที่ /docs/web-push/rest-api/create-a-push-api#response