Push Plan API

Terakhir diperbarui：2023-11-15

API pada modul ini berfokus pada pembuatan, pembaruan, dan kueri terkait ID push plan.

Verifikasi Panggilan

Untuk detail, lihat [Metode Autentikasi](/zh_CN/docs/app-push/rest-api/rest-api-overview#Authentication Method) di bagian REST API Overview.

Membuat dan Memperbarui Push Plan

API ini digunakan untuk membuat atau memperbarui push plan. Dengan mengisi plan_id dan plan_description, sistem akan membuat atau memperbarui sesuai ada/tidaknya plan_id.

Endpoint

POST v4/push_plan

              
              POST v4/push_plan

Tampilkan blok kode ini di jendela mengambang

Parameter Permintaan

Nama Parameter	Tipe	Wajib	Deskripsi
plan_id	string	Ya	Penanda unik push plan Format: huruf (case-sensitive), angka, garis bawah, tidak boleh diawali garis bawah. Panjang maksimal 50 karakter. Tidak dapat diubah setelah ditetapkan. Jika sudah ada, update plan_description. Jika belum, buat plan baru.
plan_description	string	Ya	Deskripsi push plan Harus memuat info bisnis utama (skenario, target, isi push). Mendukung bahasa Indonesia, Inggris, angka, tanda baca umum. Saran maksimal 128 karakter.

Contoh Permintaan

{ "plan_id": "push_20231001_001", "plan_description": "Push plan untuk event promosi 11.11, mencakup seluruh pengguna" }

              
              {
  "plan_id": "push_20231001_001",
  "plan_description": "Push plan untuk event promosi 11.11, mencakup seluruh pengguna"
}

Tampilkan blok kode ini di jendela mengambang

Deskripsi Respons

Respons Berhasil

{ "plan_id": "push_20231001_001" }

              
              {
  "plan_id": "push_20231001_001"
}

Tampilkan blok kode ini di jendela mengambang

Respons Gagal

{ "error": { "code": 27303, "message": "plan id kosong" } }

              
              {
  "error": {
    "code": 27303,
    "message": "plan id kosong"
  }
}

Tampilkan blok kode ini di jendela mengambang

Kueri Push Plan

API ini digunakan untuk mengkueri daftar push plan secara bertahap, mendukung filter berdasarkan sumber pengiriman dan pencarian fuzzy pada deskripsi plan/ID plan.

Endpoint

GET v4/push_plan/list?page_index=x&page_size=xx&send_source=x&search_description=xxx

              
              GET v4/push_plan/list?page_index=x&page_size=xx&send_source=x&search_description=xxx

Tampilkan blok kode ini di jendela mengambang

Parameter Permintaan

Nama Parameter	Tipe	Wajib	Deskripsi
page_index	int	Ya	Nomor halaman untuk paginasi (mulai dari `1`)
page_size	int	Ya	Jumlah data per halaman, maksimal `100`
send_source	int	Tidak	Sumber pengiriman: `0`-API, `1`-Web Console
search_description	string	Tidak	Pencarian fuzzy pada deskripsi plan/plan ID (bahasa Indonesia, Inggris, angka, garis bawah)

Contoh Permintaan

GET /v4/push_plan/list?page_index=1&page_size=20&send_source=1&search_description=Double 11

              
              GET /v4/push_plan/list?page_index=1&page_size=20&send_source=1&search_description=Double 11

Tampilkan blok kode ini di jendela mengambang

Deskripsi Respons

Respons Berhasil

{ "push_plan_info": [ { "plan_id": "push_20231111", "plan_description": "Push Plan Double 11 seluruh situs", "count": 15, "create_time": "2023-11-01T10:00:00Z", "last_used_time": "2023-11-11T20:30:00Z" } ], "total": 1 }

              
              {
  "push_plan_info": [
    {
      "plan_id": "push_20231111",
      "plan_description": "Push Plan Double 11 seluruh situs",
      "count": 15,
      "create_time": "2023-11-01T10:00:00Z",
      "last_used_time": "2023-11-11T20:30:00Z"
    }
  ],
  "total": 1
}

Tampilkan blok kode ini di jendela mengambang

Respons Gagal

{ "error": { "code": 1003, "message": "Nilai parameter tidak valid" } }

              
              {
    "error": {
        "code": 1003,
        "message": "Nilai parameter tidak valid"
    }
}

Tampilkan blok kode ini di jendela mengambang

Kueri Msgid Berdasarkan Push Plan

API ini digunakan untuk mengambil ID pesan yang terkait dengan push plan tertentu dalam satu bulan terakhir, serta mendukung kueri batch dari beberapa plan.

Endpoint

GET /v4/status/plan/msg/?plan_ids=xxxxxx,xxxxxx&start_date=yyyy-MM-dd&end_date=yyyy-MM-dd

              
              GET /v4/status/plan/msg/?plan_ids=xxxxxx,xxxxxx&start_date=yyyy-MM-dd&end_date=yyyy-MM-dd

Tampilkan blok kode ini di jendela mengambang

Parameter Permintaan

Nama Parameter	Tipe	Wajib	Deskripsi
plan_ids	string	Ya	Daftar ID push plan, dipisahkan koma (,) untuk beberapa ID, maksimal 1000 ID
start_date	string	Ya	Tanggal mulai (Format: `yyyy-MM-dd`), harus: 1. Dalam 30 hari sebelum hari ini 2. Tanggal akhir >= tanggal mulai
end_date	string	Ya	Tanggal akhir (Format: `yyyy-MM-dd`), harus: 1. Jarak tanggal mulai-akhir ≤ 31 hari 2. Tidak lebih awal dari tanggal mulai

Contoh Permintaan

GET /v4/status/plan/msg/?plan_ids=push_20231101,push_20231102&start_date=2023-11-01&end_date=2023-11-15

              
              GET /v4/status/plan/msg/?plan_ids=push_20231101,push_20231102&start_date=2023-11-01&end_date=2023-11-15

Tampilkan blok kode ini di jendela mengambang

Deskripsi Respons

Respons Berhasil

{ "push_20231101": { "msg_ids": ["msg_001", "msg_002"] }, "push_20231102": { "msg_ids": ["msg_003"] } }

              
              {
  "push_20231101": {
    "msg_ids": ["msg_001", "msg_002"]
  },
  "push_20231102": {
    "msg_ids": ["msg_003"]
  }
}

Tampilkan blok kode ini di jendela mengambang

Respons Gagal

{ "error": { "code": 21044, "message": "Rentang waktu melebihi satu bulan." } }

              
              {
    "error": {
        "code": 21044,
        "message": "Rentang waktu melebihi satu bulan."
    }
}

Tampilkan blok kode ini di jendela mengambang

Hapus Push Plan

API ini digunakan untuk menghapus push plan. Dengan memasukkan plan_id, sistem akan menghapus plan jika ditemukan.

Endpoint

POST v4/push_plan/{plan_id}

              
              POST v4/push_plan/{plan_id}

Tampilkan blok kode ini di jendela mengambang

Parameter Permintaan

Nama Parameter	Tipe	Wajib	Deskripsi
plan_id	string	Ya	Penanda unik push plan

Contoh Permintaan

curl -X DELETE http://127.0.0.1/v4/push_plan/push_20231001_001 -u "appKey:appSecret"

              
              curl -X DELETE http://127.0.0.1/v4/push_plan/push_20231001_001 -u "appKey:appSecret"

Tampilkan blok kode ini di jendela mengambang

Deskripsi Respons

Respons Berhasil

{ "plan_id": "push_20231001_001" }

              
              {
  "plan_id": "push_20231001_001"
}

Tampilkan blok kode ini di jendela mengambang

Respons Gagal

{ "error": { "code": 27305, "message": "Plan id tidak ditemukan" } }

              
              {
  "error": {
    "code": 27305,
    "message": "Plan id tidak ditemukan"
  }
}

Tampilkan blok kode ini di jendela mengambang

Deskripsi Kode Error

Kode Error	Deskripsi	Saran Penanganan
21015	Parameter permintaan pembuatan push plan tidak benar	Periksa apakah tipe `plan_id` atau `plan_description` sudah benar
27300	Penanda push plan tidak valid	Periksa `plan_id` agar sesuai aturan penamaan
27301	Deskripsi push plan tidak valid	Periksa `plan_description` agar sesuai aturan
27303	Penanda push plan kosong	Isi plan_id yang valid saat membuat push plan
27304	Panjang penanda push plan melebihi batas	Pastikan panjang plan_id < 50 karakter
21004	Verifikasi izin membuat push plan gagal	Pastikan pemanggil punya izin akses ke API
27000	Kesalahan server internal	Hubungi dukungan teknis atau coba ulang
1003	Parameter kueri push plan tidak valid	Periksa `page_index/page_size` > 0
21004	Verifikasi izin kueri push plan gagal	Pastikan pemanggil punya izin akses ke API
27302	Melebihi batas penggunaan push plan	Hubungi dukungan teknis untuk menambah batas
21009	Kesalahan sistem internal, tidak dapat diulang	Hubungi dukungan teknis
23001	Verifikasi izin kueri Msgid berdasarkan push plan gagal	Pastikan pemanggil punya izin akses ke API
3010	Jumlah panggilan API pada antarmuka kueri melebihi batas	Hubungi dukungan teknis
23002	Parameter pl untuk kueri Msgid tidak valid	Periksa validitas plan_ids atau parameter tanggal
21003	Tanggal yang dimasukkan tidak valid	Periksa validitas tanggal
21044	Jarak tanggal mulai-akhir melebihi satu bulan	Pastikan jarak tanggal mulai-akhir < 1 bulan