ตั้งค่าข้อมูลผู้ติดต่อ
ข้อมูลการติดต่อสามารถใช้เป็นเป้าหมายสำหรับการโปรโมทช่องทาง เช่น การแจ้งเตือนแอป, SMS, อีเมล, WhatsApp เป็นต้น เมื่อข้อมูลการติดต่อของผู้ใช้มีการเปลี่ยนแปลง สามารถใช้ API นี้ในการอัปเดตข้อมูล
การตั้งค่าข้อมูลการติดต่อจะต้องอิงตาม EUID
ที่อยู่สำหรับการเรียกใช้งาน
POST /v1/user/contact
การตรวจสอบการเรียกใช้งาน
EngageLab REST API ใช้การตรวจสอบแบบ HTTP Basic Authentication: โดยเพิ่ม Authorization ใน HTTP Header:
Authorization: Basic ${base64_auth_string}
Authorization: Basic ${base64_auth_string}
โค้ดนี้โชว์เป็นหน้าต่างลอย
อัลกอริธึมการสร้าง base64_auth_string คือ: base64(api_key:api_secret)
- ชื่อ Header คือ "Authorization" และค่าคือคู่ "username:password" ที่ถูกแปลงเป็น base64 (คั่นด้วยเครื่องหมายโคลอน)
- ในกรณีของ MA API, username คือ APIKey และ password คือ APISecret โปรดเพิ่มแหล่งข้อมูลประเภท API ในแหล่งข้อมูลเพื่อรับ APIKey และ APISecret
ตัวอย่างการเรียกใช้งาน
Header ของคำขอ
> POST /v1/user/contact
> Content-Type: application/json
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
> POST /v1/user/contact
> Content-Type: application/json
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
โค้ดนี้โชว์เป็นหน้าต่างลอย
เนื้อหาคำขอ
{
"euid":10362473,
"contacts":{
"mobile_phone": "18023456879",
"email": "12@gmail.com"
}
}
{
"euid":10362473,
"contacts":{
"mobile_phone": "18023456879",
"email": "12@gmail.com"
}
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
พารามิเตอร์ของคำขอ
ฟิลด์ | ประเภท | จำเป็นต้องมี | คำอธิบาย |
---|---|---|---|
euid | Long | ใช่ | รหัสผู้ใช้ที่ไม่ซ้ำกัน |
contacts | JSON | ใช่ | คีย์คือชื่อข้อมูลการติดต่อ และค่าคือค่าของข้อมูลการติดต่อ ทั้งหมดเป็นประเภทข้อมูลสตริง |
พารามิเตอร์ที่ส่งกลับ
ฟิลด์ | ประเภท | จำเป็นต้องมี | คำอธิบาย |
---|---|---|---|
code | Int | ใช่ | การเรียกใช้งาน API สำเร็จหรือไม่ 0 หมายถึงสำเร็จหรือสำเร็จบางส่วน ค่าอื่นหมายถึงล้มเหลว |
message | String | ใช่ | คำอธิบายผลลัพธ์ของการเรียกใช้งาน API |
สำเร็จทั้งหมด
{
"code": 0,
"message": "success"
}
{
"code": 0,
"message": "success"
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
ล้มเหลวทั้งหมด
{
"code": 0,
"message": "success"
}
{
"code": 0,
"message": "success"
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
รหัสข้อผิดพลาด
รหัสข้อผิดพลาด | คำอธิบาย | รายละเอียดเพิ่มเติม |
---|---|---|
40050 | การตรวจสอบสิทธิ์ API ล้มเหลว | โปรดยืนยันว่า Project ID และ Project Secret ถูกต้อง |
40007 | EUID ว่างเปล่า | โปรดตรวจสอบค่าของ EUID |
50031 | Project ID ไม่ถูกต้อง | โปรดตรวจสอบว่า APIKey และ APISecret ถูกต้อง |
50034 | Project ID ไม่มีอยู่ | โปรดตรวจสอบว่า APIKey และ APISecret ถูกต้อง และตรวจสอบว่าโปรเจคถูกลบหรือไม่ |
50074 | แหล่งข้อมูล API ไม่มีอยู่ | โปรดตรวจสอบว่า APIKey และ APISecret ถูกต้อง และตรวจสอบว่าแหล่งข้อมูล API ถูกลบหรือไม่ |
55004 | พารามิเตอร์ธุรกิจไม่ถูกต้อง | โปรดตรวจสอบฟิลด์ของพารามิเตอร์คำขอว่าถูกต้องหรือไม่ |
55101 | จำนวนตัวระบุผู้ใช้เกินขีดจำกัด | โปรดยืนยันว่าจำนวนค่าของตัวระบุผู้ใช้ไม่เกิน 100 |
55102 | มีชื่อคุณสมบัติผู้ใช้ที่ไม่ถูกต้อง | โปรดยืนยันว่าชื่อคุณสมบัติตรงตามข้อกำหนดหรือไม่, ว่างเปล่า/ใช้ตัวอักษรที่สงวนไว้/เกินขีดจำกัดความยาวหรือไม่ |
55103 | ค่าคุณสมบัติผู้ใช้ไม่สามารถว่างเปล่าได้ | โปรดยืนยันว่าค่าคุณสมบัติผู้ใช้ในเนื้อหาคำขอไม่ว่างเปล่า |
55105 | ค่าของตัวระบุผู้ใช้ไม่สามารถเกิน 256 อักขระได้ | โปรดยืนยันว่าค่าของตัวระบุผู้ใช้ไม่เกิน 256 อักขระ |
55106 | ชื่อตัวระบุผู้ใช้ไม่อยู่ในขอบเขตที่รองรับ | โปรดยืนยันว่าชื่อตัวระบุผู้ใช้คือ user_id, anonymous_id หรือ registration_id |
55107 | ค่าของตัวระบุผู้ใช้ว่างเปล่า | โปรดยืนยันว่าค่าของตัวระบุผู้ใช้ในเนื้อหาคำขอไม่ว่างเปล่า |
55108 | EUID ไม่ถูกต้อง | โปรดตรวจสอบค่าของ EUID |
-1 | ข้อผิดพลาดภายในเซิร์ฟเวอร์ | โปรดติดต่อฝ่ายสนับสนุนด้านเทคนิคของ EngageLab |