کدهای وضعیت و خطاها
پاسخ بیشتر endpointها یک بدنهی JSON با سه فیلد status، message و data است. status=0 یعنی موفق. برای endpointهای ارسال، خطاهای کسبوکاری ممکن است با کد HTTP 200 برگردند؛ پس همیشه status را بررسی کنید.
خطاهای احراز هویت
| کد HTTP | بدنه | علت |
|---|---|---|
401 | {"error":"missing_api_key", ...} | کلید API ارسال نشده است |
401 | {"error":"invalid_api_key", ...} | کلید نامعتبر، غیرفعال، منقضی یا از IP غیرمجاز است |
403 | {"error":"insufficient_scope", ...} | کلید دسترسی لازم برای این بخش را ندارد |
401 | بدون بدنه یا با پیام | توکن Bearer نامعتبر یا منقضی است؛ توکن را نوسازی کنید |
جزئیات در کلید API و توکن و سشن آمده است.
کدهای status
| کد | دسته | توضیحات |
|---|---|---|
-1 | عمومی | خطا در انجام عملیات. |
0 | عمومی | عملیات با موفقیت انجام شد. |
1 | موجودی | موجودی کافی نیست. |
2 | عمومی | با موفقیت حذف شد. |
3 | عمومی | با موفقیت بهروزرسانی شد. |
4 | عمومی | موردی یافت نشد. |
5 | عمومی | پیام شما در حال پردازش توسط سیستم میباشد. |
2000 | الگو | الگوی مورد نظر پیدا نشد. |
2001 | الگو | امکان استفاده از الگوی مورد نظر برای شما وجود ندارد. |
2002 | الگو | امکان ارسال پیام سریع برای الگوی مورد نظر وجود ندارد. |
2003 | الگو | پارامتر ورودی با الگو مطابقت ندارد. |
2004 | الگو | الگوی مورد نظر غیرفعال میباشد. |
3000 | خط | خط مورد نظر در سامانه موجود نمیباشد. |
3001 | خط | خط مورد نظر اختصاصی میباشد. |
3002 | خط | امکان ارسال پیام با الگو {0} برای شماره مورد نظر وجود ندارد. |
3003 | خط | امکان ارسال پیام با الگوی انتخابی برای شماره مورد نظر وجود ندارد. |
3004 | خط | خط مورد نظر غیرفعال میباشد. |
3005 | خط | ارائهدهنده پیامک مورد نظر غیرفعال میباشد. |
3500 | خط و اپراتور | امکان ارسال پیام به برخی از شمارهها ممکن نیست (نامعتبر یا فهرست محرومان). |
4000 | مسدودی | این پیام مطابق با قوانین سیستم تأیید نشد و ارسال آن امکانپذیر نیست. |
4001 | مسدودی | حساب کاربری شما مسدود شده است. |
4100 | اعتبارسنجی | سرویس اعتبارسنجی وجود ندارد. |
4500 | برنامه | اپلیکیشن معتبر نیست (X-Client-App الزامی است). |
4501 | برنامه | اپلیکیشن با حساب مطابقت ندارد. |
4701 | شناسه | مقدار UserId وجود ندارد. |
4702 | شناسه | مقدار Client_Id وجود ندارد. |
5000 | پارامتر | برخی از پارامترهای وارد شده معتبر نیستند. |
5001 | پارامتر | کلید پارامتر نامعتبر است. |
5002 | پارامتر | طول مقدار پارامتر از حد مجاز بیشتر است. |
5003 | پارامتر | پارامتر اجباری مقدار ندارد. |
5100 | ورودی | ساختار JSON ارسالی صحیح نیست. |
5101 | ورودی | یکی از فیلدهای اجباری ارسال نشده است. |
5102 | ورودی | مقدار یک یا چند پارامتر ورودی معتبر نیست. |
5103 | ورودی | تعداد آیتمهای ارسالی بیش از حد مجاز است. |
6000 | سرویس ارسال | سرویس ارسال پیام قفل میباشد. ارسال ممکن نیست. |
6001 | سرویس ارسال | سرویس ارسال پیامک مطابق با سرویسدهنده سرشماره شما یافت نشد. |
6002 | سرویس ارسال | در ارتباط با سرویس ارسال پیامک خطایی رخ داد. |
6100 | سرویس ارسال | سرویس مدیریت ارسال مطابق با سرویسدهنده سرشماره شما یافت نشد. |
7000 | پیامرسان | هیچ پیامرسان فعالی برای کاربر یافت نشد. |
7030 | پیامرسان | کانال ارسال پیام نامعتبر میباشد. |
8000 | ارسال گروهی | مقادیر درخواست ارسال گروهی جدید با مقدار قبلی تطابق ندارد. |
8001 | ارسال گروهی | موجودی شما پاسخگوی عملیات نیست و به میزان {0} ریال کسری دارد. |
8002 | ارسال گروهی | خطا در بررسی وضعیت موجودی حساب شما. |
8010 | ارسال گروهی | کد دسته ارسالی در سامانه موجود نمیباشد. |
10000 | مخاطب | مخاطبی متناسب با فیلتر شما یافت نشد. |
برای جزئیات خطاهای ارسال گروهی به خطاهای ارسال گروهی مراجعه کنید.
برای مشاهده فهرست بهروز کدها از endpoint زیر استفاده کنید.
دریافت متن بهروز کدها
GET /sms/api/StatusCode
- curl
- C#
- Python
- Node.js
- PHP
- Go
curl -X GET "https://api.payavasms.com/sms/api/StatusCode" \
-H "X-Api-Key: YOUR_API_KEY"
using System.Text;
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("X-Api-Key", "YOUR_API_KEY");
var response = await client.GetAsync("https://api.payavasms.com/sms/api/StatusCode");
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import requests
url = "https://api.payavasms.com/sms/api/StatusCode"
headers = {
"X-Api-Key": "YOUR_API_KEY",
}
response = requests.get(url, headers=headers)
print(response.status_code, response.text)
const response = await fetch("https://api.payavasms.com/sms/api/StatusCode", {
method: "GET",
headers: {
"X-Api-Key": "YOUR_API_KEY",
},
});
console.log(response.status, await response.text());
<?php
$ch = curl_init("https://api.payavasms.com/sms/api/StatusCode");
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"X-Api-Key: YOUR_API_KEY",
],
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $status . " " . $response;
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://api.payavasms.com/sms/api/StatusCode", nil)
req.Header.Set("X-Api-Key", "YOUR_API_KEY")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
data, _ := io.ReadAll(res.Body)
fmt.Println(res.StatusCode, string(data))
}
[
{
"status": 0,
"message": "عملیات با موفقیت انجام شد."
}
]
خطای پارامتر
هنگام خطای پارامتر، data فهرستی از خطاهاست که اندیس گیرنده (index)، کلید (key)، کد (status) و دلیل (reason) را دارد. نمونه:
{
"status": 5002,
"message": "خطا در پارامترها",
"data": [
{ "index": 0, "key": "name", "status": 5002, "reason": "طول مقدار بیش از حد مجاز است" }
]
}
برای مشاهده فهرست کامل کدهای خطا و توضیحات مربوط به هرکدام، لطفاً به بخش وضعیت ها در پنل کاربری خود مراجعه کنید.