សូមស្វាគមន៍អ្នកមើលដ៏មានតម្លៃរបស់ខ្ញុំ អ្នកនឹងរៀនពីរបៀបដើម្បីទាញយកប្រយោជន៍ពី API Key នៃសេវាកម្ម SMS របស់ 1Byte និងរបៀបបញ្ចូលគន្លឹះដ៏អស្ចារ្យនេះទៅក្នុងកម្មវិធីរបស់អ្នក ឬកម្មវិធីអ្វីផ្សេងទៀតដែលអ្នកចង់បាននៅក្នុងការបង្រៀននេះពី 1Byte.

តើអ្វីទៅជា API Key?
ដើម្បីរក្សាការបង្ហោះកុំឱ្យវែងពេក និងដើម្បីទាក់ទាញអ្នកដែលមិនស្គាល់ចំណេះដឹង IT ខ្ញុំនឹងរៀបរាប់វាឱ្យសាមញ្ញតាមដែលអាចធ្វើទៅបាន។
សន្មត់ថាថ្មីៗនេះអ្នកបានបើកដំណើរការកម្មវិធីដែលអ្នកបានបង្កើតដោយខ្លួនឯង។ ឥឡូវនេះអ្នកចង់ឱ្យកម្មវិធីរបស់អ្នកអាច ផ្ញើសារ SMS ច្រើន។ ប៉ុន្តែអ្នកមិនដឹងពីរបៀបសរសេរកូដ និងអនុវត្តមុខងារនេះទេ។
→ ដំណោះស្រាយរបស់អ្នកគឺត្រូវស្វែងរកវិធីមួយដើម្បីបញ្ចូលសេវា 1Byte SMS ទៅក្នុងកម្មវិធីរបស់អ្នក។
ដោយសារតែវត្តមានរបស់ 1Byte API Keyឥឡូវនេះ អ្នកអាចប្រើ API Key ដែលរួមបញ្ចូលទៅក្នុងកម្មវិធីផ្ទាល់ខ្លួនរបស់អ្នក។
→ ជាលទ្ធផល អ្នកមិនចាំបាច់ប្រើវេទិកា 1Byte ដើម្បីផ្ញើសារ SMS ទេ (ចូលទៅក្នុងគណនី 1Byte ហើយផ្ញើសារពី 1Byte) ជំនួសមកវិញ កម្មវិធីរបស់អ្នកអាចប្រើមុខងារសេវា 1Byte SMS ដែលភ្ជាប់មកជាមួយ។
តម្រូវការទុកជាមុន
1) អ្នកត្រូវតែមាន Brandname ដែលមើលទៅសមស្របមួយ
→ ប្រសិនបើអ្នកមិនទាន់មាន BrandName នៅឡើយទេ សូមមើល ការណែនាំសម្រាប់បង្កើត BrandName ពី 1Byte។
2) អ្នកត្រូវមាន API Key
→ ជ្រើសរើស API Key Management ពី User Dashboard ។ អ្នកនឹងឃើញ SMS API Key នៅទីនោះ។

3) បញ្ជីអ្នកទទួលនៅក្នុង ទម្រង់ JSONជាធម្មតាបញ្ជីនេះភ្ជាប់មកជាមួយ 3 ព័ត៌មានសំខាន់ៗ៖ ឈ្មោះ លេខទូរស័ព្ទ និងថ្ងៃខែឆ្នាំកំណើត។
→ អ្នកអាចប្រើ Convertio ដើម្បីបំប្លែងពី Excel ទៅជាទម្រង់ JSON
ព័តមានទូទៅ
1Byte’s API ដំណើរការតែលើ HTTPS protocol
→ គ្មាននរណាម្នាក់អាចក្លែងបន្លំខ្លឹមសារសាររបស់អ្នកបានទេ
កំណត់ការហៅ API ទៅ 100 ដងក្នុងមួយនាទី។
→ គោលបំណងនេះគឺដើម្បីការពារតួអង្គអាក្រក់ពីការកេងប្រវ័ញ្ច និង brute-forcing API Key
API ទិន្នន័យឆ្លើយតបនឹងចូល JSON format
APIs នឹងឆ្លើយតបជាមួយនឹងកូដស្ថានភាព HTTP ដែលសមស្របដូចខាងក្រោម
លេខកូដស្ថានភាព API | |||
កូដ HTTP | 200 | 4XX | 5XX |
ការពន្យល់ | - ផ្ញើសារ SMS ដោយជោគជ័យ | - សមតុល្យរបស់អ្នកមិនគ្រប់គ្រាន់ - ឈ្មោះម៉ាកមិនត្រឹមត្រូវ - ... ។ល។ | - កំហុសម៉ាស៊ីនមេខាងក្នុង - ... ។ល។ |
+ API ផ្ញើ SMS
API ផ្ញើ SMS | |
ការពិពណ៌នា | API ផ្ញើ SMS |
URL | {{API_BASE_URL}}/external/sms |
វិធីសាស្រ្ត | POST |
ការអនុញ្ញាត | API Key |
តួ | JSON |
{ { "timezone": "string", "brandName": "string", "subject": "string", "content": "string", "type": "NOW", "sendingTime": "2022-02-14T08:10:26.730Z", "sendBefore": { "day": {0, "bth": " list "string", "name": "string", //(ស្រេចចិត្ត) "phoneNumber": "string" } ] } }
- ការឆ្លើយតបជោគជ័យ
- លេខកូដ: 200
- Content
{
"messageCode": "SEND_SMS_SUCCESSFUL",
"message": "Your request has been sent to queue"
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
}
- ការឆ្លើយតបកំហុស
- លេខកូដ: `404
- Content
{
"statusCode": 404,
"message": string ,
"messageCode": string
}
- ការឆ្លើយតបកំហុស
- លេខកូដ: `400
- Content
{
"statusCode": 400,
"message": [],
"error": string
}
តួអត្ថបទ
- ឈ្មោះម៉ាក៖ (ចាំបាច់) ឈ្មោះម៉ាក SMS
- ប្រធានបទ៖ (ចាំបាច់) បឋមកថានៃពាក្យបញ្ជា SMS
- ខ្លឹមសារ៖ (ចាំបាច់) ខ្លឹមសារសារ SMS ផ្ញើទៅអ្នកទទួល
- ប្រភេទ៖ (ចាំបាច់) ទទួលយកតែតម្លៃខាងក្រោម៖
- បច្ចុប្បន្ន៖ ផ្ញើភ្លាមៗ
- បុណ្យខួបកំណើត: ផ្ញើតាមថ្ងៃខែឆ្នាំកំណើត
- ពេលវេលា៖ បានផ្ញើនៅថ្ងៃអនាគត
- ពេលវេលាបញ្ជូន: (ទាមទារនៅពេលដែលប្រភេទគឺ TIME) ប្រភេទកាលបរិច្ឆេទជាមួយ ISO 8601 ទ្រង់ទ្រាយ។
- តំបន់ពេលវេលា៖ (ទាមទារនៅពេលដែលប្រភេទគឺជាថ្ងៃកំណើត) តំបន់ពេលវេលារបស់អ្នកទទួលសារ។ មើលបញ្ជីនៃ ពេលវេលានៅទីនេះ។
- ផ្ញើមុន: (តម្រូវឱ្យមាននៅពេលដែលប្រភេទគឺ BIRTHDAY) រួមបញ្ចូលទាំងតម្លៃពីរ:
- ថ្ងៃ៖ (ចាំបាច់) បង្ហាញថាតើប៉ុន្មានថ្ងៃមុនថ្ងៃកំណើតរបស់អ្នកទទួល សារត្រូវបានផ្ញើ។ រហូតដល់ 7 ថ្ងៃ។
- នៅ: (ចាំបាច់) ពេលវេលាដើម្បីផ្ញើសារ។ ទម្រង់ 24 ម៉ោង HH: ss
- បញ្ជីអ្នកប្រើប្រាស់៖ (ចាំបាច់) បញ្ជីអ្នកទទួលសារ។ អ្នកទទួលនីមួយៗមានព័ត៌មានដូចខាងក្រោម៖
- ឈ្មោះ៖ ឈ្មោះអ្នកទទួល [Optional]
- លេខទូរស័ព្ទ៖ (ចាំបាច់) លេខទូរស័ព្ទចាប់ផ្តើមដោយ +855
- ថ្ងៃខែឆ្នាំកំណើត៖ (ទាមទារនៅពេលដែលប្រភេទគឺ BIRTHDAY) ថ្ងៃខែឆ្នាំកំណើត ទម្រង់ dd/mm/yyyy
មួយជំហានម្តងៗ
+ ជំហានទី1៖ ដោយប្រើសំណើ POST ហើយសំណើ POST នេះនឹងត្រូវបានផ្ញើទៅកាន់ URL នេះ៖
+ ជំហានទី១៖ បញ្ចូល API Key ចូលទៅក្នុងផ្នែកបឋមកថានៃសំណើ POST

+ ជំហានទី១៖ បញ្ចូល សារ SMS (ទន្និន័យ) ក្នុង ជួរដេក + JSON ទម្រង់នៅក្នុងផ្នែកតួនៃសំណើ POST

ចំណាំ៖ សូមលុបមតិយោបល់ទាំងអស់នៅក្នុងសារ SMS របស់អ្នក។
ទន្និន័យ Sms (JSON Format)
ករណីទី១៖ ប្រភេទផ្ញើគឺ "NOW" (ផ្ញើភ្លាមៗ)
//This is the HEADER section of POST request
X-API-KEY: 6b085be6d3df56c4ac9xxxxxxxxx9e51 //insert your SMS API KEY here
//This is the BODY section of POST request
{
"brandName": "1Byte-Demo", //insert your SMS Brandname in here
"subject": "Warning about COVID-19 ", //insert your SMS title in here
"content": "Require all employees of company A to wear masks when working ", //insert your SMS content in here
"type": "NOW",
"listUser": [
{
"name": "Person A", //insert your customer name in here (Optional)
"phoneNumber": "+855123123123" //insert your customer phone in here
},
{
"name": "Person B", //insert your customer name in here (Optional)
"phoneNumber": "+855123456789" //insert your customer phone in here
}
]
}
ករណីទី 2៖ ប្រភេទផ្ញើគឺ "BIRTHDAY" (ផ្ញើដោយផ្អែកលើថ្ងៃកំណើត)
//This is the HEADER section of POST request
X-API-KEY: 6b085be6d3df56c4ac9xxxxxxxxx9e51 //insert your SMS API KEY here
{
"brandName": "1Byte-Demo", //insert your SMS Brandname in here
"subject": "Happy Brithday", //insert your SMS title in here
"content": "1Byte would like to wish you happy brithday!!!", //insert your SMS content in here
"type": "BIRTHDAY",
"timezone": "Asia/Phnom_Penh",
"sendBefore": {
"day": 0, //From the date of birth of the recipient, send 0 days before
"at": "24:00" //Send at 24:00 (midnight - 12PM)
},
"listUser": [
{
"name": "Person A", //insert your customer name in here (Optional)
"phoneNumber": "+855123123123", //insert your customer phone in here
"birthday": "22/02/1992" //insert your customer DOB in here
},
{
"name": "Person B", // (Optional)
"phoneNumber": "+855123456789",
"birthday": "22/02/1992"
}
]
}'
ករណីទី 3៖ ប្រភេទផ្ញើគឺ "TIMER" (ផ្ញើដោយផ្អែកលើថ្ងៃជាក់លាក់មួយនាពេលអនាគត)
//This is the HEADER section of POST request
X-API-KEY: 6b085be6d3df56c4ac9xxxxxxxxx9e51 //insert your SMS API KEY here
//This is the BODY section of POST request
{
"brandName": "1Byte-Demo", //insert your SMS Brandname in here
"subject": "Change of workplace", //insert your SMS title in here
"content": "We will no longer work here, but will move to Building B instead ",
"type": "TIMER",
"sendingTime": "2022-02-22T08:00:00.000Z", //will be send on 22-Feb-2022 at 8AM
"listUser": [
{
"name": "Person A", //insert your customer name in here (Optional)
"phoneNumber": "+855123123123" //insert your customer phone in here
},
{
"name": "Person B", // (Optional)
"phoneNumber": "+855123456789"
}
]
}'
សន្និដ្ឋាន
- សូមអបអរសាទរអ្នកបានធ្វើវាបានឆ្ងាយ។ ឥឡូវអ្នកដឹងពីរបៀបបញ្ចូលគ្នា សោ API របស់ 1Byte ចូលទៅក្នុងគេហទំព័រ ឬកម្មវិធីរបស់អ្នកដោយមិនចាំបាច់ចូល គេហទំព័ររបស់ 1Byte
- ប្រសិនបើអ្នកមានកង្វល់បន្ថែម ឬត្រូវការជំនួយ អ្នកអាចទាក់ទងទៅ LiveChat របស់ 1Byte ជំនួយការអតិថិជននៅពេលណាក៏បាន។