وب سرویس ارسال و دریافت پیامک

گزارش پیام های دریافتی اخیر

نام متد : messages/received/recent

از این متد جهت دریافت پیام های دریافتی اخیر استفاده می شود، با هر بار فراخوانی این متد حداکثر به تعداد 100 عدد از پیام های ورودی بازگشت داده میشود.

آدرس فراخوانی متد : https://api.smsafzar.ir/messages/received/recent

روش فراخوانی متد با Http : GET

پارامتر :

count

تعداد پیام دریافت شده درخواستی (مقدار این پارامتر می بایست عددی در بازه 1 الی 100 باشد.)

نحوه ی فراخوانی متد با پارامتر count (تعداد پیام دریافت شده درخواستی) در قالب Query String به صورت ذیل می باشد :

https://api.smsafzar.ir/messages/received/recent?count=100

خروجی :

کد های وضعیت که در پاسخ Http توسط این متد بازگشت داده می شوند عبارتند از :

400

درخواست ارسالی صحیح نمی باشد. مقدار پارامتر errorCode در خروجی، برابر با کد خطا و مقدار پارامتر errorMessage شرح خطای مربوطه می باشد.

نمونه خروجی :

{
  "errorCode": 1001,
  "errorMessage": "مقادیر پارامترهای ارسالی معتبر نمی باشند.",
  "validationErrors": [
    {
      "field": "count",
      "errorMessage": "فیلد [ تعداد ] می بایست یک عدد در بازه ی 1 الی 100 باشد."
    }
  ]
}

401

خطای اهراز هویت رخ داده است. (Api Key یا توکن ارسالی معتبر نمی باشد.) (مقدار پارامتر errorCode در خروجی، برابر با عدد ۴۰۱ و مقدار پارامتر errorMessage شرح خطای مربوطه می باشد.)

نمونه خروجی :

{
  "errorCode": 401,
  "errorMessage": ".خطای احراز هویت رخ داده است"
}

403

مجوز دسترسی به متد برای حساب کاربری تعریف نشده است. (مقدار پارامتر errorCode در خروجی، برابر با عدد ۱۰۰۵ و مقدار پارامتر errorMessage شرح خطای مربوطه می باشد.)

آدرس IP جهت دسترسی به سرویس معتبر نمی باشد. (مقدار پارامتر errorCode در خروجی، برابر با عدد ۱۰۰۶ و مقدار پارامتر errorMessage علت عدم دسترسی کاربر به سرویس می باشد.)

نمونه خروجی :

{
  "errorCode": 1005,
  "errorMessage": ".مجوز دسترسی به متد برای حساب کاربری تعریف نشده است"
}

{
  "errorCode": 1006,
  "errorMessage": ".آدرس آی پی جهت دسترسی به سرویس معتبر نمی باشد"
}

500

خطایی در سرور رخ داده است. (مقدار پارامتر errorCode در خروجی، برابر با کد خطای مربوطه جهت ارائه به بخش پشتیبانی و مقدار پارامتر errorMessage شرح خطای مربوطه می باشد.)

نمونه خروجی :

{
  "errorCode": 1000011011,
  "errorMessage": "خطایی در سرور رخ داده است. | شناسه خطا : 1000011011"
}

200

اجرای موفقیت آمیز عملیات و خروجی حاوی آرایه ای از اطلاعات پیام های دریافت شده به نام messages می باشد. پارامترهای هر عنصر از آرایه‌ی messages عبارتند از:

receivedMessageId	شناسه پیام دریافتی
senderNumber	شماره فرستنده
recipientNumber	شماره گیرنده
content	متن پیام دریافتی
receivedTimestamp	تاریخ و زمان دریافت پیام بر اساس Unix Time (تعداد ثانیه از 00:00:00 01-01-1970 UTC)

نمونه خروجی :

{
  "messages": [
    {
      "receivedMessageId": 1001110100,
      "senderNumber": "09100000000",
      "recipientNumber": "10001000",
      "content": "Received message content 1",
      "receivedTimestamp": 1770170476
    },
    {
      "receivedMessageId": 1001110101,
      "senderNumber": "09300000000",
      "recipientNumber": "30003000",
      "content": "Received message content 2",
      "receivedTimestamp": 1770166876
    }
  ]
}

نمونه کدها :

Api Key

curl -X GET "https://api.smsafzar.ir/messages/received/recent?count=100" \
-H "X-Api-Key: YourApikey" \
-H "Cache-Control: no-cache" \
-H "Accept: application/json"

JWT Token

curl -X GET "https://api.smsafzar.ir/messages/received/recent?count=100" \
-H "Authorization: Bearer YourToken" \
-H "Cache-Control: no-cache" \
-H "Accept: application/json"

Api Key

using RestSharp;
using System;
using System.Threading.Tasks;

var apiBaseUrl = "https://api.smsafzar.ir";
var apiKey = "YourApiKey";
var receivedMessagesCount = 100;

// Options
var options = new RestClientOptions(apiBaseUrl);

// Client
var client = new RestClient(options);

// Request

var request = new RestRequest("messages/received/recent")
.AddQueryParameter("count", receivedMessagesCount.ToString());
request.AddHeader("X-Api-Key", apiKey);
request.AddHeader("Cache-Control", "no-cache");
request.AddHeader("Accept", "application/json");

// Call
var response = await client.GetAsync(request);

// Response
Console.WriteLine($"Response Status Code: {(int)response.StatusCode}");
Console.WriteLine($"Response Content: {response.Content}");

JWT Token

using RestSharp;
using System;
using System.Threading.Tasks;

var apiBaseUrl = "https://api.smsafzar.ir";
var jwtToken = "YourToken";
var receivedMessagesCount = 100;

// Options
var options = new RestClientOptions(apiBaseUrl);

// Client
var client = new RestClient(options);

// Request
var request = new RestRequest("messages/received/recent")
.AddQueryParameter("count", receivedMessagesCount.ToString());
request.AddHeader("Authorization", $"Bearer {jwtToken}");
request.AddHeader("Cache-Control", "no-cache");
request.AddHeader("Accept", "application/json");

// Call
var response = await client.GetAsync(request);

// Response
Console.WriteLine($"Response Status Code: {(int)response.StatusCode}");
Console.WriteLine($"Response Content: {response.Content}");

Api Key

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.util.HashMap;
import java.util.Map;
import com.fasterxml.jackson.databind.ObjectMapper;

try {
String apiBaseUrl = "https://api.smsafzar.ir";
String apiKey = "YourApiKey";
int receivedMessagesCount = 100;

HttpClient client = HttpClient.newHttpClient();

// Request
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create(apiBaseUrl + "/messages/received/recent?count=" + receivedMessagesCount))
.header("X-Api-Key", apiKey)
.header("Cache-Control", "no-cache")
.header("Accept", "application/json")
.GET()
.build();

// Call
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

//Response
int responseStatusCode = response.statusCode();
String responseContent = response.body();

System.out.println("Response Status Code: " + responseStatusCode);
System.out.println("Response Message: " + responseContent);
} catch (Exception e) {
e.printStackTrace();
}

JWT Token

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.util.HashMap;
import java.util.Map;
import com.fasterxml.jackson.databind.ObjectMapper;

try {
String apiBaseUrl = "https://api.smsafzar.ir";
String jwtToken = "YourToken";
int receivedMessagesCount = 100;

HttpClient client = HttpClient.newHttpClient();

// Request
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create(apiBaseUrl + "/messages/received/recent?count=" + receivedMessagesCount))
.header("Authorization", "Bearer " + jwtToken)
.header("Cache-Control", "no-cache")
.header("Accept", "application/json")
.GET()
.build();

// Call
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

//Response
int responseStatusCode = response.statusCode();
String responseContent = response.body();

System.out.println("Response Status Code: " + responseStatusCode);
System.out.println("Response Message: " + responseContent);
} catch (Exception e) {
e.printStackTrace();
}

Api Key

import requests

api_base_url = "https://api.smsafzar.ir"
received_messages_count = 100
api_key = "YourApiKey"

headers = {
"X-Api-Key": api_key,
"Cache-Control": "no-cache",
"Accept": "application/json"
}

# Call
response = requests.get(f"{api_base_url}/messages/received/recent?count={received_messages_count}", headers=headers)

# Response
print("Response Status Code:", response.status_code)
print("Response Content:", response.json())

JWT Token

import requests

api_base_url = "https://api.smsafzar.ir"
received_messages_count = 100
jwt_token = "YourToken"

headers = {
"Authorization": f"Bearer {jwt_token}",
"Cache-Control": "no-cache",
"Accept": "application/json"
}

# Call
response = requests.get(f"{api_base_url}/messages/received/recent?count={received_messages_count}", headers=headers)

# Response
print("Response Status Code:", response.status_code)
print("Response Content:", response.json())

Api Key

<?php
$apiBaseUrl = "https://api.smsafzar.ir";
$apiKey = "YourApiKey";
$receivedMessagesCount = 100;

// Initialize CURL session
$ch = curl_init();

// Set CURL options
curl_setopt($ch, CURLOPT_URL, "{$apiBaseUrl}/messages/received/recent?count={$receivedMessagesCount}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "X-Api-Key: $apiKey",
    "Cache-Control: no-cache",
    "Accept: application/json"
]);

// Call
$response = curl_exec($ch);

// Response
if (curl_errno($ch)) {
echo 'Error:' . curl_error($ch);
} else {
$httpStatusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
echo "Response Status Code: " . $httpStatusCode . "\n";
echo "Response Content: " . $response . "\n";
}

// Close the CURL session
curl_close($ch);
?>

JWT Token

<?php
$apiBaseUrl = "https://api.smsafzar.ir";
$jwtToken = "YourToken";
$receivedMessagesCount = 100;

// Initialize CURL session
$ch = curl_init();

// Set CURL options
curl_setopt($ch, CURLOPT_URL, "{$apiBaseUrl}/messages/received/recent?count={$receivedMessagesCount}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer $jwtToken",
    "Cache-Control: no-cache",
    "Accept: application/json"
]);

// Call
$response = curl_exec($ch);

// Response
if (curl_errno($ch)) {
echo 'Error:' . curl_error($ch);
} else {
$httpStatusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
echo "Response Status Code: " . $httpStatusCode . "\n";
echo "Response Content: " . $response . "\n";
}

// Close the CURL session
curl_close($ch);
?>

Api Key

const axios = require('axios');

const apiBaseUrl = 'https://api.smsafzar.ir';
const apiKey = 'YourApiKey';
const receivedMessagesCount = 100;

// Headers
const headers = {
'X-Api-Key': apiKey,
'Cache-Control': 'no-cache',
'Accept': 'application/json'
}

// Request
axios.get(`${apiBaseUrl}/messages/received/recent?count=${receivedMessagesCount}`, { headers })
.then(response => {
// Response
console.log('Response Status Code:', response.status);
console.log('Response Content:', response.data);
})
.catch(error => {
console.error('Error:', error.response ? error.response.data : error.message);
});

JWT Token

const axios = require('axios');

const apiBaseUrl = 'https://api.smsafzar.ir';
const jwtToken = 'YourToken';
const receivedMessagesCount = 100;

// Headers
const headers = {
'Authorization': `Bearer ${jwtToken}`,
'Cache-Control': 'no-cache',
'Accept': 'application/json'
}

// Request
axios.get(`${apiBaseUrl}/messages/received/recent?count=${receivedMessagesCount}`, { headers })
.then(response => {
// Response
console.log('Response Status Code:', response.status);
console.log('Response Content:', response.data);
})
.catch(error => {
console.error('Error:', error.response ? error.response.data : error.message);
});

Api Key

let httpClient= inject(HttpClient);

let apiBaseUrl = 'https://api.smsafzar.ir';
let apiKey = 'YourApiKey';
let receivedMessagesCount = 100;

let headers = new HttpHeaders({
'X-Api-Key': apiKey,
'Cache-Control': 'no-cache',
'Accept': 'application/json'
});

// Request
this.http.get(`${apiBaseUrl}/messages/received/recent?count=${receivedMessagesCount}`, { headers , observe: 'response' })
.subscribe(response => {
// Response
console.log('Response Status Code:', response.status);
console.log('Response Content:', response.body);
}, error => {
console.error('Error:', error);
});

JWT Token

let httpClient= inject(HttpClient);

let apiBaseUrl = 'https://api.smsafzar.ir';
let jwtToken = 'YourToken';
let receivedMessagesCount = 100;

let headers = new HttpHeaders({
'Authorization': `Bearer ${jwtToken}`,
'Cache-Control': 'no-cache',
'Accept': 'application/json'
});

// Request
this.http.get(`${apiBaseUrl}/messages/received/recent?count=${receivedMessagesCount}`, { headers , observe: 'response' })
.subscribe(response => {
// Response
console.log('Response Status Code:', response.status);
console.log('Response Content:', response.body);
}, error => {
console.error('Error:', error);
});

Api Key

import React, { useState } from 'react';

const [responseStatusCode, setResponseStatusCode] = useState(null);
const [responseContent, setResponseContent] = useState('');

const apiBaseUrl = 'https://api.smsafzar.ir';
const apiKey = 'YourApiKey';
const receivedMessagesCount = 100;

try {
// Request
const response = await fetch(`${apiBaseUrl}/messages/received/recent?count=${receivedMessagesCount}`, {
method: 'GET',
headers: {
'X-Api-Key': apiKey,
'Cache-Control': 'no-cache',
'Accept': 'application/json',
'Content-Type': 'application/json',
}
);

// Response
const content = await response.json();
setResponseStatusCode(response.status);
setResponseContent(content);

console.log('Response Status Code:', response.status);
console.log('Response Content:', content);
} catch (error) {
console.error('Error:', error);
}

JWT Token

import React, { useState } from 'react';

const [responseStatusCode, setResponseStatusCode] = useState(null);
const [responseContent, setResponseContent] = useState('');

const apiBaseUrl = 'https://api.smsafzar.ir';
const jwtToken = 'YourToken';
const receivedMessagesCount = 100;

try {
// Request
const response = await fetch(`${apiBaseUrl}/messages/received/recent?count=${receivedMessagesCount}`, {
method: 'GET',
headers: {
'Authorization': `Bearer ${jwtToken}`,
'Cache-Control': 'no-cache',
'Accept': 'application/json',
'Content-Type': 'application/json',
}
);

// Response
const content = await response.json();
setResponseStatusCode(response.status);
setResponseContent(content);

console.log('Response Status Code:', response.status);
console.log('Response Content:', content);
} catch (error) {
console.error('Error:', error);
}

031-34369080

Info@SMSAfzar.com

اصفهان، خیابان 5 آذر، مجتمع آذر

گزارش پیام های دریافتی اخیر

نام متد : messages/received/recent

پارامتر :

خروجی :

نمونه کدها :

Api Key

JWT Token

Api Key

JWT Token

Api Key

JWT Token

Api Key

JWT Token

Api Key

JWT Token

Api Key

JWT Token

Api Key

JWT Token

Api Key

JWT Token