دفترچههای تلفن
دفترچهی تلفن (در API با نام «دسته» یا Category) مخزن مخاطبان است و فیلدهای سفارشی و مخاطبان به آن وابستهاند. مفهوم آن در مخاطبان و فیلدها آمده است. همهی مسیرها زیر /cms/api/Category هستند.
فهرست دفترچهها
GET /cms/api/Category/GetCategories
- curl
- C#
- Python
- Node.js
- PHP
- Go
curl -X GET "https://api.payavasms.com/cms/api/Category/GetCategories" \
-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/cms/api/Category/GetCategories");
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import requests
url = "https://api.payavasms.com/cms/api/Category/GetCategories"
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/cms/api/Category/GetCategories", {
method: "GET",
headers: {
"X-Api-Key": "YOUR_API_KEY",
},
});
console.log(response.status, await response.text());
<?php
$ch = curl_init("https://api.payavasms.com/cms/api/Category/GetCategories");
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/cms/api/Category/GetCategories", 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": "665f0c2e9b1d4a0012ab34d2",
"name": "مشتریان",
"fields": [
{
"key": "city",
"title": "شهر",
"type": 0
},
{
"key": "birth",
"title": "تاریخ تولد",
"type": 2
}
]
}
]
ایجاد دفترچه
POST /cms/api/Category/UpsertCategory
| فیلد بدنه | نوع | الزامی | توضیح |
|---|---|---|---|
data | رشته | بله | نام دفترچه؛ یکتا و حداکثر ۵۰ نویسه |
- curl
- C#
- Python
- Node.js
- PHP
- Go
curl -X POST "https://api.payavasms.com/cms/api/Category/UpsertCategory" \
-H "X-Api-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"data": "مشتریان"
}'
using System.Text;
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("X-Api-Key", "YOUR_API_KEY");
var json = """
{
"data": "مشتریان"
}
""";
using var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync("https://api.payavasms.com/cms/api/Category/UpsertCategory", content);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import requests
url = "https://api.payavasms.com/cms/api/Category/UpsertCategory"
headers = {
"X-Api-Key": "YOUR_API_KEY",
}
payload = {
"data": "مشتریان"
}
response = requests.post(url, headers=headers, json=payload)
print(response.status_code, response.text)
const response = await fetch("https://api.payavasms.com/cms/api/Category/UpsertCategory", {
method: "POST",
headers: {
"X-Api-Key": "YOUR_API_KEY",
"Content-Type": "application/json",
},
body: JSON.stringify({
"data": "مشتریان"
}),
});
console.log(response.status, await response.text());
<?php
$ch = curl_init("https://api.payavasms.com/cms/api/Category/UpsertCategory");
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'
{
"data": "مشتریان"
}
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(`{
"data": "مشتریان"
}`)
req, _ := http.NewRequest("POST", "https://api.payavasms.com/cms/api/Category/UpsertCategory", 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))
}
{
"id": "665f0c2e9b1d4a0012ab34d2",
"name": "مشتریان",
"fields": [
{
"key": "city",
"title": "شهر",
"type": 0
},
{
"key": "birth",
"title": "تاریخ تولد",
"type": 2
}
]
}
ویرایش نام دفترچه
همان endpoint با پارامتر query به نام id:
- curl
- C#
- Python
- Node.js
- PHP
- Go
curl -X POST "https://api.payavasms.com/cms/api/Category/UpsertCategory?id=CATEGORY_ID" \
-H "X-Api-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"data": "مشتریان ویژه"
}'
using System.Text;
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("X-Api-Key", "YOUR_API_KEY");
var json = """
{
"data": "مشتریان ویژه"
}
""";
using var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync("https://api.payavasms.com/cms/api/Category/UpsertCategory?id=CATEGORY_ID", content);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import requests
url = "https://api.payavasms.com/cms/api/Category/UpsertCategory?id=CATEGORY_ID"
headers = {
"X-Api-Key": "YOUR_API_KEY",
}
payload = {
"data": "مشتریان ویژه"
}
response = requests.post(url, headers=headers, json=payload)
print(response.status_code, response.text)
const response = await fetch("https://api.payavasms.com/cms/api/Category/UpsertCategory?id=CATEGORY_ID", {
method: "POST",
headers: {
"X-Api-Key": "YOUR_API_KEY",
"Content-Type": "application/json",
},
body: JSON.stringify({
"data": "مشتریان ویژه"
}),
});
console.log(response.status, await response.text());
<?php
$ch = curl_init("https://api.payavasms.com/cms/api/Category/UpsertCategory?id=CATEGORY_ID");
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'
{
"data": "مشتریان ویژه"
}
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(`{
"data": "مشتریان ویژه"
}`)
req, _ := http.NewRequest("POST", "https://api.payavasms.com/cms/api/Category/UpsertCategory?id=CATEGORY_ID", 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))
}
حذف دفترچه
DELETE /cms/api/Category/DeleteCategory/{id}
اگر دفترچه به کمپین فعال وابسته باشد، پاسخ 400 است. در حالت موفق پاسخ 204 و بدون بدنه است.
- curl
- C#
- Python
- Node.js
- PHP
- Go
curl -X DELETE "https://api.payavasms.com/cms/api/Category/DeleteCategory/CATEGORY_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.DeleteAsync("https://api.payavasms.com/cms/api/Category/DeleteCategory/CATEGORY_ID");
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import requests
url = "https://api.payavasms.com/cms/api/Category/DeleteCategory/CATEGORY_ID"
headers = {
"X-Api-Key": "YOUR_API_KEY",
}
response = requests.delete(url, headers=headers)
print(response.status_code, response.text)
const response = await fetch("https://api.payavasms.com/cms/api/Category/DeleteCategory/CATEGORY_ID", {
method: "DELETE",
headers: {
"X-Api-Key": "YOUR_API_KEY",
},
});
console.log(response.status, await response.text());
<?php
$ch = curl_init("https://api.payavasms.com/cms/api/Category/DeleteCategory/CATEGORY_ID");
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => "DELETE",
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("DELETE", "https://api.payavasms.com/cms/api/Category/DeleteCategory/CATEGORY_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))
}
آیا دفترچه کمپین دارد؟
GET /cms/api/Category/{id}/hasCampaign
پاسخ 200 یعنی دفترچه به کمپین وابسته است و 404 یعنی نیست.
- curl
- C#
- Python
- Node.js
- PHP
- Go
curl -X GET "https://api.payavasms.com/cms/api/Category/CATEGORY_ID/hasCampaign" \
-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/cms/api/Category/CATEGORY_ID/hasCampaign");
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import requests
url = "https://api.payavasms.com/cms/api/Category/CATEGORY_ID/hasCampaign"
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/cms/api/Category/CATEGORY_ID/hasCampaign", {
method: "GET",
headers: {
"X-Api-Key": "YOUR_API_KEY",
},
});
console.log(response.status, await response.text());
<?php
$ch = curl_init("https://api.payavasms.com/cms/api/Category/CATEGORY_ID/hasCampaign");
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/cms/api/Category/CATEGORY_ID/hasCampaign", 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))
}
کدام دفترچهها کمپین دارند؟
POST /cms/api/Category/lists/with-campaigns
بدنه فهرستی از شناسهی دفترچههاست. پاسخ زیرمجموعهای است که کمپین دارند؛ اگر هیچکدام نداشته باشند، 204 است.
- curl
- C#
- Python
- Node.js
- PHP
- Go
curl -X POST "https://api.payavasms.com/cms/api/Category/lists/with-campaigns" \
-H "X-Api-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '[
"CATEGORY_ID_1",
"CATEGORY_ID_2"
]'
using System.Text;
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("X-Api-Key", "YOUR_API_KEY");
var json = """
[
"CATEGORY_ID_1",
"CATEGORY_ID_2"
]
""";
using var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync("https://api.payavasms.com/cms/api/Category/lists/with-campaigns", content);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import requests
url = "https://api.payavasms.com/cms/api/Category/lists/with-campaigns"
headers = {
"X-Api-Key": "YOUR_API_KEY",
}
payload = [
"CATEGORY_ID_1",
"CATEGORY_ID_2"
]
response = requests.post(url, headers=headers, json=payload)
print(response.status_code, response.text)
const response = await fetch("https://api.payavasms.com/cms/api/Category/lists/with-campaigns", {
method: "POST",
headers: {
"X-Api-Key": "YOUR_API_KEY",
"Content-Type": "application/json",
},
body: JSON.stringify([
"CATEGORY_ID_1",
"CATEGORY_ID_2"
]),
});
console.log(response.status, await response.text());
<?php
$ch = curl_init("https://api.payavasms.com/cms/api/Category/lists/with-campaigns");
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'
[
"CATEGORY_ID_1",
"CATEGORY_ID_2"
]
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(`[
"CATEGORY_ID_1",
"CATEGORY_ID_2"
]`)
req, _ := http.NewRequest("POST", "https://api.payavasms.com/cms/api/Category/lists/with-campaigns", 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))
}
[
"CATEGORY_ID_1"
]