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

دفترچه‌های تلفن

دفترچه‌ی تلفن (در API با نام «دسته» یا Category) مخزن مخاطبان است و فیلدهای سفارشی و مخاطبان به آن وابسته‌اند. مفهوم آن در مخاطبان و فیلدها آمده است. همه‌ی مسیرها زیر /cms/api/Category هستند.

فهرست دفترچه‌ها​

GET /cms/api/Category/GetCategories

curl -X GET "https://api.payavasms.com/cms/api/Category/GetCategories" \
-H "X-Api-Key: YOUR_API_KEY"
[
{
"id": "665f0c2e9b1d4a0012ab34d2",
"name": "مشتریان",
"fields": [
{
"key": "city",
"title": "شهر",
"type": 0
},
{
"key": "birth",
"title": "تاریخ تولد",
"type": 2
}
]
}
]

ایجاد دفترچه​

POST /cms/api/Category/UpsertCategory

فیلد بدنهنوعالزامیتوضیح
dataرشتهبلهنام دفترچه؛ یکتا و حداکثر ۵۰ نویسه
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": "مشتریان"
}'
{
"id": "665f0c2e9b1d4a0012ab34d2",
"name": "مشتریان",
"fields": [
{
"key": "city",
"title": "شهر",
"type": 0
},
{
"key": "birth",
"title": "تاریخ تولد",
"type": 2
}
]
}

ویرایش نام دفترچه​

همان endpoint با پارامتر query به نام id:

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": "مشتریان ویژه"
}'

حذف دفترچه​

DELETE /cms/api/Category/DeleteCategory/{id}

اگر دفترچه به کمپین فعال وابسته باشد، پاسخ 400 است. در حالت موفق پاسخ 204 و بدون بدنه است.

curl -X DELETE "https://api.payavasms.com/cms/api/Category/DeleteCategory/CATEGORY_ID" \
-H "X-Api-Key: YOUR_API_KEY"

آیا دفترچه کمپین دارد؟​

GET /cms/api/Category/{id}/hasCampaign

پاسخ 200 یعنی دفترچه به کمپین وابسته است و 404 یعنی نیست.

curl -X GET "https://api.payavasms.com/cms/api/Category/CATEGORY_ID/hasCampaign" \
-H "X-Api-Key: YOUR_API_KEY"

کدام دفترچه‌ها کمپین دارند؟​

POST /cms/api/Category/lists/with-campaigns

بدنه فهرستی از شناسه‌ی دفترچه‌هاست. پاسخ زیرمجموعه‌ای است که کمپین دارند؛ اگر هیچ‌کدام نداشته باشند، 204 است.

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