شروع سریع
در این راهنما با کمترین گام ممکن، اولین پیامک الگویی را از طریق وبسرویس ارسال میکنید. مثالها از کلید API استفاده میکنند، زیرا سادهترین روش احراز هویت است. اگر برنامهی شما برای چند مشتری جداگانه کار میکند، به اتصال برنامههای چندمشتری مراجعه کنید.
پیشنیازها
- یک حساب کاربری فعال در پایاوا با اعتبار کافی
- یک کلید API ساختهشده در پنل؛ نگاه کنید به کلید API در پنل
- یک الگوی مجاز و کد عددی آن؛ فهرست الگوها را با الگوها دریافت میکنید
گام ۱: بررسی اتصال و موجودی
با فراخوانی دریافت موجودی مطمئن شوید کلید شما پذیرفته میشود:
- curl
- C#
- Python
- Node.js
- PHP
- Go
curl -X GET "https://api.payavasms.com/sms/api/Balance" \
-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/Balance");
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import requests
url = "https://api.payavasms.com/sms/api/Balance"
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/Balance", {
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/Balance");
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/Balance", 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 است و موجودی در data قرار دارد.
گام ۲: یافتن الگو
الگوهای قابل استفادهی خود را بخوانید و مقدار code و کلیدهای parameters الگوی دلخواه را بردارید:
- 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))
}
گام ۳: ارسال پیامک
کد الگو، شمارهی گیرنده و مقدار پارامترها را ارسال کنید:
- curl
- C#
- Python
- Node.js
- PHP
- Go
curl -X POST "https://api.payavasms.com/api/Message/SendMessage" \
-H "X-Api-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"code": 123456789012,
"lineNumber": "YOUR_LINE_NUMBER",
"recipients": [
{
"phoneNumber": "09120000000",
"parameters": [
{
"key": "name",
"value": "علی"
},
{
"key": "code",
"value": "5821"
}
]
}
]
}'
using System.Text;
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("X-Api-Key", "YOUR_API_KEY");
var json = """
{
"code": 123456789012,
"lineNumber": "YOUR_LINE_NUMBER",
"recipients": [
{
"phoneNumber": "09120000000",
"parameters": [
{
"key": "name",
"value": "علی"
},
{
"key": "code",
"value": "5821"
}
]
}
]
}
""";
using var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync("https://api.payavasms.com/api/Message/SendMessage", content);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import requests
url = "https://api.payavasms.com/api/Message/SendMessage"
headers = {
"X-Api-Key": "YOUR_API_KEY",
}
payload = {
"code": 123456789012,
"lineNumber": "YOUR_LINE_NUMBER",
"recipients": [
{
"phoneNumber": "09120000000",
"parameters": [
{
"key": "name",
"value": "علی"
},
{
"key": "code",
"value": "5821"
}
]
}
]
}
response = requests.post(url, headers=headers, json=payload)
print(response.status_code, response.text)
const response = await fetch("https://api.payavasms.com/api/Message/SendMessage", {
method: "POST",
headers: {
"X-Api-Key": "YOUR_API_KEY",
"Content-Type": "application/json",
},
body: JSON.stringify({
"code": 123456789012,
"lineNumber": "YOUR_LINE_NUMBER",
"recipients": [
{
"phoneNumber": "09120000000",
"parameters": [
{
"key": "name",
"value": "علی"
},
{
"key": "code",
"value": "5821"
}
]
}
]
}),
});
console.log(response.status, await response.text());
<?php
$ch = curl_init("https://api.payavasms.com/api/Message/SendMessage");
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"X-Api-Key: YOUR_API_KEY",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"code": 123456789012,
"lineNumber": "YOUR_LINE_NUMBER",
"recipients": [
{
"phoneNumber": "09120000000",
"parameters": [
{
"key": "name",
"value": "علی"
},
{
"key": "code",
"value": "5821"
}
]
}
]
}
JSON,
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $status . " " . $response;
package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
body := strings.NewReader(`{
"code": 123456789012,
"lineNumber": "YOUR_LINE_NUMBER",
"recipients": [
{
"phoneNumber": "09120000000",
"parameters": [
{
"key": "name",
"value": "علی"
},
{
"key": "code",
"value": "5821"
}
]
}
]
}`)
req, _ := http.NewRequest("POST", "https://api.payavasms.com/api/Message/SendMessage", body)
req.Header.Set("X-Api-Key", "YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")
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": {
"result": {
"messages": [
{
"registerCode": 10000001,
"phoneNumber": "989120000000",
"parts": 1
}
]
},
"platform": "Sms"
}
}
جزئیات کامل فیلدها در ارسال پیامک و فهرست خطاها در کدهای وضعیت و خطاها آمده است.