نحوه جستجو مخاطب وب سرویسی می تواند مناسب برنامه نویسانی باشد که نمی دانند شماره موبایل مشتریان را ذخیره شده دارند یا نه. پیامک سفید یکی از سامانه های مورد استفاده و پرکاربرد برای ارسال پیام های خدماتی و اطلاع رسانی می باشد. با توجه به اینکه یکی از قوانین استفاده از پیامک سفید اضافه نمودن مشتری به لیست کاربران می باشد، ممکن است برخی از برنامه نویسان به دنبال این باشند که قبل از اضافه نمودن شماره موبایل به لیست کاربرانشان، بررسی کنند که شماره موبایل قبلا اضافه شده است یا خیر.

با وجود API قوی پیام سفید می شود در یک تابع و با یک دستور اقدام به دریافت اطلاعات مشتری نمود. مقاله پیشرو نحوه جستجو مخاطب وب سرویسی پیامک سفید را به شما آموزش خواهد داد.

نحوه جستجو مخاطب وب سرویسی :

برای جستجو مخاطب تابع شما به صورت GET می باشد. رفرنس نیز به صورت https://api.sms.ir/users/v1/Contacts/SearchContacts?prefix=xxxx&firstname=xxxxx&lastname=xxxxx&mobile=xxxxx&groupid=0&pageid=0  تعریف شده است.

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

برای دریافت اطلاعات مخاطب و یا مخاطبینتان می بایست حتما شماره گروه مخاطب را وارد نمایید. برای دریافت شماره گروه مخاطب می شود به مقاله ” نحوه دریافت شناسه گروه مخاطب ” رجوع نمود.

نیازی به ورود مقدار برای page ID نمی باشد و مقدار 0 را برای این پارامتر در نظر بگیرید.

شماره موبایل مورد نظرتان را در قسمت mobile وارد نمایید.

البته به عنوان هدر درخواست؛ دو پارامتر زیر باید ارسال شوند:

Content-Type که مقدار آن برابر با application/json می باشد و پارامتر x-sms-ir-secure-token که برای مقداردهی باید تابع توکن فراخوانی شود. برای دریافت توکن به دو مقدار کلید وب سرویس و کد امینتی نیاز دارید. مقادیر این دو به صورت ثابت در سامانه پیامک سفید و بالای صفحه سمت راست ، در بخش ” وب سرویس ” قرار داده شده است.

پس از ورود اطلاعات و پارامترها به صورت صحیح ، می توانید مقدار بازگشتی را مشاهده نمایید. مقدار بازگشتی شامل اطلاعات زیر می باشد :

Contacts : آرایه ای از مخاطبین که از جستجو بازگردانده شده اند.

ContactRelationId :شناسه ارتباطی مخاطب. این شناسه به منظور شناسایی مخاطبین در گروه هایی که عضو هستند کاربرد دارد و با شناسه یکتای مخاطب متفاوت است.

GroupName : نام گروهی که مخاطب در آن عضو است.

Prefix : پیشوند مخاطب

FirstName : نام مخاطب

LastName : نام خانوادگی مخاطب

Mobile : شماره موبایل مخاطب

EmojiId: شناسه اموجی که می تواند سه مقدار عددی یک و دو و سه را شامل شود. هنگام فراخوانی اطلاعات مخاطب هر شناسه می تواند تصویر کاراکتر مرتبط را نشان دهد.

ناشناس : Emojiid = 1

آقا : Emojiid = 2

خانم : Emojiid = 3

IsSuccessful : بعنوان موفقیت آمیز بودن یا نبودن درخواست بازگردانده می شود و به صورتTrue و یا Falseمی باشد.

Message : پیامی که در پاسخ درخواست ارسال می شود را نمایش می دهد.

ErrorCode : کد خطایی که ممکن است در درخواست اتفاق بیفتد را باز می گرداند