پرش به مطلب اصلی

مخاطبان

ساختار مخاطب​

فیلدنوعتوضیح
idرشتهشناسه‌ی مخاطب (در پاسخ)
nameرشتهنام مخاطب
phoneNumberرشتهشماره‌ی موبایل؛ کلید یکتاکننده‌ی مخاطب در دفترچه
fieldsشیءمقدار فیلدهای سفارشی؛ کلید همان key فیلد است

دریافت مخاطبان​

GET /cms/api/Contact/GetContacts/{id}

curl -X GET "https://api.payavasms.com/cms/api/Contact/GetContacts/CATEGORY_ID" \
-H "X-Api-Key: YOUR_API_KEY"
[
{
"id": "665f0c2e9b1d4a0012ab34d3",
"name": "علی رضایی",
"phoneNumber": "09120000000",
"fields": {
"city": "تهران",
"birth": "1990-03-21"
}
}
]

افزودن یا ویرایش گروهی​

POST /cms/api/Contact/UpsertContacts/{id}

بدنه آرایه‌ای از مخاطبان است. مخاطبی که شماره‌اش وجود داشته باشد ویرایش می‌شود و فقط فیلدهای ارسال‌شده تغییر می‌کنند؛ مقدار null برای یک فیلد، آن را پاک می‌کند. مقدار تاریخ را می‌توان شمسی یا میلادی فرستاد.

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"
}
}
]'
{
"totalCount": 1,
"successCount": 1,
"failedCount": 0,
"errors": []
}
فیلد پاسختوضیح
totalCountتعداد ردیف‌های دریافتی
successCountتعداد موفق
failedCountتعداد ناموفق
errors[].phoneNumberشماره‌ی ردیف خطادار
errors[].errorsفهرست پیام‌های خطا برای آن ردیف

حذف با شناسه​

POST /cms/api/Contact/DeleteContacts/{id}

بدنه آرایه‌ای از شناسه‌ی مخاطب است. پاسخ 201 و بدون بدنه است.

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"
]'

حذف با شماره​

POST /cms/api/Contact/DeleteContactsByPhoneNumber/{id}

بدنه آرایه‌ای از شماره‌های موبایل است. پاسخ 201 و بدون بدنه است.

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"
]'