Dev DOC - SMSMobileAPI

Tài liệu dành cho nhà phát triển SMSmobileAPI Bạn chỉ có thể gửi tin nhắn WhatsApp thông qua API của chúng tôi. Nhấp vào đây để tìm hiểu thêm.

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.
Cho dù bạn đang sử dụng REST, SOAP, cURL hay nhiều ngôn ngữ lập trình khác như Python, JavaScript, PHP, v.v., API của chúng tôi đều đượ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.

Nếu bạn có bất kỳ câu hỏi, đề xuất hoặc cần hỗ trợ, nhóm của chúng tôi luôn sẵn sàng trợ giúp.
Hãy thoải mái liên hệ với chúng tôi tại api@smsmobileapi.com

.

API NHỚ LẠI

cURL

Composer

JavaScript

Trăn

Node.js

Hồng ngọc

WSDL

Gửi SMS & API WhatsApp

Đ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.

LẤY BƯU KIỆN https://api.smsmobileapi.com/sendsms?apikey=YOUR_API_KEY&recipients=PHONE_NUMBER&message=MESSAGE_TO_SEND

Các thông số:

- apikey: Khóa API duy nhất của bạn.

- recipients: Số điện thoại của người nhận.

- message: Tin nhắn muốn gửi (Độ dài tin nhắn không giới hạn ở 160 ký tự; bạn có thể gửi tin nhắn dài hơn)

- sendwa: 1 = tin nhắn phải được gửi qua WhatsApp.

- sendsms: 1 = tin nhắn phải được gửi qua tin nhắn SMS truyền thống. (Nếu gửi tin nhắn trống: được gửi theo mặc định, đặt thành 0 để chặn SMS)

- schedule_timestamp = Biểu thị thời gian mà tin nhắn SMS sẽ được gửi đi - Phải là **dấu thời gian UNIX (GMT 0)**

Ví dụ:


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

Lưu ý: Trong trường hợp lỗi gửi tin nhắn do nhà cung cấp dịch vụ, chức năng mặc định sẽ thử gửi lại cùng một tin nhắn SMS tối đa 3 lần trong một khoảng thời gian xác định.

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 để gửi SMS

Phương pháp này yêu cầu Khóa API có thể được đưa vào làm tham số trong yêu cầu GET hoặc POST. Đây là cách đơn giản để xác thực yêu cầu API của bạn.

2. Xác thực OAuth2 để gửi SMS

OAuth2 cung cấp phương pháp xác thực an toàn và có khả năng mở rộng hơn.
Bạn sẽ cần sử dụng ID khách hàng và bí mật khách hàng để có được mã thông báo truy cập, sau đó sẽ được đưa vào yêu cầu API của bạn bằng cách sử dụng Ủy quyền tiêu đề.

client_id và client_secret có sẵn trong bảng điều khiển của bạn, có thể truy cập sau khi cài đặt ứng dụng và tạo tài khoản trên thiết bị di động.
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

Để lấy mã thông báo truy cập, hãy gửi yêu cầu POST đến điểm cuối mã thông báo với ID máy khách và bí mật máy khách của bạn.


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=1ab0ex4b4c1ef2c800690d" \

-d "client_secret=3ed108a93d0414074b94364290b6a7348475e93a0567005"

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

Khi bạn đã có mã thông báo truy cập, hãy đưa nó vào Ủy quyền tiêu đề yêu cầu API của bạn:


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

-H "Ủy quyền: Người mang abc123xyz456" \

-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 trong tích hợp của bạn.

Để biết thêm chi tiết, vui lòng tham khảo tài liệu đầy đủ.

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 gửi (chỉ khi tin nhắn có trạng thái lỗi)

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

Tham số:

- guid: (bắt buộc) GUID của tin nhắn cần gửi lại.

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.

LẤY https://api.smsmobileapi.com/log/sent/sms?apikey=YOUR_API_KEY

Tham số:

- apikey: (bắt buộc) Khóa API của bạn.

- guid_message: được viết tắt bằng mã định danh duy nhất cho tin nhắn được sử dụng để sắp xếp và lọc.

- before: Truy xuất các tin nhắn được gửi trước dấu thời gian hoặc GUID cụ thể này.

- error_api: Nhập `1` (`&error_api=1`) để liệt kê tất cả tin nhắn SMS gặp lỗi trong quá trình yêu cầu API.

- error_mobile: Nhập `1` (`&error_mobile=1`) để liệt kê tất cả tin nhắn SMS gặp lỗi trong quá trình xử lý trên thiết bị di động.

- keyword: Từ khóa để lọc tin nhắn dựa trên số điện thoại người nhận hoặc nội dung tin nhắn SMS.

Nhận tin nhắn SMS nhận được trên API di động

Đ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.

LẤY https://api.smsmobileapi.com/getsms/?apikey=YOUR_API_KEY

Tham số:

- apikey: Khóa API bạn có hoặc sẽ nhận được.

Xóa SMS API

Đ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 SMS Mobile API

LẤY https://api.smsmobileapi.com/deletesms/?apikey=YOUR_API_KEY

Tham số:

- apikey: 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.

Lưu ý: Tin nhắn SMS đã xóa chỉ là những tin nhắn được lưu trữ trong nhật ký của tài khoản ứng dụng di động của bạn. Tin nhắn SMS trên chính thiết bị di động sẽ không bị xóa vì chúng tôi không có quyền truy cập vào chúng.

.

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:

{

    "ngày": "2025-01-20",

    "giờ": "10:15:00",

    "time_received": "2025-01-20 10:14:50",

    "message": "Xin chào, đây là bài kiểm tra.",

    "số": "+123456789",

    "hướng dẫn": "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:

<?php

// Đọc tải trọng đến

$payload = file_get_contents('php://đầu vào');

$data = json_decode($payload, đúng);




// Xử lý dữ liệu SMS

nếu ($data) {

    // Ví dụ: Ghi dữ liệu SMS vào một tệp

    file_put_contents('sms_log.txt', print_r($data, đúng), FILE_APPEND);




    // Phản hồi với trạng thái HTTP 200

    http_response_code(200);

    echo "Webhook đã được nhận thành công.";

} khác {

    // Phản hồi với trạng thái HTTP 400 cho các yêu cầu không hợp lệ

    http_response_code(400);


    echo "Tải trọng không hợp lệ.";

}

?>

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ư:

Các công cụ này cho phép bạn kiểm tra dữ liệu được hệ thống gửi đi và gỡ lỗi mọi sự cố liên quan đến thiết lập webhook của bạn.

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.

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. (Độ dài tin nhắn không giới hạn ở 160 ký tự; bạn có thể gửi tin nhắn dài hơn)

- 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

Bạn có thể sử dụng lệnh cURL sau để gửi tin nhắn SMS qua SMSmobileAPI:


        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"

Ví dụ cURL trong PHP

Nếu bạn đang sử dụng PHP, đây là cách bạn có thể gửi tin nhắn SMS bằng cURL:


        <?php

        

        $url = 'https://api.smsmobileapi.com/sendsms/';

        $data = array(

            'recipients' => 'PHONE_NUMBER',

            'message' => 'YOUR_MESSAGE',

            'apikey' => 'YOUR_API_KEY'

		    'sendwa' => '1'

		    'sendsms' => '1'

        );

        

        $options = array(

            CURLOPT_URL => $url,

            CURLOPT_POST => true,

            CURLOPT_POSTFIELDS => http_build_query($data),

            CURLOPT_RETURNTRANSFER => true,

        );

        

        $ch = curl_init();

        curl_setopt_array($ch, $options);

        $response = curl_exec($ch);

        curl_close($ch);

        

        echo $response;

        

        ?>

Ví dụ PHP này trình bày cách gửi yêu cầu POST bằng cURL đến SMSmobileAPI, truyền các tham số cần thiết dưới dạng một mảng liên kết.

Gửi tin nhắn SMS & WhatsApp

Sử dụng Mô-đun Python chính thức của chúng tôi: https://smsmobileapi.com/python/
hoặc sử dụng cách thủ công ...

Sử dụng thư viện `requests`

Thư viện `requests` là một thư viện HTTP phổ biến và đơn giản cho Python. Sau đây là cách bạn có thể sử dụng nó để gửi SMS qua SMSmobileAPI:


        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)

Ví dụ này trình bày một yêu cầu POST đơn giản tới SMSmobileAPI, gửi tin nhắn đến một số điện thoại cụ thể.

Sử dụng thư viện `http.client`

Thư viện `http.client` được bao gồm trong thư viện chuẩn của Python và cũng có thể được sử dụng để tương tác với API của bạn:


        import http.client

        import urllib.parse



        conn = http.client.HTTPSConnection("api.smsmobileapi.com")



        params = urllib.parse.urlencode({

            "recipients": "PHONE_NUMBER",

            "message": "YOUR_MESSAGE",

            "apikey": "YOUR_API_KEY"

        })



        headers = { "Content-type": "application/x-www-form-urlencoded" }



        conn.request("POST", "/sendsms/", params, headers)

        response = conn.getresponse()

        data = response.read()



        print(data.decode("utf-8"))

        conn.close()

Ví dụ này cho thấy cách sử dụng thư viện `http.client` để gửi yêu cầu POST đến API. Các tham số được mã hóa URL và được gửi với tiêu đề phù hợp.

SMS Mobile API - PHP SDK (Composer)

SDK PHP của SMS Mobile API có sẵn thông qua Composer, giúp bạn dễ dàng tích hợp chức năng gửi SMS vào các ứng dụng PHP của mình.


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

Để biết tài liệu chi tiết, hướng dẫn cài đặt và ví dụ sử dụng, hãy truy cập kho lưu trữ GitHub của chúng tôi:

🔗 SMS Mobile API PHP SDK trên GitHub: https://github.com/SmsMobileApi/smsmobileapi-php/tree/main

Trên GitHub, bạn sẽ tìm thấy:
✔️ Hướng dẫn cài đặt đầy đủ
✔️ Ví dụ sử dụng
✔️ Tài liệu tham khảo API và các biện pháp thực hành tốt nhất

Bạn cần trợ giúp? Hãy thoải mái mở một vấn đề trên GitHub! 🎯

Gửi tin nhắn SMS & WhatsApp

Sử dụng API `fetch`

API `fetch` là một cách hiện đại và linh hoạt để thực hiện các yêu cầu HTTP trong JavaScript. Sau đây là cách bạn có thể sử dụng nó để gửi SMS qua SMSmobileAPI:


        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(response => response.text())

        .then(result => console.log(result))

        .catch(error => console.error("Error:", error));

Ví dụ này trình bày cách gửi yêu cầu POST bằng API `fetch`, được hỗ trợ trong hầu hết các trình duyệt hiện đại.

Sử dụng `XMLHttpRequest`

Nếu bạn cần hỗ trợ các trình duyệt cũ hơn, bạn có thể sử dụng đối tượng `XMLHttpRequest`:


        const xhr = new XMLHttpRequest();

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



        const data = "recipients=PHONE_NUMBER&message=YOUR_MESSAGE&apikey=YOUR_API_KEY";



        xhr.open("POST", url, true);

        xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");



        xhr.onreadystatechange = function() {

            if (xhr.readyState === 4 && xhr.status === 200) {

                console.log(xhr.responseText);

            }

        };



        xhr.send(data);

Ví dụ này cho thấy cách sử dụng `XMLHttpRequest` để gửi yêu cầu POST, đảm bảo khả năng tương thích với các trình duyệt cũ hơn có thể không hỗ trợ `fetch`.

Gửi tin nhắn SMS & WhatsApp

Sử dụng thư viện `axios`

Thư viện `axios` là một HTTP client phổ biến cho Node.js. Sau đây là cách bạn có thể sử dụng nó để gửi SMS qua SMSmobileAPI:


        const axios = require('axios');



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

        const data = {

            recipients: 'PHONE_NUMBER',

            message: 'YOUR_MESSAGE',

            apikey: 'YOUR_API_KEY'

        };



        axios.post(url, data)

        .then(response => {

            console.log(response.data);

        })

        .catch(error => {

            console.error('Error:', error);

        });

Ví dụ này trình bày cách gửi yêu cầu POST bằng `axios` trong Node.js để tương tác với SMSmobileAPI.

Gửi tin nhắn SMS & WhatsApp

Sử dụng thư viện `Net::HTTP`

Bạn có thể sử dụng thư viện `Net::HTTP` trong Ruby để gửi tin nhắn SMS qua SMSmobileAPI:


        require 'net/http'

        require 'uri'



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

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

        request.set_form_data(

            "recipients" => "PHONE_NUMBER",

            "message" => "YOUR_MESSAGE",

            "apikey" => "YOUR_API_KEY"

        )



        req_options = {

            use_ssl: uri.scheme == "https",

        }



        response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|

            http.request(request)

        end



        puts response.body

Ví dụ này trình bày cách gửi yêu cầu POST bằng `Net::HTTP` trong Ruby đến SMSmobileAPI.

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