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

گزارش وضعیت پیام های ارسالی

نام متد : messages/status

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

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

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

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

sentMessageIdes

آرایه ای از شناسه های ارسال پیام

نحوه ی ارسال پارامتر ورودی در قالب Json و به صورت ذیل می باشد :

{
  "sentMessageIdes": [
    "e1d20dd8-a346-40e1-95c7-979312682c41",
    "955fe482-08ad-4b68-872c-037fe176a0b1"
  ]
}

خروجی :

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

400

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

نمونه خروجی :

{
  "errorCode": 1001,
  "errorMessage": ".حداکثر تعداد شناسه های پیام 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

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

sentMessageId	شناسه پیام
messageStatus	وضعیت پیام

پارامتر messageStatus (وضعیت پیام) حاوی یکی از مقادیر ذیل می باشد :

-1	شناسه ارسال پیام معتبر نمی باشد.
0	در انتظار ارسال
1	ارسال شده به درگاه اپراتور
2	رسیده به مخاطب
3	نرسیده به مخاطب
4	ارسال نشده

نمونه خروجی :

{
  "batchId": "3906fcb7-d6bb-458a-9bd7-2b0f6b21e411",
  "messageStatuses": [
    {
      "sentMessageId": "19a84ebc-ff2d-45bb-b5b5-155d032f69f7",
      "messageStatus": 1
    },
    {
      "sentMessageId": "cf929afe-2f0f-4a8f-8710-3e55d4a69b35",
      "messageStatus": 2
    }
  ]
}

نمونه کدها :

Api Key

curl -X POST "https://api.smsafzar.ir/messages/status" \
-H "X-Api-Key: YourApiKey" \
-H "Cache-Control: no-cache" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
  "sentMessageIdes": ["486ceaa6-f80b-4283-b320-54218635d122" , "8a150556-75fd-4d30-aeb9-3f3f69cd139f"]
}'

JWT Token

curl -X POST "https://api.smsafzar.ir/messages/status" \
-H "Authorization: Bearer YourToken" \
-H "Cache-Control: no-cache" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
  "sentMessageIdes": ["486ceaa6-f80b-4283-b320-54218635d122" , "8a150556-75fd-4d30-aeb9-3f3f69cd139f"]
}'

Api Key

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

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

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

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

// Request

var sentMessageIdsJson = new
{
sentMessageIdes = new string[] { "486ceaa6-f80b-4283-b320-54218635d122" , "8a150556-75fd-4d30-aeb9-3f3f69cd139f" }
};

var request = new RestRequest("messages/status");
request.AddHeader("X-Api-Key", $"{apiKey}");
request.AddHeader("Cache-Control", "no-cache");
request.AddHeader("Accept", "application/json");
request.AddHeader("Content-Type", "application/json");
request.AddJsonBody(sentMessageIdsJson);

// Call
var response = await client.PostAsync(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";

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

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

// Request

var sentMessageIdsJson = new
{
sentMessageIdes = new string[] { "486ceaa6-f80b-4283-b320-54218635d122" , "8a150556-75fd-4d30-aeb9-3f3f69cd139f" }
};

var request = new RestRequest("messages/status");
request.AddHeader("Authorization", $"Bearer {jwtToken}");
request.AddHeader("Cache-Control", "no-cache");
request.AddHeader("Accept", "application/json");
request.AddHeader("Content-Type", "application/json");
request.AddJsonBody(sentMessageIdsJson);

// Call
var response = await client.PostAsync(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";

Map<String, Object> sentMessageIdes = new HashMap<>();
sentMessageIdes.put("sentMessageIdes", new String[]{"486ceaa6-f80b-4283-b320-54218635d122" , "8a150556-75fd-4d30-aeb9-3f3f69cd139f"});

ObjectMapper objectMapper = new ObjectMapper();
String requestBody = objectMapper.writeValueAsString(sentMessageIdes);


HttpClient client = HttpClient.newHttpClient();

// Request
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create(apiBaseUrl + "/messages/status"))
.header("X-Api-Key", apiKey)
.header("Cache-Control", "no-cache")
.header("Accept", "application/json")
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(requestBody))
.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";

Map<String, Object> sentMessageIdes = new HashMap<>();
sentMessageIdes.put("sentMessageIdes", new String[]{"486ceaa6-f80b-4283-b320-54218635d122" , "8a150556-75fd-4d30-aeb9-3f3f69cd139f"});

ObjectMapper objectMapper = new ObjectMapper();
String requestBody = objectMapper.writeValueAsString(sentMessageIdes);


HttpClient client = HttpClient.newHttpClient();

// Request
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create(apiBaseUrl + "/messages/status"))
.header("Authorization", "Bearer " + jwtToken)
.header("Cache-Control", "no-cache")
.header("Accept", "application/json")
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(requestBody))
.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"
api_key = "YourApiKey"

sent_message_ides_json = {
"sentMessageIdes": ["486ceaa6-f80b-4283-b320-54218635d122" , "8a150556-75fd-4d30-aeb9-3f3f69cd139f"]
}

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

# Call
response = requests.post(f"{api_base_url}/messages/status", json=sent_message_ides_json, 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"
jwt_token = "YourToken"

sent_message_ides_json = {
"sentMessageIdes": ["486ceaa6-f80b-4283-b320-54218635d122" , "8a150556-75fd-4d30-aeb9-3f3f69cd139f"]
}

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

# Call
response = requests.post(f"{api_base_url}/messages/status", json=sent_message_ides_json, 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";

$sentMessageIdsJson = json_encode([
'sentMessageIdes' => ['486ceaa6-f80b-4283-b320-54218635d122' , '8a150556-75fd-4d30-aeb9-3f3f69cd139f']
]);

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

// Set CURL options
curl_setopt($ch, CURLOPT_URL, "{$apiBaseUrl}/messages/status");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $sentMessageIdsJson);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "X-Api-Key: $apiKey",
    "Cache-Control: no-cache",
    "Accept: application/json",
    "Content-Type: 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";

$sentMessageIdsJson = json_encode([
'sentMessageIdes' => ['486ceaa6-f80b-4283-b320-54218635d122' , '8a150556-75fd-4d30-aeb9-3f3f69cd139f']
]);

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

// Set CURL options
curl_setopt($ch, CURLOPT_URL, "{$apiBaseUrl}/messages/status");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $sentMessageIdsJson);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer $jwtToken",
    "Cache-Control: no-cache",
    "Accept: application/json",
    "Content-Type: 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 sentMessageIdsJson = {
sentMessageIdes: ['486ceaa6-f80b-4283-b320-54218635d122' , '8a150556-75fd-4d30-aeb9-3f3f69cd139f']
};

const headers = {
'X-Api-Key': `${apiKey}`,
'Cache-Control': 'no-cache',
'Accept': 'application/json',
'Content-Type': 'application/json'
};

// Request
axios.post(`${apiBaseUrl}/messages/status`, sentMessageIdsJson, { 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 sentMessageIdsJson = {
sentMessageIdes: ['486ceaa6-f80b-4283-b320-54218635d122' , '8a150556-75fd-4d30-aeb9-3f3f69cd139f']
};

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

// Request
axios.post(`${apiBaseUrl}/messages/status`, sentMessageIdsJson, { 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';

const sentMessageIdsJson = {
sentMessageIdes: ['486ceaa6-f80b-4283-b320-54218635d122' , '8a150556-75fd-4d30-aeb9-3f3f69cd139f']
};

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

// Request
this.http.post(`${apiBaseUrl}/messages/status`, sentMessageIdsJson, { 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';

const sentMessageIdsJson = {
sentMessageIdes: ['486ceaa6-f80b-4283-b320-54218635d122' , '8a150556-75fd-4d30-aeb9-3f3f69cd139f']
};

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

// Request
this.http.post(`${apiBaseUrl}/messages/status`, sentMessageIdsJson, { 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 sentMessageIdsJson = {
sentMessageIdes: ['486ceaa6-f80b-4283-b320-54218635d122' , '8a150556-75fd-4d30-aeb9-3f3f69cd139f']
};

try {
// Request
const response = await fetch(`${apiBaseUrl}/messages/status`, {
method: 'POST',
headers: {
'X-Api-Key': `${apiKey}`,
'Cache-Control': 'no-cache',
'Accept': 'application/json',
'Content-Type': 'application/json',
},
body: JSON.stringify(sentMessageIdsJson),
});

// 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 sentMessageIdsJson = {
sentMessageIdes: ['486ceaa6-f80b-4283-b320-54218635d122' , '8a150556-75fd-4d30-aeb9-3f3f69cd139f']
};

try {
// Request
const response = await fetch(`${apiBaseUrl}/messages/status`, {
method: 'POST',
headers: {
'Authorization': `Bearer ${jwtToken}`,
'Cache-Control': 'no-cache',
'Accept': 'application/json',
'Content-Type': 'application/json',
},
body: JSON.stringify(sentMessageIdsJson),
});

// 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/status

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

خروجی :

نمونه کدها :

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