مخاطبان
ساختار مخاطب
| فیلد | نوع | توضیح |
|---|---|---|
id | رشته | شناسهی مخاطب (در پاسخ) |
name | رشته | نام مخاطب |
phoneNumber | رشته | شمارهی موبایل؛ کلید یکتاکنندهی مخاطب در دفترچه |
fields | شیء | مقدار فیلدهای سفارشی؛ کلید همان key فیلد است |
دریافت مخاطبان
GET /cms/api/Contact/GetContacts/{id}
- curl
- C#
- Python
- Node.js
- PHP
- Go
curl -X GET "https://api.payavasms.com/cms/api/Contact/GetContacts/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.GetAsync("https://api.payavasms.com/cms/api/Contact/GetContacts/CATEGORY_ID");
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import requests
url = "https://api.payavasms.com/cms/api/Contact/GetContacts/CATEGORY_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/cms/api/Contact/GetContacts/CATEGORY_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/cms/api/Contact/GetContacts/CATEGORY_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/cms/api/Contact/GetContacts/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))
}
[
{
"id": "665f0c2e9b1d4a0012ab34d3",
"name": "علی رضایی",
"phoneNumber": "09120000000",
"fields": {
"city": "تهران",
"birth": "1990-03-21"
}
}
]
افزودن یا ویرایش گروهی
POST /cms/api/Contact/UpsertContacts/{id}
بدنه آرایهای از مخاطبان است. مخاطبی که شمارهاش وجود داشته باشد ویرایش میشود و فقط فیلدهای ارسالشده تغییر میکنند؛ مقدار null برای یک فیلد، آن را پاک میکند. مقدار تاریخ را میتوان شمسی یا میلادی فرستاد.
- curl
- C#
- Python
- Node.js
- PHP
- Go
curl -X POST "https://api.payavasms.com/cms/api/Contact/UpsertContacts/CATEGORY_ID" \
-H "X-Api-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '[
{
"name": "علی رضایی",
"phoneNumber": "09120000000",
"fields": {
"city": "تهران",
"birth": "1369/01/01"
}
}
]'
using System.Text;
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("X-Api-Key", "YOUR_API_KEY");
var json = """
[
{
"name": "علی رضایی",
"phoneNumber": "09120000000",
"fields": {
"city": "تهران",
"birth": "1369/01/01"
}
}
]
""";
using var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync("https://api.payavasms.com/cms/api/Contact/UpsertContacts/CATEGORY_ID", content);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import requests
url = "https://api.payavasms.com/cms/api/Contact/UpsertContacts/CATEGORY_ID"
headers = {
"X-Api-Key": "YOUR_API_KEY",
}
payload = [
{
"name": "علی رضایی",
"phoneNumber": "09120000000",
"fields": {
"city": "تهران",
"birth": "1369/01/01"
}
}
]
response = requests.post(url, headers=headers, json=payload)
print(response.status_code, response.text)
const response = await fetch("https://api.payavasms.com/cms/api/Contact/UpsertContacts/CATEGORY_ID", {
method: "POST",
headers: {
"X-Api-Key": "YOUR_API_KEY",
"Content-Type": "application/json",
},
body: JSON.stringify([
{
"name": "علی رضایی",
"phoneNumber": "09120000000",
"fields": {
"city": "تهران",
"birth": "1369/01/01"
}
}
]),
});
console.log(response.status, await response.text());
<?php
$ch = curl_init("https://api.payavasms.com/cms/api/Contact/UpsertContacts/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'
[
{
"name": "علی رضایی",
"phoneNumber": "09120000000",
"fields": {
"city": "تهران",
"birth": "1369/01/01"
}
}
]
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(`[
{
"name": "علی رضایی",
"phoneNumber": "09120000000",
"fields": {
"city": "تهران",
"birth": "1369/01/01"
}
}
]`)
req, _ := http.NewRequest("POST", "https://api.payavasms.com/cms/api/Contact/UpsertContacts/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))
}
{
"totalCount": 1,
"successCount": 1,
"failedCount": 0,
"errors": []
}
| فیلد پاسخ | توضیح |
|---|---|
totalCount | تعداد ردیفهای دریافتی |
successCount | تعداد موفق |
failedCount | تعداد ناموفق |
errors[].phoneNumber | شمارهی ردیف خطادار |
errors[].errors | فهرست پیامهای خطا برای آن ردیف |
حذف با شناسه
POST /cms/api/Contact/DeleteContacts/{id}
بدنه آرایهای از شناسهی مخاطب است. پاسخ 201 و بدون بدنه است.
- curl
- C#
- Python
- Node.js
- PHP
- Go
curl -X POST "https://api.payavasms.com/cms/api/Contact/DeleteContacts/CATEGORY_ID" \
-H "X-Api-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '[
"665f0c2e9b1d4a0012ab34d3"
]'
using System.Text;
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("X-Api-Key", "YOUR_API_KEY");
var json = """
[
"665f0c2e9b1d4a0012ab34d3"
]
""";
using var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync("https://api.payavasms.com/cms/api/Contact/DeleteContacts/CATEGORY_ID", content);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import requests
url = "https://api.payavasms.com/cms/api/Contact/DeleteContacts/CATEGORY_ID"
headers = {
"X-Api-Key": "YOUR_API_KEY",
}
payload = [
"665f0c2e9b1d4a0012ab34d3"
]
response = requests.post(url, headers=headers, json=payload)
print(response.status_code, response.text)
const response = await fetch("https://api.payavasms.com/cms/api/Contact/DeleteContacts/CATEGORY_ID", {
method: "POST",
headers: {
"X-Api-Key": "YOUR_API_KEY",
"Content-Type": "application/json",
},
body: JSON.stringify([
"665f0c2e9b1d4a0012ab34d3"
]),
});
console.log(response.status, await response.text());
<?php
$ch = curl_init("https://api.payavasms.com/cms/api/Contact/DeleteContacts/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'
[
"665f0c2e9b1d4a0012ab34d3"
]
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(`[
"665f0c2e9b1d4a0012ab34d3"
]`)
req, _ := http.NewRequest("POST", "https://api.payavasms.com/cms/api/Contact/DeleteContacts/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))
}
حذف با شماره
POST /cms/api/Contact/DeleteContactsByPhoneNumber/{id}
بدنه آرایهای از شمارههای موبایل است. پاسخ 201 و بدون بدنه است.
- curl
- C#
- Python
- Node.js
- PHP
- Go
curl -X POST "https://api.payavasms.com/cms/api/Contact/DeleteContactsByPhoneNumber/CATEGORY_ID" \
-H "X-Api-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '[
"09120000000"
]'
using System.Text;
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("X-Api-Key", "YOUR_API_KEY");
var json = """
[
"09120000000"
]
""";
using var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync("https://api.payavasms.com/cms/api/Contact/DeleteContactsByPhoneNumber/CATEGORY_ID", content);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import requests
url = "https://api.payavasms.com/cms/api/Contact/DeleteContactsByPhoneNumber/CATEGORY_ID"
headers = {
"X-Api-Key": "YOUR_API_KEY",
}
payload = [
"09120000000"
]
response = requests.post(url, headers=headers, json=payload)
print(response.status_code, response.text)
const response = await fetch("https://api.payavasms.com/cms/api/Contact/DeleteContactsByPhoneNumber/CATEGORY_ID", {
method: "POST",
headers: {
"X-Api-Key": "YOUR_API_KEY",
"Content-Type": "application/json",
},
body: JSON.stringify([
"09120000000"
]),
});
console.log(response.status, await response.text());
<?php
$ch = curl_init("https://api.payavasms.com/cms/api/Contact/DeleteContactsByPhoneNumber/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'
[
"09120000000"
]
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(`[
"09120000000"
]`)
req, _ := http.NewRequest("POST", "https://api.payavasms.com/cms/api/Contact/DeleteContactsByPhoneNumber/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))
}