الشرائح
GET https://sms.arsi.fun/api/segments/
curl --request GET \
--url 'https://sms.arsi.fun/api/segments/' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://sms.arsi.fun/api/segments/' \
--header 'Authorization: Bearer {api_key}' \
| المعلمات | التفاصيل | الوصف |
|---|---|---|
| page | اختياري عدد صحيح | رقم الصفحة التي تريد عرض النتائج منها. القيمة الافتراضية هي 1. |
| results_per_page | اختياري عدد صحيح | عدد النتائج المطلوبة في كل صفحة. القيم المسموح بها هي: 10, 25, 50, 100, 250, 500, 1000. القيمة الافتراضية هي 25. |
| search | اختياري سلسلة نصية | سلسلة البحث. |
| search_by | اختياري سلسلة نصية | الحقل الذي تبحث عنه. القيم المسموح بها هي: name. |
| type | اختياري سلسلة نصية | Filter results by type. |
| segment_id | اختياري عدد صحيح | Filter results by segment ID. |
| user_id | اختياري عدد صحيح | Filter results by user ID. |
| datetime_field | اختياري سلسلة نصية | القيم المسموح بها: datetime, last_datetime |
| datetime_start | اختياري سلسلة نصية | Filter results starting from this datetime. Y-m-d H:i:s format. |
| datetime_end | اختياري سلسلة نصية | Filter results up to this datetime. Y-m-d H:i:s format. |
| order_by | اختياري سلسلة نصية | الحقل الذي تريد ترتيب النتائج بناءً عليه. القيم المسموح بها هي: segment_id, name, datetime, last_datetime, total_contacts. |
| order_type | اختياري سلسلة نصية | ترتيب النتائج. القيم المسموح بها هي: ASC للترتيب التصاعدي وDESC للترتيب التنازلي. |
{
"data": [
{
"id": 1,
"user_id": 1,
"name": "Example",
"settings": {
"contacts_ids": [1,2,3,4,5]
},
"type": "custom",
"total_contacts": 5,
"last_datetime": null,
"datetime": "2026-09-13 20:11:47",
}
],
"meta": {
"page": 1,
"results_per_page": 25,
"total": 1,
"total_pages": 1
},
"links": {
"first": "https://sms.arsi.fun/api/segments?page=1",
"last": "https://sms.arsi.fun/api/segments?page=1",
"next": null,
"prev": null,
"self": "https://sms.arsi.fun/api/segments?page=1"
}
}
GET https://sms.arsi.fun/api/segments/{segment_id}
curl --request GET \
--url 'https://sms.arsi.fun/api/segments/{segment_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://sms.arsi.fun/api/segments/{segment_id}' \
--header 'Authorization: Bearer {api_key}' \
{
"data": {
"id": 1,
"user_id": 1,
"name": "Example",
"settings": {
"contacts_ids": [1,2,3,4,5]
},
"type": "filter",
"total_contacts": 5,
"last_datetime": null,
"datetime": "2026-09-13 20:11:47",
}
}
POST https://sms.arsi.fun/api/segments
| المعلمات | التفاصيل | الوصف |
|---|---|---|
| name | مطلوب سلسلة نصية | - |
| type | اختياري سلسلة نصية | القيم المسموح بها: bulk, custom, filter |
| phone_numbers | اختياري سلسلة نصية | متوفر عند: segment = bulk |
| contacts_ids | اختياري سلسلة نصية | متوفر عند: segment = custom |
| filters_custom_parameter_key[index] | اختياري سلسلة نصية | متوفر عند: segment = filter |
| filters_custom_parameter_condition[index] | اختياري سلسلة نصية |
القيم المسموح بها: exact, not_exact, contains, not_contains, starts_with, not_starts_with, ends_with, not_ends_with, bigger_than, lower_than متوفر عند: segment = filter |
| filters_custom_parameter_value[index] | اختياري سلسلة نصية | متوفر عند: segment = filter |
| filters_countries[] | اختياري سلسلة نصية | متوفر عند: segment = filter |
| filters_continents[] | اختياري سلسلة نصية | متوفر عند: segment = filter |
curl --request POST \
--url 'https://sms.arsi.fun/api/segments' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example name' \
--form 'type=custom' \
--form 'contacts_ids=1,2,3,4,5' \
--url 'https://sms.arsi.fun/api/segments' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example name' \
--form 'type=custom' \
--form 'contacts_ids=1,2,3,4,5' \
{
"data": {
"id": 1
}
}
POST https://sms.arsi.fun/api/segments/{segment_id}
| المعلمات | التفاصيل | الوصف |
|---|---|---|
| name | اختياري سلسلة نصية | - |
| type | اختياري سلسلة نصية | القيم المسموح بها: bulk, custom, filter |
| phone_numbers | اختياري سلسلة نصية | متوفر عند: segment = bulk |
| contacts_ids | اختياري سلسلة نصية | متوفر عند: segment = custom |
| filters_custom_parameter_key[index] | اختياري سلسلة نصية | متوفر عند: segment = filter |
| filters_custom_parameter_condition[index] | اختياري سلسلة نصية |
القيم المسموح بها: exact, not_exact, contains, not_contains, starts_with, not_starts_with, ends_with, not_ends_with, bigger_than, lower_than متوفر عند: segment = filter |
| filters_custom_parameter_value[index] | اختياري سلسلة نصية | متوفر عند: segment = filter |
| filters_countries[] | اختياري سلسلة نصية | متوفر عند: segment = filter |
| filters_continents[] | اختياري سلسلة نصية | متوفر عند: segment = filter |
curl --request POST \
--url 'https://sms.arsi.fun/api/segments/{segment_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example name' \
--form 'type=custom' \
--form 'contacts_ids=1,2,3,4,5' \
--url 'https://sms.arsi.fun/api/segments/{segment_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example name' \
--form 'type=custom' \
--form 'contacts_ids=1,2,3,4,5' \
{
"data": {
"id": 1
}
}
DELETE https://sms.arsi.fun/api/segments/{segment_id}
curl --request DELETE \
--url 'https://sms.arsi.fun/api/segments/{segment_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://sms.arsi.fun/api/segments/{segment_id}' \
--header 'Authorization: Bearer {api_key}' \