برای دریافت اطلاعات یک مخاطب خاص از دفترچه تلفن می توانید از این متد استفاده کنید.

برای استفاده از این متد می توانید از یکی از روش های SOAP Api و یا Rest Api استفاده نمایید. که در بخش پیاده سازی روش ها شرح داده شده است.

{{:: 'controllers.documentation.titleTable' | translate }} {{:: 'controllers.documentation.mustDo' | translate }} {{:: 'controllers.documentation.typeTable' | translate }} {{:: 'controllers.documentation.defualtValue' | translate }} {{:: 'controllers.documentation.description' | translate }}
1 Username بله متن این پارامتر از جنس string می باشد و مقدار آن نام کاربری شما برای ورود به پنل نیک اس ام اس می باشد.
2 Password بله متن این پارامتر از جنس string می باشد و مقدار آن کلمه عبور شما برای ورود به پنل نیک اس ام اس می باشد.
3 Id بله عددی این متغییر از جنس Integer بوده و مقدار آن برابر است با Id گروهی که اطلاعات آن را می خواهیم دریافت کنیم.
{{:: 'controllers.documentation.titleTable' | translate }} {{:: 'controllers.documentation.typeTable' | translate }} {{:: 'controllers.documentation.description' | translate }}
1
Status
عددی این پارامتر از جنس Integer می باشد (مابین 0 تا 5) و مقدار آن بیانگر وضعیت درخواست شماست که آیا موفقیت آمیز بوده است یا خیر. بر اساس جدول نتایج موجود در بخش توضیحات کلی می توانید نتیجه درخواست خود را بررسی کنید.
2
Exception
متن این متغییر از جنس Integer می باشد و مقدار آن برابر عددی منحصر به فرد است که سیستم به این درخواست ارسال پیامک تخصیص می دهد.
3
BirthDate
تاریخ این متغییر از جنس DateTime می باشد و مقدار آن برابر تاریخ تولد مخاطب است.
4
CreateDate
تاریخ این متغییر از جنس DateTime می باشد و مقدار آن برابر تاریخ ایجاد مخاطب است.
5
CustomFields
Object این متغییر یک Dictionary است که کلید آن شمارنده فیلد اختصاصی مربوط به این مخاطب است و مقدار آن مقدار فیلد اختصاصی است. توجه داشته باشید یک مخاطب با توجه به گروهی که در آن قرار می گیرد می تواند جندین فیلد اختصاصی داشته باشد.
6
Description
متن این متغییر از جنس string است و مقدار آن شرحی است درباره این مخاطب
7
Email
متن این متغییر از جنس string است و مقدار آن پست الکترونیکی این مخاطب است.
8
FullName
متن این متغییر از جنس string است و مقدار آن نام و نام خانوادگی این مخاطب است.
9
GroupId
عددی این متغییر از جنس integer است و مقدار آن Id گروهی است که این مخاطب در آن گروه قرار گرفته است.
10
Id
عددی این پارامتر از جنس Integer می باشد و مقدار آن برابر است با شماره منحصر به فرد که توسط سرور به مخاطب تخصیص داده شده است.
11
IsBlackList
بلی / خیر این متغییر از جنس True/False است. چنانچه تمایل دارید مخاطب را در لیست سیاه خود قرار دهید این مقدار را برابر True بر گردانید در غیر اینصورت مقدار آن را False قرار دهید.
12
Male
بلی / خیر این متغییر از جنس True/False است چنانچه مخاطب مرد باشد مقدار این متغییر True و چنانچه زن باشد مقدار آن False خواهد بود.
13
Married
بلی / خیر این متغییر از جنس True/False است چنانچه مخاطب ازدواج کرده است مقدار این متغییر True و در غیر اینصورت مقدار آن False است.
14
Mobile
متن این پارامتر از جنس string می باشد و مقدار آن برابر است با شماره تلفن همراه مخاطب.
15
State
متن این پارامتر از جنس string می باشد و مقدار آن برابر است با شهر یا استان مخاطب.
16
WeddingDate
تاریخ این پارامتر از جنس Date می باشد و مقدار آن برابر تاریخ ازدواج مخاطب است.