กลุ่มพุช API

อัพเดทล่าสุด ：7 เดือนที่ผ่านมา

คำอธิบาย

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

คุณสมบัติ override_msg_id ใน option ไม่รองรับ

การส่งข้อความแบบกลุ่มรองรับเฉพาะการตั้งค่ากำหนดเวลาเมื่อส่งผ่านคอนโซลเท่านั้น ไม่รองรับการตั้งค่ากำหนดเวลาผ่าน 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 การส่งข้อความแบบกลุ่ม username คือ "group-" ตามด้วยคำนำหน้าของ GroupKey และ password คือ Master Secret ของกลุ่ม คุณสามารถดูค่าทั้งสองนี้ได้ในเมนูจัดการกลุ่ม - แก้ไขในคอนโซล

URL การเรียกใช้งาน

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 } } }, "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://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
                }
            }
        },
        "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==

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

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

สำหรับข้อมูลเพิ่มเติมเกี่ยวกับพารามิเตอร์คำขอ โปรดดู สร้าง 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":400, "message":"Error message" } }

              
              {
    "error":{
            "code":400,    
            "message":"Error message"
    }
}

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

รหัสสถานะ

สำหรับข้อมูลเพิ่มเติม โปรดดู 「สร้าง API การส่งข้อความ - การเรียกใช้งานและการตอบกลับ」 ```