Dev DOC - SMSMobileAPI

SMSmobileAPI Developer Documentation

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

JavaScript

Trăn

Node.js

Hồng ngọc

WSDL

Gửi SMS API

The SMSMobile API supports two authentication methods: using a simple API Key or the OAuth2 protocol with a client ID and client secret.

1. API Key Authentication for Send SMS

This method requires an API Key that can be included as a parameter in either a GET or POST request. It is a straightforward way to authenticate your API requests.

https://api.smsmobileapi.com/sendsms?apikey=YOUR_API_KEY&recipients=PHONE_NUMBER&message=MESSAGE_TO_SEND

Các thông số:

- apikey: Your unique API key.

- recipients: The recipient's phone number.

- message: The message to send.

Example:

GET https://api.smsmobileapi.com/sendsms?apikey=YOUR_API_KEY&recipients=+1234567890&message=Hello%20World

2. OAuth2 Authentication for Send SMS

OAuth2 provides a more secure and scalable authentication method.
You will need to use a client ID and client secret to obtain an access token, which should then be included in your API requests using the Authorization header.

The client_id and client_secret are available in your dashboard, accessible after installing the app and creating an account on your mobile device.
Download the mobile app now hoặc access your dashboard.

Obtaining an Access Token

To get an access token, send a POST request to the token endpoint with your client ID and client secret.

 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"

Using the Access Token:

Once you have the access token, include it in the Authorization header of your API requests:

 curl -X POST https://api.smsmobileapi.com/sendsms \
 -H "Authorization: Bearer abc123xyz456" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d "recipients=+1234567890" \
 -d "message=Hello"

Which Method Should You Use?

- Use API Key Authentication for quick and straightforward integrations.

- Use OAuth2 Authentication for enhanced security and scalability in your integrations.

For more details, please refer to the full documentation.

Nhận API 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.

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

Tham số:

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

- tin nhắn: Tin nhắn cần gửi.

- 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

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, sẽ xóa tất cả tin nhắn từ ngày đã chỉ định.

- date_start và 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.

Gửi tin nhắn SMS

URL WSDL

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

Các thông số:

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

- tin nhắn: 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

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"

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'
 );
 
 $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

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.

Gửi tin nhắn SMS

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

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

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