Get Campaign

การค้นหาข้อมูล Campaign

ใช้สำหรับค้นหาข้อมูล Campaign ที่สร้างไว้ตามเงื่อนไขที่กำหนด ถ้าไม่กำหนดเงื่อนไขจะดึงข้อมูล Campaign ทั้งหมดของแต่ละ Account

Request

ผู้ใช้งานสามารถเริ่มสร้าง HTTP ตามรายละเอียดดังนี้

หัวข้อ	รายละเอียด
HTTP Request (URL):	http://e-coupon.azurewebsites.net/API/GetCampaign
HTTP Headers	Content-Type: application/json
Authorization	Basic Auth
HTTP Methods	POST

ผู้ใช้งานสามารถระบุ Request body ด้วย Parameter ดังนี้

Parameter	ประเภท	รายละเอียด
ID	Int	รหัสแคมเปญ
NAME	String (200)	ชื่อแคมเปญ
REF_1	String (150)	รหัสหรือข้อมูลอ้างอิง 1(แคมเปญ)
REF_2	String (150)	รหัสหรือข้อมูลอ้างอิง 2(แคมเปญ)
REF_3	String (150)	รหัสหรือข้อมูลอ้างอิง 3(แคมเปญ)
REF_4	String (150)	รหัสหรือข้อมูลอ้างอิง 4 (แคมเปญ)

ตัวอย่าง Request JSON

{ 
    "ID": 272, 
    "NAME": "", 
    "REF_1": "", 
    "REF_2": "REDEEMTION", 
    "REF_3": "", 
    "REF_4": "" 
}

Response

Response ตอบกลับผู้ใช้งาน ดังนี้

ชุดข้อมูลผลลัพธ์	ประเภทข้อมูล	รายละเอียด
ID	Int	รหัสแคมเปญ
NAME	String (200)	ชื่อแคมเปญ
MESSAGE	String (1000)	ข้อความที่ส่ง SMS
DESCRIPTION	String (2000)	รายละเอียดแคมเปญ
USE_EXPIRE_ON_COUPON	String (1)	สถานะการกำหนดวันหมดอายุ มี 2 ค่า คือ Y=กำหนดวันหมดอายุ, N =ไม่กำหนดวันหมดอายุ
START_DATE	String (19)	วันที่เริ่มแคมเปญ Format Datetime: yyyy-MM-dd HH:mm:ss (ปีค.ศ.)
END_DATE	String (19)	วันที่สิ้นสุดแคมเปญ Format Datetime: yyyy-MM-dd HH:mm:ss (ปีค.ศ.)
PREFIX	String (3)	รหัสนำหน้ารหัสคูปอง
ONE_TIME_COUPON	String (1)	สถานะระบุว่าคูปองสามารถใช้ได้ 1 หมายเลขโทรศัพท์ 1 คูปอง มี 2 ค่า คือ Y=1เบอร์/1คูปอง, N =ไม่ระบุ
USE_VERIFY_PHONE_NUMBER	String (1)	สถานะระบุว่าถ้าจะ verify คูปองต้องระบุหมาย เลขโทรศัพท์ที่หน้าระบบให้ตรงก่อน มี 2 ค่า คือ Y = Verify, N = Not Verify
USE_VERIFY_BRANCH	String (1)	สถานะระบุว่าถ้า verify คูปองต้องระบุรหัส Branch ให้ตรงกับที่มีในระบบ มี 2 ค่า คือ Y = Verify ต้องระบุรหัส Branch, N = Verify ไม่ต้องระบุรหัส Branch
USE_MAX_COUPON	Int	จำนวนที่สามารถสร้างคูปองนี้ได้สูงสุด ถ้าเป็น 0 = ไม่ได้จำกัด
COUPON_COUNT	Int	จำนวนคูปองที่สร้างไปแล้ว
USE_MAX_REDEEM	Int	จำนวนที่สามารถใช้งานได้สูงสุด ถ้าเป็น 0 = ไม่ได้จำกัด
REDEEM_COUNT	Int	จำนวนคูปองที่ใช้แล้ว
SENDER	String (20)	Sender ที่ส่ง SMS
SHOW_REDEEM_BTN	String (1)	สถานะการแสดงปุ่ม Redeem มี 2 ค่า คือ Y = แสดงปุ่ม, N = ไม่แสดงปุ่ม
SHOW_CODE	String (1)	สถานะการแสดงรหัสคูปอง มี 2 ค่า คือ Y = แสดงรหัสก่อน Redeem, N = แสดงรหัสหลัง Redeem
STATUS	String (1)	สถานะแคมเปญ (Active, Pause)
REF_1	String (150)	รหัสหรือข้อมูลอ้างอิง 1 (แคมเปญ)
REF_2	String (150)	รหัสหรือข้อมูลอ้างอิง 2 (แคมเปญ)
REF_3	String (150)	รหัสหรือข้อมูลอ้างอิง 3 (แคมเปญ)
REF_4	String (150)	รหัสหรือข้อมูลอ้างอิง 4 (แคมเปญ)
REDEEM_CALLBACK_URL	String (100)	URL ของ redeem callback
IMG_PATH	String (200)	Path รูปแคมเปญ

ตัวอย่าง Response JSON

[ 
    { 
        "ID": 272, 
        "NAME": "Yves Rocher (ตัวอย่าง)", 
        "MESSAGE": "คุณได้รับCoupon คลิก =>", 
        "DESCRIPTION": "CAMPAGIN ราคา 100 Point นำ Coupon ไปใช้แทนเงินสดได้ที่หน้าร้านค่ะ", 
        "USE_EXPIRE_ON_COUPON": "Y", 
        "START_DATE": "2020-12-01 00:01:00", 
        "END_DATE": "2020-12-31 23:59:00", 
        "PREFIX": "", 
        "ONE_TIME_COUPON": "N", 
        "USE_VERIFY_PHONE_NUMBER": "N", 
        "USE_VERIFY_BRANCH": "N", 
        "USE_MAX_COUPON": 0, 
        "USE_MAX_REDEEM": 0, 
        "COUPON_COUNT": 1, 
        "REDEEM_COUNT": 0, 
        "SENDER": "Verify", 
        "SHOW_REDEEM_BTN": "Y", 
        "SHOW_CODE": "N", 
        "STATUS": "ACTIVE", 
        "REF_1": "100", 
        "REF_2": "REDEEMTION", 
        "REF_3": "100BC", 
        "REF_4": "", 
        "REDEEM_CALLBACK_URL": "http://callbackgw.azurewebsites.net/api/salesforce/callback", 
        "IMG_PATH": "https://codeal.me/UploadedFiles/Ants_E-coupon/272_yves860.jpg" 
    } 
]