خطوط ارسال
شمارهی خط را میتوان در ارسال پیامک با lineNumber تعیین کرد. اگر ذکر نشود، سامانه خط مناسب را انتخاب میکند.
تطابق نوع خط و الگو
هر الگو فقط از خطی ارسال میشود که نوع آن با نوع پیام الگو یکی باشد. مثلاً الگویی با messageType برابر 0 فقط از خط با lineType برابر 0 ارسال میشود. نوع خط و نوع پیام هر دو از فهرست انواع پیام هستند. اگر lineNumber را بفرستید و نوع آن با الگو نخواند، خطای 3002 برمیگردد. اگر lineNumber را خالی بگذارید، سامانه فقط از میان خطوط همنوع الگو انتخاب میکند.
ساختار خط (LineNumberDto)
| فیلد | نوع | توضیح |
|---|---|---|
id | رشته | شناسهی خط |
providerName | رشته | نام ارائهدهنده |
lineType | عدد | نوع خط؛ همان code در انواع پیام. فقط الگوهایی با messageType برابر همین مقدار از این خط ارسال میشوند |
number | رشته | شمارهی خط؛ مقداری که در lineNumber ارسال میشود |
basePrice | عدد | قیمت پایه |
isActive | بولی | فعال بودن خط |
فهرست خطوط
GET /sms/api/LineNumber
- curl
- C#
- Python
- Node.js
- PHP
- Go
curl -X GET "https://api.payavasms.com/sms/api/LineNumber" \
-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/LineNumber");
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import requests
url = "https://api.payavasms.com/sms/api/LineNumber"
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/LineNumber", {
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/LineNumber");
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/LineNumber", 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": "665f0c2e9b1d4a0012ab34d1",
"providerName": "PROVIDER_NAME",
"lineType": 1,
"number": "YOUR_LINE_NUMBER",
"basePrice": 1000,
"isActive": true
}
]
خط با شناسه
GET /sms/api/LineNumber/getById/{id}
- curl
- C#
- Python
- Node.js
- PHP
- Go
curl -X GET "https://api.payavasms.com/sms/api/LineNumber/getById/LINE_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/LineNumber/getById/LINE_ID");
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import requests
url = "https://api.payavasms.com/sms/api/LineNumber/getById/LINE_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/LineNumber/getById/LINE_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/LineNumber/getById/LINE_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/LineNumber/getById/LINE_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": "665f0c2e9b1d4a0012ab34d1",
"providerName": "PROVIDER_NAME",
"lineType": 1,
"number": "YOUR_LINE_NUMBER",
"basePrice": 1000,
"isActive": true
}