الگوها
الگو قالب آمادهی پیامک است. برای ارسال، کد الگو (code) و مقدار پارامترهای آن لازم است. مفهوم الگو و انواع پارامتر در الگوها و پارامترها توضیح داده شده است.
ساختار الگو (MsgFormatDto)
| فیلد | نوع | توضیح |
|---|---|---|
id | عدد صحیح | شناسهی داخلی الگو |
code | عدد صحیح | کد الگو؛ همان مقداری که در ارسال استفاده میشود |
messageType | عدد صحیح | نوع پیام؛ ببینید انواع پیام. الگو فقط از خطی با همین نوع ارسال میشود |
title | رشته | عنوان الگو |
defaultText | رشته | متن الگو؛ جای پارامترها با @ مشخص شده است |
groupId | رشته | شناسهی گروه الگو |
hasDynamicParameters | بولی | اگر false باشد، متن یکبار با پارامترهای گیرندهی اول ساخته و برای همه استفاده میشود |
isActive | بولی | فقط الگوی فعال قابل ارسال است |
parameters | آرایه | فهرست پارامترها |
ساختار پارامتر
| فیلد | نوع | توضیح |
|---|---|---|
key | رشته | کلید پارامتر؛ در ارسال با همین کلید مقدار میدهید. کلیدهای با پیشوند Dy_ داینامیکاند و خودکار پر میشوند |
name | رشته | نام نمایشی |
optional | بولی | اختیاری بودن پارامتر |
optionText | رشته | متنی که فقط در صورت وجود مقدار، به آن افزوده میشود |
optionPlacement | عدد | 0 پیش از مقدار، 1 پس از مقدار |
maxLength | عدد | حداکثر طول مقدار (پیشفرض ۵۰) |
regexPattern | رشته | مجموعهی نویسههای مجاز؛ نویسههای غیرمجاز حذف میشوند و خطا نمیدهند |
value | رشته | مقدار ثابت (در پارامترهای ثابت مانند برند) |
فهرست الگوها
GET /sms/api/MsgFormat
- curl
- C#
- Python
- Node.js
- PHP
- Go
curl -X GET "https://api.payavasms.com/sms/api/MsgFormat" \
-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/MsgFormat");
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import requests
url = "https://api.payavasms.com/sms/api/MsgFormat"
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/MsgFormat", {
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/MsgFormat");
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/MsgFormat", 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))
}
[
{
"id": "665f0c2e9b1d4a0012ab34d0",
"code": 123456789012,
"messageType": 0,
"title": "خوشآمدگویی",
"defaultText": "@ عزیز، @ برای شما فعال شد.",
"groupId": "665f0c2e9b1d4a0012ab34cf",
"hasDynamicParameters": false,
"isActive": true,
"parameters": [
{
"key": "name",
"name": "نام",
"optional": false,
"optionText": null,
"optionPlacement": 0,
"maxLength": 50,
"regexPattern": null,
"value": null
},
{
"key": "discount",
"name": "درصد تخفیف",
"optional": true,
"optionText": "تخفیف ",
"optionPlacement": 0,
"maxLength": 3,
"regexPattern": "0-9",
"value": null
}
]
}
]
الگو با شناسه
GET /sms/api/MsgFormat/{id}
- curl
- C#
- Python
- Node.js
- PHP
- Go
curl -X GET "https://api.payavasms.com/sms/api/MsgFormat/FORMAT_ID" \
-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/MsgFormat/FORMAT_ID");
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import requests
url = "https://api.payavasms.com/sms/api/MsgFormat/FORMAT_ID"
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/MsgFormat/FORMAT_ID", {
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/MsgFormat/FORMAT_ID");
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/MsgFormat/FORMAT_ID", 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))
}
{
"id": "665f0c2e9b1d4a0012ab34d0",
"code": 123456789012,
"messageType": 0,
"title": "خوشآمدگویی",
"defaultText": "@ عزیز، @ برای شما فعال شد.",
"groupId": "665f0c2e9b1d4a0012ab34cf",
"hasDynamicParameters": false,
"isActive": true,
"parameters": [
{
"key": "name",
"name": "نام",
"optional": false,
"optionText": null,
"optionPlacement": 0,
"maxLength": 50,
"regexPattern": null,
"value": null
},
{
"key": "discount",
"name": "درصد تخفیف",
"optional": true,
"optionText": "تخفیف ",
"optionPlacement": 0,
"maxLength": 3,
"regexPattern": "0-9",
"value": null
}
]
}
الگو با کد
GET /sms/api/MsgFormat/Code/{code}
- curl
- C#
- Python
- Node.js
- PHP
- Go
curl -X GET "https://api.payavasms.com/sms/api/MsgFormat/Code/123456789012" \
-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/MsgFormat/Code/123456789012");
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import requests
url = "https://api.payavasms.com/sms/api/MsgFormat/Code/123456789012"
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/MsgFormat/Code/123456789012", {
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/MsgFormat/Code/123456789012");
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/MsgFormat/Code/123456789012", 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))
}
{
"id": "665f0c2e9b1d4a0012ab34d0",
"code": 123456789012,
"messageType": 0,
"title": "خوشآمدگویی",
"defaultText": "@ عزیز، @ برای شما فعال شد.",
"groupId": "665f0c2e9b1d4a0012ab34cf",
"hasDynamicParameters": false,
"isActive": true,
"parameters": [
{
"key": "name",
"name": "نام",
"optional": false,
"optionText": null,
"optionPlacement": 0,
"maxLength": 50,
"regexPattern": null,
"value": null
},
{
"key": "discount",
"name": "درصد تخفیف",
"optional": true,
"optionText": "تخفیف ",
"optionPlacement": 0,
"maxLength": 3,
"regexPattern": "0-9",
"value": null
}
]
}
الگوهای یک گروه
GET /sms/api/MsgFormat/Group/{GroupId}
- curl
- C#
- Python
- Node.js
- PHP
- Go
curl -X GET "https://api.payavasms.com/sms/api/MsgFormat/Group/GROUP_ID" \
-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/MsgFormat/Group/GROUP_ID");
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import requests
url = "https://api.payavasms.com/sms/api/MsgFormat/Group/GROUP_ID"
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/MsgFormat/Group/GROUP_ID", {
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/MsgFormat/Group/GROUP_ID");
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/MsgFormat/Group/GROUP_ID", 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))
}
[
{
"id": "665f0c2e9b1d4a0012ab34d0",
"code": 123456789012,
"messageType": 0,
"title": "خوشآمدگویی",
"defaultText": "@ عزیز، @ برای شما فعال شد.",
"groupId": "665f0c2e9b1d4a0012ab34cf",
"hasDynamicParameters": false,
"isActive": true,
"parameters": [
{
"key": "name",
"name": "نام",
"optional": false,
"optionText": null,
"optionPlacement": 0,
"maxLength": 50,
"regexPattern": null,
"value": null
},
{
"key": "discount",
"name": "درصد تخفیف",
"optional": true,
"optionText": "تخفیف ",
"optionPlacement": 0,
"maxLength": 3,
"regexPattern": "0-9",
"value": null
}
]
}
]
پارامترهای یک الگو
GET /sms/api/MsgFormat/Parameters?code={code}
- curl
- C#
- Python
- Node.js
- PHP
- Go
curl -X GET "https://api.payavasms.com/sms/api/MsgFormat/Parameters?code=123456789012" \
-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/MsgFormat/Parameters?code=123456789012");
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import requests
url = "https://api.payavasms.com/sms/api/MsgFormat/Parameters?code=123456789012"
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/MsgFormat/Parameters?code=123456789012", {
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/MsgFormat/Parameters?code=123456789012");
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/MsgFormat/Parameters?code=123456789012", 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))
}
[
{
"key": "name",
"name": "نام",
"optional": false,
"optionText": null,
"optionPlacement": 0,
"maxLength": 50,
"regexPattern": null,
"value": null
},
{
"key": "discount",
"name": "درصد تخفیف",
"optional": true,
"optionText": "تخفیف ",
"optionPlacement": 0,
"maxLength": 3,
"regexPattern": "0-9",
"value": null
}
]
الگوهای کاربر
GET /sms/api/MsgFormat/User/{skip}/{limit} الگوهای اختصاصی حساب شما را صفحهبندیشده برمیگرداند. skip تعداد ردیفهای ردشده و limit تعداد ردیفهای برگشتی است.
- curl
- C#
- Python
- Node.js
- PHP
- Go
curl -X GET "https://api.payavasms.com/sms/api/MsgFormat/User/0/20" \
-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/MsgFormat/User/0/20");
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import requests
url = "https://api.payavasms.com/sms/api/MsgFormat/User/0/20"
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/MsgFormat/User/0/20", {
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/MsgFormat/User/0/20");
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/MsgFormat/User/0/20", 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))
}
[
{
"id": "665f0c2e9b1d4a0012ab34d0",
"code": 123456789012,
"messageType": 0,
"title": "خوشآمدگویی",
"defaultText": "@ عزیز، @ برای شما فعال شد.",
"groupId": "665f0c2e9b1d4a0012ab34cf",
"hasDynamicParameters": false,
"isActive": true,
"parameters": [
{
"key": "name",
"name": "نام",
"optional": false,
"optionText": null,
"optionPlacement": 0,
"maxLength": 50,
"regexPattern": null,
"value": null
},
{
"key": "discount",
"name": "درصد تخفیف",
"optional": true,
"optionText": "تخفیف ",
"optionPlacement": 0,
"maxLength": 3,
"regexPattern": "0-9",
"value": null
}
]
}
]
تعداد الگوهای کاربر
GET /sms/api/MsgFormat/Count/User
- curl
- C#
- Python
- Node.js
- PHP
- Go
curl -X GET "https://api.payavasms.com/sms/api/MsgFormat/Count/User" \
-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/MsgFormat/Count/User");
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import requests
url = "https://api.payavasms.com/sms/api/MsgFormat/Count/User"
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/MsgFormat/Count/User", {
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/MsgFormat/Count/User");
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/MsgFormat/Count/User", 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))
}
5
خطاها
مسیرهایی که الگو را با شناسه یا کد میگیرند، اگر الگو پیدا نشود، پاسخ «یافت نشد» برمیگردانند. جزئیات در کدهای وضعیت آمده است.