Push API v4

• ส่งการแจ้งเตือนหรือข้อความไปยังอุปกรณ์เดียวหรือรายการอุปกรณ์

• เนื้อหาการ push จะต้องเป็นออบเจ็กต์ JSON เพียงหนึ่งเดียวเท่านั้น

• สำหรับฟังก์ชันที่เกี่ยวข้องกับป้ายกำกับ/นามแฝง โปรดดูที่ AppPushAPI

ข้อจำกัดอัตราการร้องขอ

API ของเรามีข้อจำกัดเกี่ยวกับความถี่ในการเรียกใช้ เพื่อให้มั่นใจในความเสถียรและความเป็นธรรมของบริการ ข้อจำกัด QPS (Queries Per Second) สำหรับแต่ละ AppKey มีดังนี้:

• ข้อจำกัดมาตรฐาน: สูงสุด 500 คำขอต่อวินาที
• ข้อจำกัดขั้นสูง: หากคุณเป็นสมาชิกแผนแบบชำระเงินและ AppKey ที่ชำระเงินของคุณต้องการข้อจำกัด QPS ที่สูงกว่า โปรดติดต่อทีมธุรกิจของเรา: Sales@engagelab.com

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

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

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

              
              POST v4/push

            

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

ส่วนหัวคำขอ

              
              > POST /v4/push HTTP/1.1
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

            

เนื้อหาคำขอ

              
              {
    "from": "push",
    "to": "all",
    "body": {
        "platform": "web",
        "notification": {
            "alert": "Hi,MTPush !",//optional
            "web": {
                "alert": "web_push",
                "title": "web_push",
                "url": "http://www.google.com",
                "extras": {
                    "web-key1": "web-value1"
                }
            }
        }
    },
    "request_id": "12345678",
    "custom_args": "business info"
}

            

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

โครงสร้างพารามิเตอร์ของการ push มีรายละเอียดดังตารางด้านล่าง

from

ผู้ส่งของธุรกิจปัจจุบัน ค่าเป็นประเภท String และไม่จำเป็น

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

              
              {
    "from":"push"
}

            

to

ออบเจ็กต์อุปกรณ์ push ซึ่งระบุรายการอุปกรณ์ที่สามารถ push ได้ ยืนยันออบเจ็กต์อุปกรณ์ push MTPush มีสองวิธี: Registration ID และการกระจายเสียง

เป้าหมายการ push

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

• Push ไปยังทั้งหมด (การกระจายเสียง)：

              
              {
  "to": "all",
}

            

• Push ไปยัง registration ID หลายรายการ：

              
              {
  "to": {
    "registration_id": [
      "4312kjklfds2",
      "8914afd2",
      "45fdsa31"
    ]
  }
}

            

body

เนื้อหาของคำขอ ฟิลด์ที่รองรับมีดังนี้：

platform

MTPush ปัจจุบันรองรับเฉพาะการ push บนแพลตฟอร์ม Web ดังนั้นคีย์เวิร์ดที่ระบุโดย platform คือ "web"

              
              { "platform" : "web" }

            

notification

ออบเจ็กต์การแจ้งเตือนเป็นหนึ่งในออบเจ็กต์เนื้อหาหลักที่ถูก push (อีกอันคือข้อความ) และถูก push ไปยังเว็บเป็นการแจ้งเตือน

web

การแจ้งเตือนบนแพลตฟอร์ม Web

              
              {
    "notification": {
        "web": {
            "alert": "hello, Push!",
            "title": "Push Test",
            "url":"http://www.google.com",
            "icon":"",
            "image":"",
            "extras": {
                "news_id": 134,
                "my_key": "a value"
            }
        }
    }
}

            

message

ข้อความในแอป หรือข้อความกำหนดเอง ส่วนนี้จะไม่แสดงบนเบราว์เซอร์ หลังจากรับข้อความแล้ว SDK จะส่งต่อไปยังเว็บ และเว็บจะประมวลผลลอจิกธุรกิจ

ข้อความประกอบด้วยฟิลด์ต่อไปนี้：

ตัวอย่าง：

              
              {
  "message": {
    "msg_content": "Hi,Push",
    "content_type": "text",
    "title": "msg",
    "extras": {
      "key": "value"
    }
  }
}

            

options

ตัวเลือกการ push ตัวเลือกที่มีดังนี้：

multi_language

ฟิลด์นี้คือฟังก์ชันการ push หลายภาษาของบริการ EngageLab Push ช่วยให้คุณสามารถ push เนื้อหาการแจ้งเตือนที่กำหนดเองไปยังผู้ใช้ในภาษาต่างๆ โดยการระบุหลายภาษาและเนื้อหาข้อความ หัวข้อ และหัวข้อย่อยของ iOS ที่เกี่ยวข้องในคำขอ push คุณสามารถส่งการแจ้งเตือน push ที่เหมาะสมตามการตั้งค่าภาษาของผู้ใช้

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

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

              
                 HTTP request method: Post
   Request URL: /v4/push
   POST data format: json
   POST data example:
   {
    "options": {
      "multi_language": {
        "en": {
          "content": "",
          "title": "",
        }
      }
    }
   }

            

ตัวอย่างการตอบกลับ

              
              เมื่อสำเร็จ:
{
   
}

เมื่อล้มเหลว:
{   
    "code":400,  
    "data":"",
  "message":"Error information"
}   

            

third_party_channel

ฟิลด์นี้ใช้เพื่อกรอกข้อมูลส่วนบุคคลของช่องทางระบบเว็บ ชื่อคีย์คือ w3push และค่าคือ Json Object Object Object ประกอบด้วยฟิลด์การกระจายเพียงหนึ่งฟิลด์ที่ไม่จำเป็นของประเภท String

ตัวอย่าง：

              
              {
  "third_party_channel":{
    "w3push":{
      "distribution":"mtpush"
    }
  }
}

            

request_id

รหัสของคำขอ ลูกค้าระบุคำขอและส่งกลับการตอบสนอง

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

              
              {
      "request_id":"12345678"
}

            

ตัวอย่างการตอบกลับ

custom_args

ฟิลด์ที่กำหนดเองโดยผู้ใช้ซึ่งไม่จำเป็น จะไม่ถูกส่งกลับเมื่อมีการตอบสนอง แต่จะถูกส่งกลับเมื่อมีการเรียกกลับ

              
              {
  "custom_args":"business info"
}

            

พารามิเตอร์การตอบกลับ

การตอบกลับที่สำเร็จ

              
              < HTTP/1.1 200 OK
< Content-Type: application/json
{"request_id": "18", "msg_id": "1828256757"}

            

การตอบกลับที่ล้มเหลว

รหัสสถานะ HTTP เป็น 4xx หรือ 5xx และเนื้อหาการตอบกลับประกอบด้วยฟิลด์ต่อไปนี้

              
              {
    "code": 3002,
    "message": "Push.template field must be set correctly when type is template"
}

            

การตอบกลับ

รหัสสถานะ HTTP

อ้างอิง：/docs/web-push/rest-api/http-status-code

รหัสการส่งกลับ

ข้อจำกัดการ push

รหัสหลายภาษา