การส่ง
ส่ง SMS ด้วย POST /v1/messages
/v1/messagesส่งข้อความหนึ่งรายการไปยังหมายเลขเดียว ค่าบริการจะถูกหักจากยอดเงินเมื่อคำขอได้รับการยอมรับ
เนื้อหาคำขอ
- tostringจำเป็น
หมายเลขในรูปแบบสากล เช่น +14155550123 ช่องว่าง, ยัติภังค์, วงเล็บ และคำนำหน้า 00 จะถูกทำความสะอาด
- textstringจำเป็น
ข้อความ สูงสุด 10 segments; ดู Text and segments
- referencestringไม่จำเป็น
รหัสของคุณเอง สูงสุด 100 ตัวอักษร จะปรากฏในออบเจ็กต์ข้อความและทุก webhook
- send_atstringไม่จำเป็น
เวลาในการส่งในรูปแบบ ISO 8601 เร็วสุด 2 นาที ช้าสุด 45 วัน หากไม่ระบุ ข้อความจะเข้าคิวทันที
เพิ่มเฮดเดอร์ Idempotency-Key เพื่อให้การลองส่งซ้ำปลอดภัย: ดู Idempotency
curl https://bulksmsapi.cc/v1/messages \
-H "Authorization: Bearer $BULKSMSAPI_KEY" \
-H "Content-Type: application/json" \
-d '{
"to": "+14155550123",
"text": "Your Northwind code is 482913. It expires in 10 minutes.",
"reference": "login-7781"
}'// Node.js 18 or newer (built-in fetch)
const res = await fetch("https://bulksmsapi.cc/v1/messages", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.BULKSMSAPI_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
to: "+14155550123",
text: "Your Northwind code is 482913. It expires in 10 minutes.",
reference: "login-7781",
}),
});
const message = await res.json();
console.log(res.status, message.id, message.status, message.price);# Python 3, standard library only
import json, os, urllib.request
req = urllib.request.Request(
"https://bulksmsapi.cc/v1/messages",
data=json.dumps({
"to": "+14155550123",
"text": "Your Northwind code is 482913. It expires in 10 minutes.",
"reference": "login-7781",
}).encode(),
headers={
"Authorization": "Bearer " + os.environ["BULKSMSAPI_KEY"],
"Content-Type": "application/json",
"User-Agent": "northwind-app/1.0",
},
method="POST",
)
with urllib.request.urlopen(req) as res:
message = json.load(res)
print(res.status, message["id"], message["status"], message["price"])<?php
// PHP 7.4 or newer with the curl extension
$ch = curl_init("https://bulksmsapi.cc/v1/messages");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("BULKSMSAPI_KEY"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"to" => "+14155550123",
"text" => "Your Northwind code is 482913. It expires in 10 minutes.",
"reference" => "login-7781",
]),
]);
$message = json_decode(curl_exec($ch), true);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), " ", $message["id"], " ", $message["status"], "\n";// Go 1.20 or newer, standard library only
package main
import (
"bytes"
"encoding/json"
"fmt"
"net/http"
"os"
)
func main() {
body, _ := json.Marshal(map[string]any{
"to": "+14155550123",
"text": "Your Northwind code is 482913. It expires in 10 minutes.",
"reference": "login-7781",
})
req, _ := http.NewRequest("POST", "https://bulksmsapi.cc/v1/messages", bytes.NewReader(body))
req.Header.Set("Authorization", "Bearer "+os.Getenv("BULKSMSAPI_KEY"))
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
var message map[string]any
json.NewDecoder(res.Body).Decode(&message)
fmt.Println(res.StatusCode, message["id"], message["status"], message["price"])
}{
"id": "msg_8F3K2Q9TZ1MX",
"object": "message",
"batch_id": "bat_4M7Q1X0PK2RS",
"to": "+14155550123",
"country": "US",
"text": "Your Northwind code is 482913. It expires in 10 minutes.",
"segments": 1,
"price": "0.00507",
"currency": "USD",
"status": "queued",
"error": null,
"reference": "login-7781",
"created_at": "2026-11-07T09:30:12.418Z",
"sent_at": null,
"done_at": null
}ออบเจ็กต์ข้อความ
ฟิลด์
- idstring
รหัสข้อความ ขึ้นต้นด้วย msg_ ตามด้วยอักษร 12 ตัว
- objectstring
เป็น message เสมอ
- batch_idstring
batch ที่ข้อความนี้เป็นส่วนหนึ่ง (ข้อความเดียวก็จะได้รับ batch เช่นกัน)
- tostring
หมายเลขในรูปแบบ E.164 หลังทำความสะอาด
- countrystring
รหัส ISO 3166 ของประเทศที่กำหนดราคาหมายเลข
- textstring
ข้อความที่ส่งออก merge fields ถูกเติมแล้ว
- segmentsinteger
จำนวน segments ของ SMS ที่ข้อความใช้
- pricestring
ราคาข้อความนี้ใน USD ทศนิยม 5 ตำแหน่ง (ราคาต่อ segment คูณด้วยจำนวน segments)
- currencystring
เป็น USD เสมอ
- statusstring
scheduled, queued, sent, delivered, failed หรือ canceled
- errorobject or null
สำหรับข้อความที่ failed หรือ canceled: รหัสและข้อความ
- referencestring or null
รหัสอ้างอิงของคุณจากคำขอ
- created_atstring
เวลาที่คำขอได้รับการยอมรับ (ISO 8601, UTC)
- sent_atstring or null
เวลาที่ข้อความถูกส่งให้เครือข่าย
- done_atstring or null
เวลาที่ตั้งสถานะสุดท้าย (delivered, failed หรือ canceled)
ดึงข้อมูลข้อความ
/v1/messages/{id}ข้อความหนึ่งรายการตามรหัส msg_ ข้อความของบัญชีอื่นจะตอบกลับด้วย 404
curl https://bulksmsapi.cc/v1/messages/msg_8F3K2Q9TZ1MX \
-H "Authorization: Bearer $BULKSMSAPI_KEY"const res = await fetch("https://bulksmsapi.cc/v1/messages/msg_8F3K2Q9TZ1MX", {
headers: { Authorization: `Bearer ${process.env.BULKSMSAPI_KEY}` },
});
const message = await res.json();
console.log(message.status, message.error);import json, os, urllib.request
req = urllib.request.Request(
"https://bulksmsapi.cc/v1/messages/msg_8F3K2Q9TZ1MX",
headers={"Authorization": "Bearer " + os.environ["BULKSMSAPI_KEY"], "User-Agent": "northwind-app/1.0"},
)
with urllib.request.urlopen(req) as res:
message = json.load(res)
print(message["status"], message["error"])<?php
$ch = curl_init("https://bulksmsapi.cc/v1/messages/msg_8F3K2Q9TZ1MX");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ["Authorization: Bearer " . getenv("BULKSMSAPI_KEY")],
]);
$message = json_decode(curl_exec($ch), true);
echo $message["status"], "\n";package main
import (
"encoding/json"
"fmt"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://bulksmsapi.cc/v1/messages/msg_8F3K2Q9TZ1MX", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("BULKSMSAPI_KEY"))
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
var message map[string]any
json.NewDecoder(res.Body).Decode(&message)
fmt.Println(message["status"], message["error"])
}แสดงรายการข้อความ
/v1/messagesข้อความของบัญชี เรียงจากใหม่ที่สุด
พารามิเตอร์การค้นหา
- batch_idstringไม่จำเป็น
เฉพาะข้อความของแบทช์ bat_ นี้
- statusstringไม่จำเป็น
scheduled, queued, sent, delivered, failed หรือ canceled
- limitintegerไม่จำเป็น
1 ถึง 100 ค่าเริ่มต้น 20
- starting_afterstringไม่จำเป็น
msg_ id: หน้าเริ่มต้นหลังจากนี้ ใช้ id สุดท้ายของหน้าก่อนหน้า
curl "https://bulksmsapi.cc/v1/messages?status=failed&limit=50" \
-H "Authorization: Bearer $BULKSMSAPI_KEY"{
"object": "list",
"data": [ { "id": "msg_8F3K2Q9TZ1MX", "object": "message", "status": "failed", "...": "..." } ],
"has_more": false
}