| batchId | شناسه یکتای مجموعه پیام های ارسالی |
https://api.smsafzar.ir/messages/send/scheduled/
| 400 |
درخواست ارسالی صحیح نمی باشد.
مقدار پارامتر errorCode در خروجی، برابر با کد خطا و مقدار پارامتر errorMessage شرح خطای مربوطه می باشد.
نمونه خروجی :
{
"errorCode": 1106,
"errorMessage": ".شناسه مجموعه پیام های ارسالی مورد نظر معتبر نمی باشد"
}
|
||||||||
| 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 |
خروجی حاوی شناسه یکتا مجموعه پیام های ارسالی (batchId) و یک آرایه از اطلاعات پیام های حذف شده به نام messages می باشد. پارامترهای هر عنصر از آرایهی messages عبارتند از :
نمونه خروجی :
{
"batchId": "e95ce3c5-a34e-4fb0-ab9b-ae6eefd068ae",
"messages": [
{
"sentMessageId": "48696017-1d64-46b6-a69f-e1a15a5cce4f",
"senderNumber": "10001000",
"recipientNumber": "09100000000",
"content": "Your message content 1"
},
{
"sentMessageId": "2b8a1b41-674a-46a2-bb6c-280f4541f60b",
"senderNumber": "20002000",
"recipientNumber": "09300000000",
"content": "Your message content 2"
}
]
}
|
curl -X DELETE "https://api.smsafzar.ir/messages/send/scheduled/05496bc9-e54e-4b1c-8e42-026d597efd55" \ -H "X-Api-Key: YourApiKey" \ -H "Cache-Control: no-cache" \ -H "Accept: application/json"
curl -X DELETE "https://api.smsafzar.ir/messages/send/scheduled/05496bc9-e54e-4b1c-8e42-026d597efd55" \ -H "Authorization: Bearer YourToken" \ -H "Cache-Control: no-cache" \ -H "Accept: application/json" \ -H "Content-Type: application/json"
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 request = new RestRequest("messages/send/scheduled/05496bc9-e54e-4b1c-8e42-026d597efd55", Method.Delete);
request.AddHeader("X-Api-Key", $"{apiKey}");
request.AddHeader("Cache-Control", "no-cache");
request.AddHeader("Accept", "application/json");
// Call
var response = await client.ExecuteAsync(request);
// Response
Console.WriteLine($"Response Status Code: {(int)response.StatusCode}");
Console.WriteLine($"Response Content: {response.Content}");
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 request = new RestRequest("messages/send/scheduled/05496bc9-e54e-4b1c-8e42-026d597efd55", Method.Delete);
request.AddHeader("Authorization", $"Bearer {jwtToken}");
request.AddHeader("Cache-Control", "no-cache");
request.AddHeader("Accept", "application/json");
// Call
var response = await client.ExecuteAsync(request);
// Response
Console.WriteLine($"Response Status Code: {(int)response.StatusCode}");
Console.WriteLine($"Response Content: {response.Content}");
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
try {
String apiBaseUrl = "https://api.smsafzar.ir";
String apiKey = "YourApiKey";
HttpClient client = HttpClient.newHttpClient();
// Request
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create(apiBaseUrl + "/messages/send/scheduled/05496bc9-e54e-4b1c-8e42-026d597efd55"))
.header("X-Api-Key", apiKey)
.header("Cache-Control", "no-cache")
.header("Accept", "application/json")
.DELETE()
.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();
}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
try {
String apiBaseUrl = "https://api.smsafzar.ir";
String jwtToken = "YourToken";
HttpClient client = HttpClient.newHttpClient();
// Request
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create(apiBaseUrl + "/messages/send/scheduled/05496bc9-e54e-4b1c-8e42-026d597efd55"))
.header("Authorization", "Bearer " + jwtToken)
.header("Cache-Control", "no-cache")
.header("Accept", "application/json")
.DELETE()
.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();
}
import requests
api_base_url = "https://api.smsafzar.ir"
api_key = "YourApiKey"
headers = {
"X-Api-Key": api_key,
"Cache-Control": "no-cache",
"Accept": "application/json"
}
# Call
response = requests.delete(f"{api_base_url}/messages/send/scheduled/05496bc9-e54e-4b1c-8e42-026d597efd55", headers=headers)
# Response
print("Response Status Code:", response.status_code)
print("Response Content:", response.json())
import requests
api_base_url = "https://api.smsafzar.ir"
jwt_token = "YourToken"
headers = {
"Authorization": f"Bearer {jwt_token}",
"Cache-Control": "no-cache",
"Accept": "application/json"
}
# Call
response = requests.delete(f"{api_base_url}/messages/send/scheduled/05496bc9-e54e-4b1c-8e42-026d597efd55", headers=headers)
# Response
print("Response Status Code:", response.status_code)
print("Response Content:", response.json())
<?php
$apiBaseUrl = "https://api.smsafzar.ir";
$apiKey = "YourApiKey";
// Initialize CURL session
$ch = curl_init();
// Set CURL options
curl_setopt($ch, CURLOPT_URL, "{$apiBaseUrl}/messages/send/scheduled/05496bc9-e54e-4b1c-8e42-026d597efd55");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
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);
?>
<?php
$apiBaseUrl = "https://api.smsafzar.ir";
$jwtToken = "YourToken";
// Initialize CURL session
$ch = curl_init();
// Set CURL options
curl_setopt($ch, CURLOPT_URL, "{$apiBaseUrl}/messages/send/scheduled/05496bc9-e54e-4b1c-8e42-026d597efd55");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
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);
?>
const axios = require('axios');
const apiBaseUrl = 'https://api.smsafzar.ir';
const apiKey = 'YourApiKey';
const headers = {
'X-Api-Key': `${apiKey}`,
'Cache-Control': 'no-cache',
'Accept': 'application/json'
};
// Request
axios.delete(`${apiBaseUrl}/messages/send/scheduled/05496bc9-e54e-4b1c-8e42-026d597efd55`, { 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);
});
const axios = require('axios');
const apiBaseUrl = 'https://api.smsafzar.ir';
const jwtToken = 'YourToken';
const headers = {
'Authorization': `Bearer ${jwtToken}`,
'Cache-Control': 'no-cache',
'Accept': 'application/json'
};
// Request
axios.delete(`${apiBaseUrl}/messages/send/scheduled/05496bc9-e54e-4b1c-8e42-026d597efd55`, { 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);
});
let httpClient= inject(HttpClient);
let apiBaseUrl = 'https://api.smsafzar.ir';
let apiKey = 'YourApiKey';
let headers = new HttpHeaders({
'X-Api-Key': `${apiKey}`,
'Cache-Control': 'no-cache',
'Accept': 'application/json'
});
// Request
httpClient.delete(`${apiBaseUrl}/messages/send/scheduled/05496bc9-e54e-4b1c-8e42-026d597efd55`, { headers , observe: 'response' })
.subscribe(response => {
// Response
console.log('Response Status Code:', response.status);
console.log('Response Content:', response.body);
}, error => {
console.error('Error:', error);
});
let httpClient= inject(HttpClient);
let apiBaseUrl = 'https://api.smsafzar.ir';
let jwtToken = 'YourToken';
let headers = new HttpHeaders({
'Authorization': `Bearer ${jwtToken}`,
'Cache-Control': 'no-cache',
'Accept': 'application/json'
});
// Request
httpClient.delete(`${apiBaseUrl}/messages/send/scheduled/05496bc9-e54e-4b1c-8e42-026d597efd55`, { headers , observe: 'response' })
.subscribe(response => {
// Response
console.log('Response Status Code:', response.status);
console.log('Response Content:', response.body);
}, error => {
console.error('Error:', error);
});
import React, { useState } from 'react';
const [responseStatusCode, setResponseStatusCode] = useState(null);
const [responseContent, setResponseContent] = useState('');
const apiBaseUrl = 'https://api.smsafzar.ir';
const apiKey = 'YourApiKey';
try {
// Request
const response = await fetch(`${apiBaseUrl}/messages/send/scheduled/05496bc9-e54e-4b1c-8e42-026d597efd55`, {
method: 'DELETE',
headers: {
'X-Api-Key': `${apiKey}`,
'Cache-Control': 'no-cache',
'Accept': '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);
}
import React, { useState } from 'react';
const [responseStatusCode, setResponseStatusCode] = useState(null);
const [responseContent, setResponseContent] = useState('');
const apiBaseUrl = 'https://api.smsafzar.ir';
const jwtToken = 'YourToken';
try {
// Request
const response = await fetch(`${apiBaseUrl}/messages/send/scheduled/05496bc9-e54e-4b1c-8e42-026d597efd55`, {
method: 'DELETE',
headers: {
'Authorization': `Bearer ${jwtToken}`,
'Cache-Control': 'no-cache',
'Accept': '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);
}