پنل کاربری
4 - گزارش
نمایش وضعیت پیام ارسالی
نمایش وضعیت پیامهای ارسالی از طریق وبسرویس، شامل وضعیت تحویل، زمان ارسال و اطلاعات دیگر.
آدرس: /report/webservice/status
متد:GET
فراخوانی درخواست:
هدر:
| نمونه | توضیحات | نوع | نام پارامتر |
|---|---|---|---|
| Basic c21zUGFuZWxDbGdcaW52AC | توکن دریافتی در لاگین | اجباری | Authorization |
نمونه درخواست:
آدرس:https://www.Adress.com/report/webservice/status?byCustomer=false&ids=12354&ids=649448
دریافت پاسخ:
بدنه:
[
{
"customerId": "CUSTOMER_ID",
"serverId": "SERVER_ID",
"totalParts": "TOTAL_PARTS",
"totalDeliveredParts": "TOTAL_DELIVERED_PARTS",
"totalUnDeliveredParts": "TOTAL_UNDELIVERED_PARTS",
"totalUnKnownParts": "TOTAL_UNKNOWN_PARTS",
"status": "STATUS"
}
]توضیحات:
| توضیحات | نوع | نام پارامتر |
|---|---|---|
| شناسه مشتری | String | customerId |
| شناسه سرور | String | serverId |
| تعداد پارتها | Long | totalParts |
| تعداد پارتهای موفق | Long | totalDeliveredParts |
| تعداد پارتهای ناموفق | Long | totalUnDeliveredParts |
| تعداد پارتهای نامشخص | Long | totalUnKnownParts |
| وضعیت نهایی پیام | String | status |
وضعیتها:
| توضیحات | نوع |
|---|---|
| موفقیت آمیز | Send Successfully |
| با خطا مواجه شده است | Failed |
| در انتظار گرفتن وضعیت از سمت اپراتور | Pending |
| در حال ارسال به اپراتور | Pending In Queue |
نکات:
در هربار فراخوانی میتوانید تا ۲۵۰ وضعیت پیام مجزا را استعلام نمایید.
نمایش پیامهای دریافتی
نمایش پیامهایی که از سوی کاربران دریافت شدهاند.
آدرس: /report/webservice/mo
متد:GET
فراخوانی درخواست:
هدر:
| نمونه | توضیحات | نوع | نام پارامتر |
|---|---|---|---|
| Basic c21zUGFuZWxDbGdcaW52AC | توکن دریافتی در لاگین | اجباری | Authorization |
نمونه درخواست:
آدرس:https://www.Adress.com/report/webservice/mo?number=982000***&id=478
توضیحات:
| نمونه | توضیحات | نوع | نام پارامتر |
|---|---|---|---|
| سرشماره(شماره گیرنده پیام) | اجباری | String | number |
| شناسه پیام (در صورت عدم ارسال این مقدار، فقط پیامهای دیده نشده و در غیر این صورت، تمامی پیامهایی که شناسه آنها از مقدار ارسال شده بیشتر باشد، بازگردانده میشوند.) | اختیاری | Long | id |
دریافت پاسخ:
بدنه:
[
{
"body": "BODY",
"id": ID,
"from": "FROM",
"date": "DATE",
"to": "TO"
}
]توضیحات:
| نمونه | نوع | نام پارامتر |
|---|---|---|
| متن پیام دریافتی | String | body |
| شناسه رکورد | Long | id |
| شماره ارسال کننده پیام | String | from |
| زمان دریافت پیام(فرمت yyyy-MM-dd HH:mm:ss) | String | date |
| شماره گیرنده پیام(سرشماره) | String | to |
نکات:
در هربار فراخوانی (درصورتی که مقدار id خالی ارسال شود) ، 90 پیام دریافتی خوانده نشده در جواب ارسال خواهد شد و پس از فراخوانی آن، 90 پیام به حالت خوانده شده در خواهند آمد.
