مقدمه

API Endpoint

BASE_URL = 'https://api.logisticsms.ir'
                     

این سند چگونگی استفاده از API های لجستیک پیامک را شرح می دهد. برای استفاده از پروتکل Https استفاده نمایید. همچنین خروجی API ها به فرمت جیسون می باشد.

شناسایی و اعتبار سنجی درخواست ها از طریق دریافت توکن (با استفاده از api لاگین) در Header درخواست با کلید X-API-TOKEN انجام می گیرد.

BASE_URL = 'https://api.logisticsms.ir'

دریافت توکن (لاگین)

                
import requests

# Base URL for the Logestic SMS API
logestic_url = 'https://api.logisticsms.ir'

# Define the login URL
url = f"{logestic_url}/api/v1/login"

# Payload with username and password
# Replace 'your-username' and 'your-password' with actual credentials
payload = {
    'username': 'your-username',  # API username
    'password': 'your-password'   # API password
}

# Make the POST request to log in
response = requests.post(url, data=payload)

# Print the status code of the response
print(response.status_code)

# Print the JSON response from the server
print(response.json())
                    
                
            

از این api برای دریافت توکن و لاگین استفاده می شود. این اطلاعات شامل توکن و زمان انقضای توکن می باشد.

ساختار URL :

پارامتر های ورودی

ارسال پیامک ساده

            
import requests

# Base URL for the Logestic SMS API
logestic_url = 'https://api.logisticsms.ir'

# Token obtained from a successful login
token = 'your-token'  # Replace with the actual token obtained from login

# Define the URL for sending an SMS
url = f"{logestic_url}/api/v1/sms/send"

# Payload with receptor, message, and sender details
# Replace 'your-receptor-number', 'Your message here', and 'your-sender-id' with actual values
payload = {
    'receptor': 'your-receptor-number',  # The phone number of the message recipient
    'message': 'Your message here',      # The message content
    'sender': 'your-sender-id'           # The sender ID
}

# Headers with the token for authentication
headers = {
    'X-API-TOKEN': token
}

# Make the POST request to send the SMS
response = requests.post(url, headers=headers, data=payload)

# Print the status code of the response
print(response.status_code)

# Print the JSON response from the server
print(response.json())
            
            

از این api جهت ارسال پیامک به یک گیرنده استفاده می شود.

ساختار URL:

پارامتر های ورودی

پارامتر های خروجی

ارسال پیامک گروهی

از این api جهت ارسال یک پیامک به چند گیرنده استفاده می شود.

ساختار URL:

پارامتر های ورودی

پارامتر های خروجی

ارسال پیامک گروهی نظیر به نظیر:

از این api جهت ارسال چند پیامک به چند گیرنده استفاده می شود.

ساختار URL

پارامتر های ورودی

پارامتر های خروجی

رهگیری وضعیت پیامک:

از این api جهت دریافت وضعیت پیامک استفاده می شود.

ساختار URL

پارامتر های ورودی

پارامتر های خروجی

رهگیری وضعیت اکانت کاربری:

از این api جهت دریافت وضعیت اکانت کاربری استفاده می شود.

ساختار URL

پارامتر های خروجی

لیست پیامک‌های دریافت‌شده:

از این API جهت دریافت لیست پیامک‌های دریافت‌شده استفاده می‌شود.

ساختار URL

پارامترهای ورودی

پارامترهای خروجی

دانلود نمونه پایتون

نمونه کد پایتون را می توانید از لینک زیر دانلود کنید :
دانلود

تماس با ما

                Info[@]logisticsms.ir
                www.logisticsms.ir
             

در صورتی که با مستندات فوق قادر به اتصال نبودید با ما تماس بگیرید :

+21 916 914 81
+98 916 953 8695

www.logisticsms.ir