Logo Site EngageLab Mark Colored TransparentDokumen
Beranda Dokumen
Cari
Indonesian
English
繁體中文
简体中文
日本語
ภาษาไทย
Español
Indonesian
Deutsch
Français
Masuk

SMSHook

Terakhir diperbarui：hampir 3 tahun yang lalu

Callback Status SMS

URL

Diisi sesuai kebutuhan pengguna pada halaman
              
              Diisi sesuai kebutuhan pengguna pada halaman
Tampilkan blok kode ini di jendela mengambang

Content-Type:

application/json; charset=utf-8
              
              application/json; charset=utf-8
Tampilkan blok kode ini di jendela mengambang

Metode Permintaan HTTP

post
              
              post
Tampilkan blok kode ini di jendela mengambang

Header Permintaan

Header Tipe Deskripsi
X-SMSHook-Signature string tanda tangan
X-SMSHook-Timestamp long stempel waktu pembuatan pesan
X-SMSHook-AppKey string appkey aplikasi
X-SMSHook-Version string versi

Isi Permintaan

Parameter Tipe Deskripsi
message_id string ID pesan
from string pengirim (kosong untuk template_approval)
to string penerima (kosong untuk target, sent, dan template_approval)
server string SMS
itime long stempel waktu pembuatan pesan
custom_args json field kustom yang ditentukan pengguna
status json status callback pesan

Status Target SMS

status

Parameter Tipe Deskripsi
message_status string target
status_data json object data status
message string permintaan berhasil
template_id int ID template SMS
template_type int tipe konten SMS
label_id int ID label SMS
user_id int ID pengguna
sms_user string SMS_USER
sms_ids array array ID SMS penerima
to array array penerima
msg_type int tipe SMS
{ "server": "sms", "message_id": "1679392394031_15_17153_881599_c1fjwa", "itime": 1679392394061, "status": { "message_status": "target", "status_data": { "user_id": 15, "to": [ "+8618871186627", "008615727024341" ], "msg_type": 2, "template_id": 881599, "message": "permintaan berhasil", "sms_user": "xiaojinmintest", "sms_ids": [ "1679392394031_15_17153_881599_c1fjwa$+8618871186627", "1679392394031_15_17153_881599_c1fjwa$008615727024341" ], "template_type": 2, "label_id": 0 } } }
              
              {
    "server": "sms", 
    "message_id": "1679392394031_15_17153_881599_c1fjwa", 
    "itime": 1679392394061, 
    "status": {
        "message_status": "target", 
        "status_data": {
            "user_id": 15, 
            "to": [
                "+8618871186627", 
                "008615727024341"
            ], 
            "msg_type": 2, 
            "template_id": 881599, 
            "message": "permintaan berhasil", 
            "sms_user": "xiaojinmintest", 
            "sms_ids": [
                "1679392394031_15_17153_881599_c1fjwa$+8618871186627", 
                "1679392394031_15_17153_881599_c1fjwa$008615727024341"
            ], 
            "template_type": 2, 
            "label_id": 0
        }
    }
}
Tampilkan blok kode ini di jendela mengambang

Status SMS Terkirim

status

Parameter Tipe Deskripsi
message_status string sent
status_data json object data status
message string berhasil dikirim
template_id int ID template SMS
template_type int tipe konten SMS
label_id int ID label SMS
user_id int ID pengguna
sms_user string SMS_USER
sms_ids array array ID SMS penerima
to array array penerima
msg_type int tipe SMS
{ "server": "sms", "message_id": "1679392394031_15_17153_881599_c1fjwa", "itime": 1679392394061, "status": { "message_status": "sent", "status_data": { "user_id": 15, "to": [ "+8618871186627", "008615727024341" ], "msg_type": 2, "template_id": 881599, "message": "berhasil dikirim", "sms_user": "xiaojinmintest", "sms_ids": [ "1679392394031_15_17153_881599_c1fjwa$+8618871186627", "1679392394031_15_17153_881599_c1fjwa$008615727024341" ], "template_type": 2, "label_id": 0 } } }
              
              {
    "server": "sms", 
    "message_id": "1679392394031_15_17153_881599_c1fjwa", 
    "itime": 1679392394061, 
    "status": {
        "message_status": "sent", 
        "status_data": {
            "user_id": 15, 
            "to": [
                "+8618871186627", 
                "008615727024341"
            ], 
            "msg_type": 2, 
            "template_id": 881599, 
            "message": "berhasil dikirim", 
            "sms_user": "xiaojinmintest", 
            "sms_ids": [
                "1679392394031_15_17153_881599_c1fjwa$+8618871186627", 
                "1679392394031_15_17153_881599_c1fjwa$008615727024341"
            ], 
            "template_type": 2, 
            "label_id": 0
        }
    }
}
Tampilkan blok kode ini di jendela mengambang

Status SMS Terkirim & Diterima

status

Parameter Tipe Deskripsi
message_status string delivered
status_data json object data status
message string berhasil diterima
template_id int ID template SMS
template_type int tipe konten SMS
label_id int ID label SMS
user_id int ID pengguna
sms_user string SMS_USER
sms_id string ID SMS
msg_count int jumlah pesan SMS
msg_type int tipe SMS
outbound_time string waktu permintaan ke channel
receipt_time string waktu diterima
{ "server": "sms", "message_id": "1679387065399_15_17155_881597_0poco8$+115927992951", "to": "+115927992951", "itime": 1679388949000, "status": { "message_status": "delivered", "status_data": { "outbound_time": "2023-03-21 16:55:25", "receipt_time": "2023-03-21 16:55:49", "sms_id": "1679387065399_15_17155_881597_0poco8$+115927992951", "user_id": 15, "msg_type": 2, "template_id": 881597, "message": "berhasil diterima", "sms_user": "huangli_SMS", "template_type": 1, "msg_count": 1, "label_id": 0 } } }
              
              {
    "server": "sms", 
    "message_id": "1679387065399_15_17155_881597_0poco8$+115927992951", 
    "to": "+115927992951", 
    "itime": 1679388949000, 
    "status": {
        "message_status": "delivered", 
        "status_data": {
            "outbound_time": "2023-03-21 16:55:25", 
            "receipt_time": "2023-03-21 16:55:49",
            "sms_id": "1679387065399_15_17155_881597_0poco8$+115927992951", 
            "user_id": 15, 
            "msg_type": 2, 
            "template_id": 881597,  
            "message": "berhasil diterima", 
            "sms_user": "huangli_SMS", 
            "template_type": 1, 
            "msg_count": 1, 
            "label_id": 0
        }
    }
}
Tampilkan blok kode ini di jendela mengambang

Status SMS Gagal Diterima

status

Parameter Tipe Deskripsi
message_status string delivered_failed
status_data json object data status
template_id int ID template SMS
template_type int tipe konten SMS
label_id int ID label SMS
user_id int ID pengguna
sms_user string SMS_USER
sms_id string ID SMS
outbound_time string waktu permintaan ke channel
receipt_time string waktu diterima
msg_count int jumlah pesan SMS
msg_type int tipe SMS
error_code int kode error
error_detail json detail error
message string log error
sub_stat int subkategori error, 4xx: gagal proses, 5xx: gagal kirim
sub_stat_desc string pesan error
{ "server": "sms", "message_id": "1679392394031_15_17153_881599_c1fjwa$+8618871186627", "to": "+8618871186627", "itime": 1679392394120, "status": { "message_status": "delivered_failed", "error_code": 480, "error_detail": { "message": "smsworker: pembatasan kebijakan lokal", "sub_stat": 480, "sub_stat_desc": "jenis pengiriman tidak didukung" }, "status_data": { "sms_id": "1679392394031_15_17153_881599_c1fjwa$+8618871186627", "user_id": 15, "msg_type": 2, "template_id": 881599, "outbound_time": "2023-03-21 17:53:14", "receipt_time":"2023-03-21 17:53:37", "sms_user": "xiaojinmintest", "template_type": 2, "msg_count": 1, "label_id": 0 } } }
              
              {
  "server": "sms",
  "message_id": "1679392394031_15_17153_881599_c1fjwa$+8618871186627",
  "to": "+8618871186627",
  "itime": 1679392394120,
  "status": {
    "message_status": "delivered_failed",
    "error_code": 480,
    "error_detail": {
      "message": "smsworker: pembatasan kebijakan lokal",
      "sub_stat": 480,
      "sub_stat_desc": "jenis pengiriman tidak didukung"
    },
    "status_data": {
      "sms_id": "1679392394031_15_17153_881599_c1fjwa$+8618871186627",
      "user_id": 15,
      "msg_type": 2,
      "template_id": 881599,
      "outbound_time": "2023-03-21 17:53:14",
      "receipt_time":"2023-03-21 17:53:37",
      "sms_user": "xiaojinmintest",
      "template_type": 2,
      "msg_count": 1,
      "label_id": 0
    }
  }
}
Tampilkan blok kode ini di jendela mengambang

Callback Respons SMS

URL

Diisi sesuai kebutuhan pengguna pada halaman
              
              Diisi sesuai kebutuhan pengguna pada halaman
Tampilkan blok kode ini di jendela mengambang

Content-Type:

application/json; charset=utf-8
              
              application/json; charset=utf-8
Tampilkan blok kode ini di jendela mengambang

Metode Permintaan HTTP

post
              
              post
Tampilkan blok kode ini di jendela mengambang

Header Permintaan

Header Tipe Deskripsi
X-SMSHook-Signature string tanda tangan
X-SMSHook-Timestamp long stempel waktu pembuatan pesan
X-SMSHook-AppKey string appkey aplikasi
X-SMSHook-Version string versi

Isi Permintaan

Parameter Tipe Deskripsi
message_id string ID pesan
to string penerima
server string SMS
itime long stempel waktu pembuatan pesan
custom_args json field kustom yang ditentukan pengguna
response json respons callback pesan

Respons Balasan SMS

response

Parameter Tipe Deskripsi
event string reply
response_data json object data respons
template_id int ID template SMS
template_type int tipe konten SMS
label_id int ID label SMS
user_id int ID pengguna
sms_user string SMS_USER
sms_id string ID SMS
reply_content int isi balasan
reply_time string waktu balasan
msg_type int tipe SMS
{ "server": "sms", "message_id": "1679364048767_15_15814_905354_3y5z9a$17858502021", "to": "17858502021", "itime": 1679392394128, "response": { "event": "reply", "response_data": { "sms_id": "1679364048767_15_15814_905354_3y5z9a$17858502021", "user_id": 15, "reply_time": "2023-03-21 10:07:17", "msg_type": 2, "template_id": 905354, "sms_user": "cpx_sms", "template_type": 2, "reply_content": "T", "label_id": 0 } } }
              
              {
    "server": "sms", 
    "message_id": "1679364048767_15_15814_905354_3y5z9a$17858502021", 
    "to": "17858502021", 
    "itime": 1679392394128, 
    "response": {
        "event": "reply", 
        "response_data": {
            "sms_id": "1679364048767_15_15814_905354_3y5z9a$17858502021", 
            "user_id": 15, 
            "reply_time": "2023-03-21 10:07:17", 
            "msg_type": 2, 
            "template_id": 905354, 
            "sms_user": "cpx_sms", 
            "template_type": 2, 
            "reply_content": "T", 
            "label_id": 0
        }
    }
}
Tampilkan blok kode ini di jendela mengambang

Callback Status SMS

Notifikasi Persetujuan Template SMS

notification

Parameter Tipe Deskripsi
event string template_approval
notification_data json object data respons
template_id string ID template SMS
template_type int tipe konten SMS
user_id string ID pengguna
msg_type int tipe SMS
approval_status string hasil review template
approval_message string informasi review template
{ "server": "sms", "message_id": "1679364048767_15_15864", "to": "17858502021", "itime": 1679392394179, "notification": { "event": "template_approval", "notification_data": { "user_id": 15, "msg_type": 2, "template_id": 905354, "template_type": 2, "approval_status": "1", "approval_message": "lolos" } } }
              
              {
    "server": "sms", 
    "message_id": "1679364048767_15_15864", 
    "to": "17858502021", 
    "itime": 1679392394179, 
    "notification": {
        "event": "template_approval", 
        "notification_data": {
            "user_id": 15, 
            "msg_type": 2, 
            "template_id": 905354, 
            "template_type": 2, 
            "approval_status": "1", 
            "approval_message": "lolos"
        }
    }
}
Tampilkan blok kode ini di jendela mengambang
Icon Solid Transparent White Qiyu
Hubungi Sales