مقدمه

مستند حاضر براي استفاده آن دسته از برنامه نویسانی طراحی شده است که می خواهند از سرویس RestFul واتگستر استفاده نمایند. در این راهنما روش ها و دستورات مورد نیاز برنامه نویسان در هنگام استفاده از سرویس RestFul شرح داده شده است .

سرویس RestFul به دلیل سادگی پیاده سازي و حمایت از تمامی زبانهاي برنامه نویسی از جمله محبوب ترین روش هاي مورد استفاده جهت ارسال پیام از طریق نرم افزار می باشد.

شروع به کار

برای شروع کار با وب سرویس ابتدا نیاز است که در سامانه اهراز هویت را انجام داده که در صورت موفقیت آمیز بودن عملیات ، کد دسترسی به شما نمایش داده خواهد شد که با استفاده از کد دسترسی می توانید از وب سرویس ها استفاده نمایید .

متدها و پارامترها

توجه شود که تمامی درخواست ها باید در قالب POST ارسال شوند و ورودی ها هم به صورت JSON باشند .

متد ارسال پیام واتساپ (Send Message)

این وب سرویس برای ارسال پیام واتساپ به دیگران استفاده خواهد شد.

POST

Https://{domain}/api/RestApi/SendMessage

پارامتر‌های ورودی

نام پارامتر	نوع پارامتر	توضیحات
Token	String اجباری	کد دسترسی
PhoneNumber	String [ ] اجباری	شماره همراه (حداکثر4شماره تلفن)
Message	String اجباری	متن پیام ارسالی
Base64	String	عکس به صورت Base64
MessageCall	String	شماره تماس (دکمه شیشه ای)
MessageCallName	String	عنوان شماره تماس (دکمه شیشه ای)
MessageUrl	String	لینک سایت یا هر لینکی (دکمه شیشه ای)
MessageUrlName	String	عنوان سایت یا هر لینکی (دکمه شیشه ای)
CountryCode	String	کد کشور

پارامتر‌های خروجی

نام پارامتر	نوع پارامتر	توضیحات
result	bool	در صورت صحت اطللاعات با مقدار "true" در غیر اینصورت با مقدار "false" تنظیم می‌شود
response	String	پیغام مرتبط

نمونه كد ورودی

PHP

Node.js

                                
                                                                        $url  = "https://{domain}/api/RestApi/SendMessage";
                                    $ch  = curl_init($url);
                                    $data  =  array(
                                       'Token' => 'dc886yi-ytey-yt-tyt-y14-3c13c767e643', 
                                       'PhoneNumber' => '09118587876',
                                       'Message' => 'ارسال تست'
                                       );
                                    $payload  = json_encode($data);
                                    curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);
                                    curl_setopt($ch, CURLOPT_HTTPHEADER,
                                          array( "Content-Type:application/json"));
                                    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
                                    $result  = new  curl_exec($ch);
                                    curl_close($ch);
                                    
                                
                            

                                
                                                                        var data  = new  {
                                       'Token' =  'dc886yi-ytey-yt-tyt-y14-3c13c767e643', 
                                       'PhoneNumber' = '09118587876',
                                       'Message' = 'ارسال تست'
                                      };
                                    var  json  = Newtonsoft.Json.JsonConvert.SerializeObject(data);
                                    var  Endata  = new  System.Net.Http.StringContent(                            
                                                     json, Encoding.UTF8, "application/json");
                                    var url = "https://{domain}/api/RestApi/SendMessage";
                                    using var client  = new  HttpClient();                            
                                    var response  = await  client.PostAsync(url, Endata);                            
                                    var result  =  response.Content.ReadAsStringAsync().Result;                            
                                    
                                
                            

                                
                                                                        await axios({
                                    method  : 'Post',
                                    url  : 'https://{domain}/api/RestApi/SendMessage',
                                    data  : {
                                       Token : 'dc886yi-ytey-yt-tyt-y14-3c13c767e643', 
                                       PhoneNumber : '09118587876',
                                       Message : 'ارسال تست'
                                     };
                                    })
                                    .then  (( response) => {
                                     console.log(response);
                                    }, ( error) => {
                                     console.log(response);
                                    })
                                   
                                
                            

نمونه كد خروجی


                                                                        HTTP/1.1 200 OK
                                    Content-Type: text/xml; charset=utf-8
                                    Content-Length: length
                                    
                                    {
                                         result : true,
                                         response : " پیام در صف قرار گرفت ",
                                    }

‌ورود

تایید شماره همراه