Tài liệu SMS

Tại SMSmobileAPI, chúng tôi nỗ lực làm cho API của mình tương thích nhất có thể với mọi kiến trúc hoặc nền tảng.
Dù bạn đang sử dụng REST, SOAP, cURL hay các ngôn ngữ lập trình khác nhau như Python, JavaScript, PHP, v.v., API của chúng tôi được thiết kế để tích hợp liền mạch vào các dự án của bạn.

Chúng tôi cũng có các plugin sẵn sàng sử dụng cho các giải pháp và phần mềm thương mại điện tử.
Nhấp vào đây để khám phá chúng.

Bạn cần trợ giúp? api@smsmobileapi.com

Tìm kiếm

Gửi tin nhắn SMS

Điểm cuối này cho phép bạn gửi tin nhắn SMS từ điện thoại di động của mình.

Điểm cuối:

LẤY BƯU KIỆN https://api.smsmobileapi.com/sendsms/

Các thông số:

Tham số	Sự miêu tả
apikey	Yêu cầu Khóa API duy nhất của bạn.
recipients	Yêu cầu Số điện thoại của người nhận.
message	Yêu cầu Tin nhắn cần gửi (không giới hạn 160 ký tự).
port	Xác định cổng SIM cần sử dụng để gửi tin nhắn SMS: 1, 2hoặc để trống. Nếu để trống, tin nhắn SMS sẽ tự động được gửi bằng cổng SIM hiện có. Tham số này có sẵn từ phiên bản Android trở lên. 4.1.15.0 và hoạt động khi ứng dụng đang ở chế độ tiền cảnh (Kế hoạch đầu tiên).
shorturl	1 = chuyển đổi URL thành liên kết rút gọn 0 hoặc trống = không chuyển đổi
sIdentifiant	Chọn điện thoại nào sẽ gửi tin nhắn SMS. Để trống nếu chọn thiết bị đầu tiên có sẵn. Yêu cầu ứng dụng phiên bản 3.0.35.3 trở lên.
sendwa	1 = gửi qua WhatsApp.
sendsms	1 = gửi qua SMS (mặc định nếu để trống). Đặt thành 0 để chặn SMS.
encrypt_message	Đúng Người nhận cần một khóa để giải mã. Tìm hiểu thêm
schedule_timestamp	Dấu thời gian UNIX (GMT 0) mà từ đó tin nhắn SMS nên được gửi đi.

Ví dụ:

GET https://api.smsmobileapi.com/sendsms?apikey=YOUR_API_KEY&recipients=+1234567890&message=HelloWorld

Lưu ý: trong trường hợp lỗi giao hàng do người vận hành của bạn gây ra, chức năng mặc định sẽ thử lại tối đa 3 lần.

Gửi lại tin nhắn SMS chưa gửi

Điểm cuối API này được sử dụng để gửi lại tin nhắn SMS chưa được gửi (chỉ khi tin nhắn có trạng thái lỗi).

Điểm cuối:

LẤY BƯU KIỆN https://api.smsmobileapi.com/resend/

Tham số:

Tham số	Sự miêu tả
guid	Yêu cầu GUID của tin nhắn cần gửi lại.

Ví dụ:

NHẬN https://api.smsmobileapi.com/resend/?apikey=YOUR_API_KEY&guid=GUID_OF_THE_MESSAGE

Nhật ký tin nhắn SMS được gửi từ API

Điểm cuối API này được sử dụng để truy xuất nhật ký tin nhắn SMS được gửi qua API.

Điểm cuối:

LẤY https://api.smsmobileapi.com/log/sent/sms/

Tham số:

Tham số	Sự miêu tả
apikey	Yêu cầu Khóa API của bạn.
guid_message	Lọc theo mã định danh duy nhất của tin nhắn.
before	Truy xuất các tin nhắn được gửi trước mốc thời gian hoặc GUID này.
error_api	1 = Liệt kê tin nhắn SMS có lỗi yêu cầu API.
error_mobile	1 = Liệt kê tin nhắn SMS có lỗi xử lý trên thiết bị di động.
keyword	Lọc theo số điện thoại người nhận hoặc nội dung tin nhắn.

Ví dụ:

NHẬN https://api.smsmobileapi.com/log/sent/sms?apikey=YOUR_API_KEY

Đã nhận được tin nhắn SMS

Điểm cuối API này được sử dụng để truy xuất tin nhắn SMS nhận được trên điện thoại thông minh.

Điểm cuối:

LẤY https://api.smsmobileapi.com/getsms/

Tham số:

Tham số	Sự miêu tả
apikey	Yêu cầu Khóa API bạn có hoặc sẽ nhận được.
sIdentifiantPhone	Xác định điện thoại nào được liên kết với tin nhắn SMS đã nhận.
after_timestamp_unix	Liệt kê các tin nhắn SMS đã nhận được sau một mốc thời gian UNIX.
onlyunread	"yes" = chỉ liệt kê các tin nhắn SMS chưa được đánh dấu là đã đọc (trạng thái API).

Ví dụ:

NHẬN https://api.smsmobileapi.com/getsms/?apikey=YOUR_API_KEY

Đánh dấu tin nhắn SMS đã nhận là đã đọc

Điểm cuối API này được sử dụng để đánh dấu một tin nhắn SMS đã nhận là đã đọc trong hệ thống. Chỉ trạng thái API.
Việc này không làm thay đổi trạng thái đã đọc trên điện thoại thông minh.

Điểm cuối:

LẤY https://api.smsmobileapi.com/getsms/set-read/

Tham số:

Tham số	Sự miêu tả
apikey	Yêu cầu Khóa API bạn có hoặc sẽ nhận được.
guid_message	Yêu cầu GUID của tin nhắn cần đánh dấu là đã đọc.

Ví dụ:

NHẬN https://api.smsmobileapi.com/getsms/set-read/?apikey=YOUR_APIKEY&guid_message=GUID_MESSAGE

Xóa tin nhắn SMS

Điểm cuối API này được sử dụng để xóa tin nhắn SMS khỏi nhật ký máy chủ của API SMS Mobile.

Điểm cuối:

LẤY https://api.smsmobileapi.com/deletesms/

Tham số:

Tham số	Sự miêu tả
apikey	Yêu cầu Khóa API bạn có.
guid_message	ID duy nhất của tin nhắn cần xóa.
date_start	Nếu sử dụng riêng lẻ, sẽ xóa tất cả tin nhắn từ ngày đã chỉ định.
date_start and date_end	Kết hợp để xóa tin nhắn trong khoảng thời gian chỉ định.

Ví dụ:

NHẬN https://api.smsmobileapi.com/deletesms/?apikey=YOUR_API_KEY

Lưu ý: Tin nhắn SMS đã xóa chỉ bao gồm những tin nhắn được lưu trữ trong nhật ký máy chủ. Tin nhắn SMS trên thiết bị sẽ không bị xóa.

Cổng kết nối – Liệt kê các thiết bị di động đã kết nối

Liệt kê các thiết bị di động được kết nối với bạn. Cổng tin nhắn SMS.

Điểm cuối:

LẤY BƯU KIỆN https://api.smsmobileapi.com/gateway/mobile/list/

Các thông số:

Tham số	Sự miêu tả
apikey	Yêu cầu Khóa API của bạn.
sid	Lọc theo SID chính xác (sIdentifiant_pour_check).
search	Tìm kiếm theo các trường (sid, ngày, pin, phiên bản, nhãn...).

Ví dụ:

GET https://api.smsmobileapi.com/gateway/mobile/list/?apikey=YOUR_API_KEY

Lưu ý: Thống kê tin nhắn SMS đã nhận có sẵn từ phiên bản 3.0.33.3 trở lên của ứng dụng di động.

Cổng – Cập nhật nhãn di động

Cập nhật nhãn (nom_reference) của thiết bị di động đã kết nối.

Điểm cuối:

LẤY BƯU KIỆN https://api.smsmobileapi.com/gateway/mobile/update/

Các thông số:

Tham số	Sự miêu tả
apikey	Yêu cầu Khóa API của bạn.
sid	Yêu cầu SID của thiết bị (sIdentifiant_pour_check).
label	Yêu cầu Nhãn mới (có thể để trống).

Ví dụ:

GET https://api.smsmobileapi.com/gateway/mobile/update/?apikey=YOUR_API_KEY&sid=SID&label=OfficePhone

Quan trọng: Nhãn là bắt buộc nhưng có thể để trống. (nhãn=).

Gateway – Xóa thiết bị di động đã kết nối

Xóa thiết bị di động đã kết nối khỏi cổng thanh toán của bạn (xóa tất cả các dòng lịch sử cho SID này).

Điểm cuối:

LẤY BƯU KIỆN https://api.smsmobileapi.com/gateway/mobile/delete/

Các thông số:

Tham số	Sự miêu tả
apikey	Yêu cầu Khóa API của bạn.
sid	Yêu cầu SID của thiết bị (sIdentifiant_pour_check).

Ví dụ:

GET https://api.smsmobileapi.com/gateway/mobile/delete/?apikey=YOUR_API_KEY&sid=SID

Webhook – Đã nhận tin nhắn SMS

Hệ thống webhook này gửi yêu cầu POST đến URL được cấu hình bất cứ khi nào nhận được tin nhắn SMS. Hệ thống đảm bảo cập nhật theo thời gian thực bằng cách gửi thông tin chi tiết về tin nhắn SMS đến URL webhook đã chỉ định.

Cách cấu hình Webhook trong Bảng điều khiển

Thực hiện theo các bước sau để thiết lập URL webhook của bạn trong bảng điều khiển:

Đăng nhập vào tài khoản của bạn trên Bảng điều khiển API di động SMS.
Điều hướng đến Cài đặt Webhook phần.
Nhập URL webhook của bạn (ví dụ: https://example.com/webhook-endpoint).
Nhấp vào Lưu Webhook cái nút.
Sau khi lưu, hệ thống sẽ bắt đầu gửi thông tin chi tiết về SMS đến URL đã cấu hình.

Tải trọng Webhook

Khi nhận được tin nhắn SMS, hệ thống sẽ gửi nội dung JSON sau đến URL webhook của bạn:

{ "date": "2025-01-20", "hour": "10:15:00", "time_received": "2025-01-20 10:14:50", "message": "Xin chào, đây là một bài kiểm tra.", "number": "+123456789", "guid": "abcde12345" }

Trường tải trọng:

ngày: Ngày thêm tin nhắn SMS (YYYY-MM-DD).
giờ: Giờ tin nhắn SMS được thêm vào (HH:mm:ss).
thời gian nhận được: Thời gian nhận được tin nhắn SMS.
tin nhắn: Nội dung của tin nhắn SMS.
con số: Số điện thoại của người gửi.
hướng dẫn: Mã định danh duy nhất của tin nhắn SMS.

Ví dụ về điểm cuối Webhook

Máy chủ của bạn phải sẵn sàng xử lý các yêu cầu POST đến. Dưới đây là một ví dụ về tập lệnh PHP để xử lý tải trọng webhook:

Kiểm tra Webhook

Để kiểm tra cấu hình webhook của bạn, hãy sử dụng các công cụ như:

Xử lý sự cố

Đảm bảo URL webhook là chính xác và có thể truy cập công khai.
Xác minh rằng máy chủ của bạn đang trả về mã trạng thái HTTP 200 cho các yêu cầu thành công.
Kiểm tra nhật ký máy chủ của bạn để xem có lỗi nào trong quá trình xử lý tải trọng không.

SMS được làm giàu

Sắp ra mắt

Xác thực

API SMSMobile hỗ trợ hai phương pháp xác thực: sử dụng Khóa API đơn giản hoặc giao thức OAuth2 với ID máy khách và bí mật máy khách.

1. Xác thực khóa API

Phương pháp này yêu cầu một Khóa API, có thể được đưa vào làm tham số trong yêu cầu GET hoặc POST.

2. Xác thực OAuth2

OAuth2 cung cấp phương thức xác thực an toàn hơn.
Sử dụng ID khách hàng và mã bí mật khách hàng để lấy mã truy cập, sau đó đưa chúng vào Ủy quyền tiêu đề.

client_id và client_secret có sẵn trong bảng điều khiển của bạn.
Tải xuống ứng dụng di động ngay bây giờ hoặc truy cập bảng điều khiển của bạn.

Nhận mã thông báo truy cập


curl -X POST https://api.smsmobileapi.com/oauth2/token \

-H "Content-Type: application/x-www-form-urlencoded" \

-d "grant_type=client_credentials" \

-d "client_id=YOUR_CLIENT_ID" \

-d "client_secret=YOUR_CLIENT_SECRET"

Sử dụng Mã thông báo truy cập:


curl -X POST https://api.smsmobileapi.com/sendsms \

-H "Xác thực: Người mang YOUR_ACCESS_TOKEN" \

-H "Loại nội dung: application/x-www-form-urlencoded" \

-d "người nhận=+1234567890" \

-d "message=Xin chào"

Bạn nên sử dụng phương pháp nào?

- Sử dụng Xác thực khóa API để tích hợp nhanh chóng và dễ dàng.

- Sử dụng Xác thực OAuth2 để tăng cường bảo mật và khả năng mở rộng.

Gửi tin nhắn SMS

URL WSDL

https://api.smsmobileapi.com/sendsms/wsdl/sendsms.wsdl

Các thông số:

- recipients: Số điện thoại di động của người nhận.
- message: Tin nhắn cần gửi.
- apikey: Khóa API bạn có hoặc sẽ nhận được.

Ví dụ


require_once "lib/nusoap.php";


$client = new nusoap_client("https://api.smsmobileapi.com/sendsms/wsdl/sendsms.wsdl", true);

$error  = $client->getError();


$result = $client->call("sendSms", array("recipients" =>$_GET['recipients'],"message" =>$_GET['message'],"apikey" =>$_GET['apikey']));


print_r($result);

Gửi tin nhắn SMS & WhatsApp

Lệnh cURL cơ bản


curl -X POST https://api.smsmobileapi.com/sendsms/ \

-d "recipients=PHONE_NUMBER" \

-d "message=YOUR_MESSAGE" \

-d "apikey=YOUR_API_KEY" 

-d "sendwa=1"

-d "sendsms=1"

Gửi tin nhắn SMS & WhatsApp

Hãy sử dụng mô-đun Python chính thức của chúng tôi: https://smsmobileapi.com/python/


import requests


url = "https://api.smsmobileapi.com/sendsms/"


payload = {"recipients":"PHONE_NUMBER","message":"YOUR_MESSAGE","apikey":"YOUR_API_KEY"}


response = requests.post(url, data=payload)

print(response.text)

SMS Mobile API - PHP SDK (Composer)

nhà soạn nhạc yêu cầu smsmobileapi/sdk

GitHub: https://github.com/SmsMobileApi/smsmobileapi-php/tree/main

Gửi tin nhắn SMS & WhatsApp


const url = "https://api.smsmobileapi.com/sendsms/";

const data = {recipients:"PHONE_NUMBER", message:"YOUR_MESSAGE", apikey:"YOUR_API_KEY"};

fetch(url,{method:"POST",headers:{"Content-Type":"application/x-www-form-urlencoded"},body:new URLSearchParams(data)})

.then(r=>r.text()).then(console.log);

Gửi tin nhắn SMS & WhatsApp


const axios = require("axios");

axios.post("https://api.smsmobileapi.com/sendsms/", {recipients:"PHONE_NUMBER", message:"YOUR_MESSAGE", apikey:"YOUR_API_KEY"})

.then(r=>console.log(r.data));

Gửi tin nhắn SMS & WhatsApp


require "net/http"

require "uri"

uri = URI.parse("https://api.smsmobileapi.com/sendsms/")

req = Net::HTTP::Post.new(uri)

req.set_form_data({"recipients"=>"PHONE_NUMBER","message"=>"YOUR_MESSAGE","apikey"=>"YOUR_API_KEY"})

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true){|http| http.request(req)}

puts res.body

Nhấp vào đây để kiểm tra khóa API và dịch vụ bằng biểu mẫu đơn giản

Tùy thuộc vào phiên bản Android được cài đặt trên điện thoại di động, hệ điều hành có thể cản trở chức năng gửi và nhận tin nhắn SMS tự động khi ứng dụng SmsMobileApi không chạy ở chế độ nền.
Sự cố này phát sinh từ một tiến trình cố gắng chạy ở chế độ nền khi ứng dụng không được khởi chạy chủ động. Tuy nhiên, do các biện pháp tối ưu hóa pin của Android, thay đổi tùy theo các phiên bản khác nhau, tiến trình nền này có thể không khởi chạy đúng cách. Tối ưu hóa pin của Android được thiết kế để hạn chế hoạt động nền của các ứng dụng nhằm tiết kiệm pin, điều này có thể vô tình ảnh hưởng đến các ứng dụng yêu cầu các tiến trình nền hoạt động bình thường.

Để giải quyết vấn đề này, người dùng có thể cấu hình thủ công cài đặt Android của mình để cho phép SmsMobileApi sử dụng tài nguyên mà không bị hạn chế.
Điều này bao gồm việc điều chỉnh các thiết lập tối ưu hóa pin cho ứng dụng cụ thể, về cơ bản là hướng dẫn Android rằng SmsMobileApi được phép chạy ở chế độ nền và sử dụng tài nguyên khi cần. Bằng cách đó, ứng dụng sẽ có thể tự động gửi và nhận tin nhắn SMS ngay cả khi nó không phải là ứng dụng đang hoạt động ở chế độ nền trước. Việc điều chỉnh này đảm bảo rằng quy trình nền cần thiết có thể hoạt động không bị gián đoạn, tránh các tính năng tối ưu hóa pin có thể ngăn cản việc thực hiện đúng của nó.

Câu hỏi thường gặp dành cho nhà phát triển

Làm thế nào để tạo khóa API?

Accordion Sample DescriptionĐể tạo khóa API, hãy tải ứng dụng của chúng tôi xuống điện thoại di động của bạn và tạo tài khoản miễn phí. Khóa API sẽ được tự động tạo và liên kết với điện thoại di động của bạn. Bạn cũng sẽ nhận được email có tất cả thông tin cần thiết. Quy trình này đảm bảo rằng bạn có thể nhanh chóng và dễ dàng bắt đầu sử dụng dịch vụ của chúng tôi với thiết lập tối thiểu.

Tôi có thể tìm khóa API của mình ở đâu?

Trong ứng dụng di động của bạn, hãy điều hướng đến menu CÀI ĐẶT hoặc TRỢ GIÚP, nơi khóa API của bạn luôn hiển thị. Điều này đảm bảo rằng bạn có thể dễ dàng truy cập khóa API của mình bất cứ khi nào bạn cần để tích hợp hoặc sử dụng dịch vụ của chúng tôi.

Việc tạo khóa API có thể ẩn danh được không?

Có, chúng tôi không yêu cầu bất kỳ bằng chứng nhận dạng nào để tạo khóa API. Do đó, giao tiếp giữa API của chúng tôi và điện thoại di động của bạn là 100% ẩn danh. Phương pháp này cho phép người dùng duy trì quyền riêng tư của họ trong khi sử dụng dịch vụ của chúng tôi.

Bắt đầu với SMSmobileAPI ngay hôm nay!

Trải nghiệm sự tự do và linh hoạt khi quản lý dịch vụ SMS của bạn khi đang di chuyển. Tải xuống ứng dụng di động của chúng tôi ngay bây giờ và thực hiện bước đầu tiên hướng tới tích hợp SMS liền mạch.

Tải xuống ứng dụng

Tài liệu API & Nhà phát triển

Nhật ký công cụ và thay đổi

Gửi tin nhắn SMS

Điểm cuối:

Các thông số:

Ví dụ:

Gửi lại tin nhắn SMS chưa gửi

Điểm cuối:

Tham số:

Ví dụ:

Nhật ký tin nhắn SMS được gửi từ API

Điểm cuối:

Tham số:

Ví dụ:

Đã nhận được tin nhắn SMS

Điểm cuối:

Tham số:

Ví dụ:

Đánh dấu tin nhắn SMS đã nhận là đã đọc

Điểm cuối:

Tham số:

Ví dụ:

Xóa tin nhắn SMS

Điểm cuối:

Tham số:

Ví dụ:

Cổng kết nối – Liệt kê các thiết bị di động đã kết nối

Điểm cuối:

Các thông số:

Ví dụ:

Cổng – Cập nhật nhãn di động

Điểm cuối:

Các thông số:

Ví dụ:

Gateway – Xóa thiết bị di động đã kết nối

Điểm cuối:

Các thông số:

Ví dụ:

Webhook – Đã nhận tin nhắn SMS

Cách cấu hình Webhook trong Bảng điều khiển

Tải trọng Webhook

Trường tải trọng:

Ví dụ về điểm cuối Webhook

Kiểm tra Webhook

Xử lý sự cố

SMS được làm giàu

Xác thực

1. Xác thực khóa API

2. Xác thực OAuth2

Nhận mã thông báo truy cập

Sử dụng Mã thông báo truy cập:

Bạn nên sử dụng phương pháp nào?

Gửi tin nhắn SMS

URL WSDL

Các thông số:

Ví dụ

Gửi tin nhắn SMS & WhatsApp

Lệnh cURL cơ bản

Gửi tin nhắn SMS & WhatsApp

SMS Mobile API - PHP SDK (Composer)

Gửi tin nhắn SMS & WhatsApp

Gửi tin nhắn SMS & WhatsApp

Gửi tin nhắn SMS & WhatsApp

Câu hỏi thường gặp dành cho nhà phát triển

Làm thế nào để tạo khóa API?

Tôi có thể tìm khóa API của mình ở đâu?

Việc tạo khóa API có thể ẩn danh được không?

Bắt đầu với SMSmobileAPI ngay hôm nay!

💬 Có sẵn trò chuyện trực tiếp