Campaign

สร้างแคมเปญ

Create Campaign

POST https://bulk.smsyouto.com/api/bulk/campaign

Headers

Name	Type	Description
Authorization*	String	Bearer API Key
Content-Type*	String	application/json

Request Body

Name	Type	Description
phone*	String	เบอร์โทรศัพท์ผู้รับ
message*	String	เบอร์โทรศัพท์ผู้รับ
sender*	String	ชื่อผู้ส่ง
scheduler	String	เวลาส่ง

201: Created

{
    "status": 201,
    "count": 1,
    "campaignID": "LNcTSVmvPbkDbOAFO",
    "scheduler": "2023-11-08 11:36:32",
    "message": "create campaign successfully"
}

400: Bad Request

{
    "status": 400,
    "message": "phone is required"
}

401: Unauthorized

{
    "message": "Access Denied"
}

หมายเหตุ

phone : สามารถใส่เป็น array ได้ เช่น ["0123456789", "9876543210"]

scheduler : สามารถกำหนดเวลาส่งได้ หรือ หากไม่กำหนดจะเริ่มยิงแคมเปญทันที

จำกัดจำนวนเบอร์ 30000 เบอร์/request

รับเครดิตคืนจาก Campaign

Refund Campaign

POST https://bulk.smsyouto.com/api/bulk/campaign/refund

Headers

Name	Type	Description
Authorization*	String	Bearer
Content-Type*	String	application/json

Request Body

Name	Type	Description
campaignId*	String	แคมเปญไอดี

200: OK

{
    "status": 200,
    "creditrefund": 100,
    "message": "claimed successfully"
}

400: Bad Request

{
    "status": 400,
    "message": "You can receive it after 13 hours"
}

401: Unauthorized

{
    "message": "Access Denied"
}

404: Not Found

{
    "status": 404,
    "message": "campaign not found"
}

หมายเหตุ

สามารถกดรับได้หลังจากผ่านไป 24 ชั่วโมง นับจากเวลาสร้างแคมเปญ

รายละเอียดแคมเปญ

Log Campaign

GET https://bulk.smsyouto.com/api/bulk/log/campaign/{campaignID}

Query Parameters

Name	Type	Description
start	String	หน้าที่จะแสดง
end	String	โชว์จำนวนรายการ
statustype	String	สถานะ (failure, success)
campaignID*	String	แคทเปญไอดี

Headers

Name	Type	Description
Authorization*	String	Bearer

404: Not Found

{
    "status": 400,
    "message": "campaign not found"
}

200: OK

{
    "total": 1,
    "totalAll": 1,
    "creditrefund": 1,
    "refund": "Not Received",
    "scheduler": "2023-11-08 11:36:32",
    "data": [
        {
            "code": "000",
            "messageid": "16994181960256198",
            "sender": "SMSYOUTOAPI",
            "status": "success",
            "infomation": "Successfully sent to phone",
            "message": "ทดสอบระบบ",
            "phone": "0123456789"
        }
    ]
}

ตัวอย่าง

curl --location 'https://bulk.smsyouto.com/api/bulk/log/campaign/LNcsTSVmsvPbkbOAFO?start=1&end=1000&statustype=failure' \
--header 'Authorization: Bearer API Key'

หมายเหตุ

Start : สามารถกำหนดหรือไม่กำหนดก็ได้ Default คือ 1

End : สามารถกำหนดหรือไม่กำหนดก็ได้ Default คือ 25

statustype: สามารถกำหนดหรือไม่กำหนดก็ได้ Default โชว์ทุกสถานะ