مقادیر

وب‌سرویس‌های کاربری

برای دریافت اعتبار کاربر از آدرس زیر به همراه نام کاربری و رمز عبور و یا توکن (در هدر) در یک درخواست GET استفاده کنید.

http://185.112.33.62/api/v1/rest/my/credit
          

مقدار برگشتی در صورت موفقیت به شکل زیر خواهد بود.

{
  "status": 200,
  "result":
  {
    "status": ...,
    "value": ...
  }
}
          

کلید status اولیه مشخص می‌کند که ادامه‌ی ساختار جیسون برگردانده شده مطابق انتظار یک ساختار پاسخ صحیح است. کلید result مقادیری را مشخص می‌کند که به عنوان پاسخ این وب‌سرویس دریافت کرده‌اید

مقدار result نیز خود حاوی دو کلید است. کلید status که یا صفر است (به معنای معتبر بدون مقدار کلید value) و یا غیر صفر است که خطای پیش آمده در مورد نامعتبر بودن مقدار value را روشن می‌کند. برای اطلاع از خطای پیش آمده مقدار بازگشتی status را با مقادیری که در بخش قبل توضیح داده شد مقایسه کنید.

در صورت عدم موفقیت، پاسخ برگشت داده شده به صورت زیر است

{
  "status": ...,
  "message": "..."
}
          

مقدار status مطابق با استانداردهای http است. به عنوان مثال مقدار ۴۰۴ به معنای عدم یافت شدن منبع است. مقدار message نیز یک توضیح کمکی است.

برای دریافت جزئیات پروفایل کاربر جاری، از آدرس زیر به همراه نام کاربری و رمز عبور و یا توکن (در هدر) در یک درخواست GET استفاده کنید.

http://185.112.33.62/api/v1/rest/my
          

مقدار برگشتی در صورت موفقیت به شکل زیر خواهد بود.

{
  "status": 200,
  "result":
  {
    "status": 0,
    "details":
    {
      "fullname": "..."",
      "company": "...",
      "date": "...",
      "fax": "...",
      "mellicode": "...",
      "shenasname": "...",
      "addr": "...",
      "postcode": "..."
    }
  }
}
          

کلید status اولیه مشخص می‌کند که ادامه‌ی ساختار جیسون برگردانده شده مطابق انتظار یک ساختار پاسخ صحیح است. کلید result مقادیری را مشخص می‌کند که به عنوان پاسخ این وب‌سرویس دریافت کرده‌اید

مقدار result نیز خود حاوی دو کلید است. کلید status که یا صفر است (به معنای معتبر بدون مقدار کلید details) و یا غیر صفر است که خطای پیش آمده در مورد نامعتبر بودن مقدار details را روشن می‌کند. برای اطلاع از خطای پیش آمده مقدار بازگشتی status را با مقادیری که در بخش قبل توضیح داده شد مقایسه کنید.

در صورت عدم موفقیت، پاسخ برگشت داده شده به صورت زیر است

{
  "status": ...,
  "message": "..."
}
          

مقدار status مطابق با استانداردهای http است. به عنوان مثال مقدار ۴۰۴ به معنای عدم یافت شدن منبع است. مقدار message نیز یک توضیح کمکی است.

برای ثبت‌نام کاربر جدید از آدرس زیر در یک درخواست POST با ساختار جیسون اطلاعات ورودی در بدنه‌ی درخواست استفاده کنید.

http://185.112.33.62/api/v1/rest/user/register
{
  "username": "...",
  "password": "...",
  "repeatPassword": "..."
}
          

کلیدهای دیگری نیز وجود دارند که به صورت اختیاری می‌توانید آن‌ها را ارسال کنید. در این صورت یک درخواست کامل به صورت زیر خواهد بود.

{
  "username": "...",
  "password": "...",
  "repeatPassword": "...",  
  "firstName": "...",  
  "lastName": "...",  
  "name": "...",  
  "melliCode": "...",  
  "shShenasname": "...",  
  "postalCode": "...",  
  "phoneNumber": "...",  
  "mobileNumber": "...",  
  "email": "...",  
  "addres": "...",  
  "modir": "...",  
  "package": "...",  
}
          

مقدار برگشتی در صورت موفقیت به شکل زیر خواهد بود.

{
  "status": 200,
  "result": ...
}
          

کلید status اولیه مشخص می‌کند که ادامه‌ی ساختار جیسون برگردانده شده مطابق انتظار یک ساختار پاسخ صحیح است. کلید result مقداری را مشخص می‌کند که به عنوان پاسخ این وب‌سرویس دریافت کرده‌اید

مقدار result یا صفر است (به معنای موفقیت عملیات ساخت کاربر) و یا غیر صفر است که خطای پیش آمده در مورد ساخت کاربر را نشان می‌دهد. برای اطلاع از خطای پیش آمده مقدار بازگشتی status را با مقادیری که در بخش قبل توضیح داده شد مقایسه کنید.

در صورت عدم موفقیت، پاسخ برگشت داده شده به صورت زیر است

{
  "status": ...,
  "message": "..."
}
          

مقدار status مطابق با استانداردهای http است. به عنوان مثال مقدار ۴۰۴ به معنای عدم یافت شدن منبع است. مقدار message نیز یک توضیح کمکی است.

وب‌سرویس‌های ارسال پیامک

برای ارسال پیامک، از آدرس زیر به همراه نام کاربری و رمز عبور و یا توکن (در هدر) در یک درخواست POST استفاده کنید.

http://185.112.33.62/api/v1/rest/sms/send
{
  "from": "...",
  "recipients": [
      "...",
      "..."
  ],
  "message": "...",
  "type": ...
}
          

مقدار برگشتی در صورت موفقیت به شکل زیر خواهد بود.

{
  "status": 200,
  "result":
  {
    "status": ...,
    "id": ...
  }
}
          

کلید status اولیه مشخص می‌کند که ادامه‌ی ساختار جیسون برگردانده شده مطابق انتظار یک ساختار پاسخ صحیح است. کلید result مقادیری را مشخص می‌کند که به عنوان پاسخ این وب‌سرویس دریافت کرده‌اید

مقدار result نیز خود حاوی دو کلید است. کلید status که یا صفر است (به معنای معتبر بدون مقدار کلید id و ارسال موفقیت‌آمیز پیامک) و یا غیر صفر است که خطای پیش آمده در مورد نامعتبر بودن مقدار id را روشن می‌کند. برای اطلاع از خطای پیش آمده مقدار بازگشتی status را با مقادیری که در بخش قبل توضیح داده شد مقایسه کنید.

در صورت عدم موفقیت، پاسخ برگشت داده شده به صورت زیر است

{
  "status": ...,
  "message": "..."
}
          

مقدار status مطابق با استانداردهای http است. به عنوان مثال مقدار ۴۰۴ به معنای عدم یافت شدن منبع است. مقدار message نیز یک توضیح کمکی است.

برای ارسال پیامک برنامه‌ریزی شده در آینده، از آدرس زیر به همراه نام کاربری و رمز عبور و یا توکن (در هدر) در یک درخواست POST استفاده کنید.

http://185.112.33.62/api/v1/rest/sms/future-send
{
  "from": "...",
  "recipients": [
      "...",
      "..."
  ],
  "message": "...",
  "sendDate": "...",
  "prtrys": "...",
  "sentPeriod": "..."
}
          

مقدار برگشتی در صورت موفقیت به شکل زیر خواهد بود.

{
  "status": 200,
  "result":
  {
    "status": ...,
    "id": ...
  }
}
          

کلید status اولیه مشخص می‌کند که ادامه‌ی ساختار جیسون برگردانده شده مطابق انتظار یک ساختار پاسخ صحیح است. کلید result مقادیری را مشخص می‌کند که به عنوان پاسخ این وب‌سرویس دریافت کرده‌اید

مقدار result نیز خود حاوی دو کلید است. کلید status که یا صفر است (به معنای معتبر بدون مقدار کلید id و ارسال موفقیت‌آمیز پیامک) و یا غیر صفر است که خطای پیش آمده در مورد نامعتبر بودن مقدار id را روشن می‌کند. برای اطلاع از خطای پیش آمده مقدار بازگشتی status را با مقادیری که در بخش قبل توضیح داده شد مقایسه کنید.

در صورت عدم موفقیت، پاسخ برگشت داده شده به صورت زیر است

{
  "status": ...,
  "message": "..."
}
          

مقدار status مطابق با استانداردهای http است. به عنوان مثال مقدار ۴۰۴ به معنای عدم یافت شدن منبع است. مقدار message نیز یک توضیح کمکی است.

برای ارسال پیامک بر مبنای الگوی تعریف شده، از آدرس زیر به همراه نام کاربری و رمز عبور و یا توکن (در هدر) در یک درخواست POST استفاده کنید.

http://185.112.33.62/api/v1/rest/sms/pattern-send
{
  "from": "...",
  "recipients": [
      "...",
      "..."
  ],
  "message": {
      "var1": "...",
      "var2": "...",
      ...
  },
  "patternId": ...,
  "type": ...
}
          

مقدار برگشتی در صورت موفقیت به شکل زیر خواهد بود.

{
  "status": 200,
  "result":
  {
    "status": ...,
    "id": ...
  }
}
          

کلید status اولیه مشخص می‌کند که ادامه‌ی ساختار جیسون برگردانده شده مطابق انتظار یک ساختار پاسخ صحیح است. کلید result مقادیری را مشخص می‌کند که به عنوان پاسخ این وب‌سرویس دریافت کرده‌اید

مقدار result نیز خود حاوی دو کلید است. کلید status که یا صفر است (به معنای معتبر بدون مقدار کلید id و ارسال موفقیت‌آمیز پیامک) و یا غیر صفر است که خطای پیش آمده در مورد نامعتبر بودن مقدار id را روشن می‌کند. برای اطلاع از خطای پیش آمده مقدار بازگشتی status را با مقادیری که در بخش قبل توضیح داده شد مقایسه کنید.

در صورت عدم موفقیت، پاسخ برگشت داده شده به صورت زیر است

{
  "status": ...,
  "message": "..."
}
          

مقدار status مطابق با استانداردهای http است. به عنوان مثال مقدار ۴۰۴ به معنای عدم یافت شدن منبع است. مقدار message نیز یک توضیح کمکی است.

برای ارسال پیامک به همه‌ی شماره‌های یک دفترچه تلفن، از آدرس زیر به همراه نام کاربری و رمز عبور و یا توکن (در هدر) در یک درخواست POST استفاده کنید.

http://185.112.33.62/api/v1/rest/sms/phonebook-send
{
  "from": "...",
  "recipients": [
      "...",
      "..."
  ],
  "bookId": ...,
  "message": "...",
  "type": ...
}
          

مقدار برگشتی در صورت موفقیت به شکل زیر خواهد بود.

{
  "status": 200,
  "result":
  {
    "status": ...,
    "id": ...
  }
}
          

کلید status اولیه مشخص می‌کند که ادامه‌ی ساختار جیسون برگردانده شده مطابق انتظار یک ساختار پاسخ صحیح است. کلید result مقادیری را مشخص می‌کند که به عنوان پاسخ این وب‌سرویس دریافت کرده‌اید

مقدار result نیز خود حاوی دو کلید است. کلید status که یا صفر است (به معنای معتبر بدون مقدار کلید id و ارسال موفقیت‌آمیز پیامک) و یا غیر صفر است که خطای پیش آمده در مورد نامعتبر بودن مقدار id را روشن می‌کند. برای اطلاع از خطای پیش آمده مقدار بازگشتی status را با مقادیری که در بخش قبل توضیح داده شد مقایسه کنید.

در صورت عدم موفقیت، پاسخ برگشت داده شده به صورت زیر است

{
  "status": ...,
  "message": "..."
}
          

مقدار status مطابق با استانداردهای http است. به عنوان مثال مقدار ۴۰۴ به معنای عدم یافت شدن منبع است. مقدار message نیز یک توضیح کمکی است.

در صورتی که مایل هستید پیامک‌هایی را برای شماره‌هایی ارسال کنید و متن پیامک‌ها مختلف است می‌توانید از این وب‌سرویس استفاده کنید.
برای ارسال چندین پیامک مختلفه به صورت یکجا، از آدرس زیر به همراه نام کاربری و رمز عبور و یا توکن (در هدر) در یک درخواست POST استفاده کنید.

http://185.112.33.62/api/v1/rest/sms/multiple-send
{
  "fromArray": [ "...", "...", ]
  "recipients": [
    [ "...", "...", ],
    [ "...", "...", ]
  ],
  "messageArray": [ "...", "...", ],
  "typeArray": [ ..., ..., ]
}
          

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

{
  "status": 200,
  "result":
  [
    { "status": ..., "id": ... },
    { "status": ..., "id": ... },
    { "status": ..., "id": ... }
  ]
}
          

کلید status اولیه مشخص می‌کند که ادامه‌ی ساختار جیسون برگردانده شده مطابق انتظار یک ساختار پاسخ صحیح است. کلید result مقادیری را مشخص می‌کند که به عنوان پاسخ این وب‌سرویس دریافت کرده‌اید

مقدار result نیز خود حاوی یک آرایه است که در مولفه‌ی آن دارای دو کلید است. کلید status که یا صفر است (به معنای معتبر بدون مقدار کلید id و ارسال موفقیت‌آمیز پیامک) و یا غیر صفر است که خطای پیش آمده در مورد نامعتبر بودن مقدار id را روشن می‌کند. برای اطلاع از خطای پیش آمده مقدار بازگشتی status را با مقادیری که در بخش قبل توضیح داده شد مقایسه کنید.

در صورت عدم موفقیت، پاسخ برگشت داده شده به صورت زیر است

{
  "status": ...,
  "message": "..."
}
          

مقدار status مطابق با استانداردهای http است. به عنوان مثال مقدار ۴۰۴ به معنای عدم یافت شدن منبع است. مقدار message نیز یک توضیح کمکی است.

وب‌سرویس‌های گزارش گیری

برای دریافت جزییات آخرین پیامک ارسال شده، از آدرس زیر به همراه نام کاربری و رمز عبور و یا توکن (در هدر) در یک درخواست GET استفاده کنید.

http://185.112.33.62/api/v1/rest/sms/latest
          

مقدار برگشتی در صورت موفقیت به شکل زیر خواهد بود.

{
  "status": 200,
  "result":
  {
    "status": ...,
    "details":
    {
      "id": ...,
      "message": "...",
      "recipients": [ ... ],
      "from": "...",
      "state": ...,
      "now": "...",
      "time": "..."
    }
  }
}
          

کلید status اولیه مشخص می‌کند که ادامه‌ی ساختار جیسون برگردانده شده مطابق انتظار یک ساختار پاسخ صحیح است. کلید result مقادیری را مشخص می‌کند که به عنوان پاسخ این وب‌سرویس دریافت کرده‌اید

مقدار result نیز خود حاوی دو کلید است. کلید status که یا صفر است (به معنای معتبر بدون مقدار کلید details) و یا غیر صفر است که خطای پیش آمده در مورد نامعتبر بودن مقدار details را روشن می‌کند. برای اطلاع از خطای پیش آمده مقدار بازگشتی status را با مقادیری که در بخش قبل توضیح داده شد مقایسه کنید.

در صورت عدم موفقیت، پاسخ برگشت داده شده به صورت زیر است

{
  "status": ...,
  "message": "..."
}
          

مقدار status مطابق با استانداردهای http است. به عنوان مثال مقدار ۴۰۴ به معنای عدم یافت شدن منبع است. مقدار message نیز یک توضیح کمکی است.

هنگامی که پیامک توسط وب‌سرویس ارسال می‌کنید، در صورت موفقیت‌آمیز بودن ارسال، یک شناسه به ازای هر پیامک به شما برگردانده می‌شود
برای دریافت وضعیت پیامک ارسال شده، از آدرس زیر به همراه نام کاربری و رمز عبور و یا توکن (در هدر) در یک درخواست GET استفاده کنید.

http://185.112.33.62/api/v1/rest/sms/status
{
  "idArray": [
    ..., ..., ...
  ]
}
          

مقدار برگشتی در صورت موفقیت به شکل زیر خواهد بود.

{
  "status": 200,
  "result":
  {
    "status": ...,
    "result":
    [
      ..., ..., ...
    ]
  }
}
          

کلید status اولیه مشخص می‌کند که ادامه‌ی ساختار جیسون برگردانده شده مطابق انتظار یک ساختار پاسخ صحیح است. کلید result مقادیری را مشخص می‌کند که به عنوان پاسخ این وب‌سرویس دریافت کرده‌اید

مقدار result نیز خود حاوی دو کلید است. کلید status که یا صفر است (به معنای معتبر بدون مقدار کلید result) و یا غیر صفر است که خطای پیش آمده در مورد نامعتبر بودن مقدار result را روشن می‌کند. برای اطلاع از خطای پیش آمده مقدار بازگشتی status را با مقادیری که در بخش قبل توضیح داده شد مقایسه کنید.

در صورت عدم موفقیت، پاسخ برگشت داده شده به صورت زیر است

{
  "status": ...,
  "message": "..."
}
          

مقدار status مطابق با استانداردهای http است. به عنوان مثال مقدار ۴۰۴ به معنای عدم یافت شدن منبع است. مقدار message نیز یک توضیح کمکی است.

وب‌سرویس‌های دفترچه تلفن

برای نمایش همه‌ی دفترچه‌های تلفن کاربر جاری، از آدرس زیر به همراه نام کاربری و رمز عبور و یا توکن (در هدر) در یک درخواست GET استفاده کنید.

http://185.112.33.62/api/v1/rest/my/phonebook
          

مقدار name اختیاری است و در صورتی که ارسال شود، فقط جزئیات مربوط به دفترچه‌ی تلفن با آن نام نشان داده می‌شود. مقدار برگشتی در صورت موفقیت به شکل زیر خواهد بود.

{
  "status": 200,
  "result":
  {
    "status": ...,
    "result":
    [
      "book_id": ...,
      "uname": "...",
      "title": "...",
      "count": ...
    ]
  }
}
          

کلید status اولیه مشخص می‌کند که ادامه‌ی ساختار جیسون برگردانده شده مطابق انتظار یک ساختار پاسخ صحیح است. کلید result مقادیری را مشخص می‌کند که به عنوان پاسخ این وب‌سرویس دریافت کرده‌اید

مقدار result نیز خود حاوی دو کلید است. کلید status که یا صفر است (به معنای معتبر بدون مقدار کلید result) و یا غیر صفر است که خطای پیش آمده در مورد نامعتبر بودن مقدار result را روشن می‌کند. برای اطلاع از خطای پیش آمده مقدار بازگشتی status را با مقادیری که در بخش قبل توضیح داده شد مقایسه کنید.

در صورت عدم موفقیت، پاسخ برگشت داده شده به صورت زیر است

{
  "status": ...,
  "message": "..."
}
          

مقدار status مطابق با استانداردهای http است. به عنوان مثال مقدار ۴۰۴ به معنای عدم یافت شدن منبع است. مقدار message نیز یک توضیح کمکی است.

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

http://185.112.33.62/api/v1/rest/my/phonebook/{name}
          

متغیر {name} نام دفترچه‌ی تلفن را مشخص می‌کند.

{
  "status": 200,
  "result":
  {
    "status": ...,
    "result":
    [
      "book_id": ...,
      "uname": "...",
      "title": "...",
      "count": ...
    ]
  }
}
          

کلید status اولیه مشخص می‌کند که ادامه‌ی ساختار جیسون برگردانده شده مطابق انتظار یک ساختار پاسخ صحیح است. کلید result مقادیری را مشخص می‌کند که به عنوان پاسخ این وب‌سرویس دریافت کرده‌اید

مقدار result نیز خود حاوی دو کلید است. کلید status که یا صفر است (به معنای معتبر بدون مقدار کلید result) و یا غیر صفر است که خطای پیش آمده در مورد نامعتبر بودن مقدار result را روشن می‌کند. برای اطلاع از خطای پیش آمده مقدار بازگشتی status را با مقادیری که در بخش قبل توضیح داده شد مقایسه کنید.

در صورت عدم موفقیت، پاسخ برگشت داده شده به صورت زیر است

{
  "status": ...,
  "message": "..."
}
          

مقدار status مطابق با استانداردهای http است. به عنوان مثال مقدار ۴۰۴ به معنای عدم یافت شدن منبع است. مقدار message نیز یک توضیح کمکی است.

برای ساخت یک دفترچه تلفن جدید برای کاربر جاری، از آدرس زیر به همراه نام کاربری و رمز عبور و یا توکن (در هدر) در یک درخواست POST استفاده کنید.

http://185.112.33.62/api/v1/rest/phonebook
{
  "name": "...",
  "numbers": [ "...", "...", "..." ],
  "flag": "..."
}
          

مقدار برگشتی در صورت موفقیت به شکل زیر خواهد بود.

{
  "status": 200,
  "result":
  {
    "status": ...,
    "id": ...,
  }
}
          

کلید status اولیه مشخص می‌کند که ادامه‌ی ساختار جیسون برگردانده شده مطابق انتظار یک ساختار پاسخ صحیح است. کلید result مقادیری را مشخص می‌کند که به عنوان پاسخ این وب‌سرویس دریافت کرده‌اید

مقدار result نیز خود حاوی دو کلید است. کلید status که یا صفر است (به معنای معتبر بدون مقدار کلید id و ساخته شدن دفترچه تلفن) و یا غیر صفر است که خطای پیش آمده در مورد نامعتبر بودن مقدار id را روشن می‌کند. برای اطلاع از خطای پیش آمده مقدار بازگشتی status را با مقادیری که در بخش قبل توضیح داده شد مقایسه کنید.

در صورت عدم موفقیت، پاسخ برگشت داده شده به صورت زیر است

{
  "status": ...,
  "message": "..."
}
          

مقدار status مطابق با استانداردهای http است. به عنوان مثال مقدار ۴۰۴ به معنای عدم یافت شدن منبع است. مقدار message نیز یک توضیح کمکی است.

برای حذف یک دفترچه تلفن، از آدرس زیر به همراه نام کاربری و رمز عبور و یا توکن (در هدر) در یک درخواست DELETE استفاده کنید.

http://185.112.33.62/api/v1/rest/phonebook/{id}
          

{id} شناسه‌ی دفترچه تلفن است.

مقدار برگشتی در صورت موفقیت به شکل زیر خواهد بود.

{
  "status": 200,
  "result": ...
}
          

کلید status اولیه مشخص می‌کند که ادامه‌ی ساختار جیسون برگردانده شده مطابق انتظار یک ساختار پاسخ صحیح است. کلید result مقادیری را مشخص می‌کند که به عنوان پاسخ این وب‌سرویس دریافت کرده‌اید

مقدار result نیز یا صفر است (به معنای حذف شدن دفترچه تلفن) و یا غیر صفر است که خطای پیش آمده در هنگام انجام عملیات را نشان می‌دهد. برای اطلاع از خطای پیش آمده مقدار بازگشتی status را با مقادیری که در بخش قبل توضیح داده شد مقایسه کنید.

در صورت عدم موفقیت، پاسخ برگشت داده شده به صورت زیر است

{
  "status": ...,
  "message": "..."
}
          

مقدار status مطابق با استانداردهای http است. به عنوان مثال مقدار ۴۰۴ به معنای عدم یافت شدن منبع است. مقدار message نیز یک توضیح کمکی است.

برای دریافت شماره‌های یک دفترچه تلفن، از آدرس زیر به همراه نام کاربری و رمز عبور و یا توکن (در هدر) در یک درخواست GET استفاده کنید.

http://185.112.33.62/api/v1/rest/phonebook/{id}/number
          

{id} شناسه‌ی دفترچه تلفن است.

مقدار برگشتی در صورت موفقیت به شکل زیر خواهد بود.

{
  "status": 200,
  "result":
  [
    "status": ...,
    "result":
    [
      { "number_id": ..., "number": "..." },
      { "number_id": ..., "number": "..." },
      { "number_id": ..., "number": "..." }
    ]
  ]
}
          

کلید status اولیه مشخص می‌کند که ادامه‌ی ساختار جیسون برگردانده شده مطابق انتظار یک ساختار پاسخ صحیح است. کلید result مقادیری را مشخص می‌کند که به عنوان پاسخ این وب‌سرویس دریافت کرده‌اید

مقدار result نیز خود حاوی دو کلید است. کلید status که مشخص می‌کند کلید دوم حاوی داده‌های معتبر یا نامعتبر است. این کلید یا صفر است (به معنای معتبر بودن مقادیر result) و یا غیر صفر است که نامعتبر بودن result و خطای پیش آمده در هنگام انجام عملیات را نشان می‌دهد. برای اطلاع از خطای پیش آمده مقدار بازگشتی status را با مقادیری که در بخش قبل توضیح داده شد مقایسه کنید.

در صورت عدم موفقیت، پاسخ برگشت داده شده به صورت زیر است

{
  "status": ...,
  "message": "..."
}
          

مقدار status مطابق با استانداردهای http است. به عنوان مثال مقدار ۴۰۴ به معنای عدم یافت شدن منبع است. مقدار message نیز یک توضیح کمکی است.

برای درج شماره‌های جدید در یک دفترچه تلفن، از آدرس زیر به همراه نام کاربری و رمز عبور و یا توکن (در هدر) در یک درخواست POST استفاده کنید.

http://185.112.33.62/api/v1/rest/phonebook/{id}/number
{
  "numbers": [ "...", "...", "..." ],
  "flag": "..."
}
          

{id} شناسه‌ی دفترچه تلفن است.

مقدار برگشتی در صورت موفقیت به شکل زیر خواهد بود.

{
  "status": 200,
  "result": ...
}
          

کلید status اولیه مشخص می‌کند که ادامه‌ی ساختار جیسون برگردانده شده مطابق انتظار یک ساختار پاسخ صحیح است. کلید result مقادیری را مشخص می‌کند که به عنوان پاسخ این وب‌سرویس دریافت کرده‌اید

مقدار result یا صفر است (به معنای موفقیت عملیات) و یا غیر صفر است که خطای پیش آمده در هنگام انجام عملیات را نشان می‌دهد. برای اطلاع از خطای پیش آمده مقدار بازگشتی status را با مقادیری که در بخش قبل توضیح داده شد مقایسه کنید.

در صورت عدم موفقیت، پاسخ برگشت داده شده به صورت زیر است

{
  "status": ...,
  "message": "..."
}
          

مقدار status مطابق با استانداردهای http است. به عنوان مثال مقدار ۴۰۴ به معنای عدم یافت شدن منبع است. مقدار message نیز یک توضیح کمکی است.

برای حذف چند شماره‌ از یک دفترچه تلفن، از آدرس زیر به همراه نام کاربری و رمز عبور و یا توکن (در هدر) در یک درخواست DELETE استفاده کنید.

http://185.112.33.62/api/v1/rest/phonebook/{id}/number
{
  "numbers": [ "...", "...", "..." ],
  "flag": "..."
}
          

مقدار برگشتی در صورت موفقیت به شکل زیر خواهد بود.

{
  "status": 200,
  "result": ...
}
          

کلید status اولیه مشخص می‌کند که ادامه‌ی ساختار جیسون برگردانده شده مطابق انتظار یک ساختار پاسخ صحیح است. کلید result مقادیری را مشخص می‌کند که به عنوان پاسخ این وب‌سرویس دریافت کرده‌اید

مقدار result یا صفر است (به معنای موفقیت عملیات) و یا غیر صفر است که خطای پیش آمده در هنگام انجام عملیات را نشان می‌دهد. برای اطلاع از خطای پیش آمده مقدار بازگشتی status را با مقادیری که در بخش قبل توضیح داده شد مقایسه کنید.

در صورت عدم موفقیت، پاسخ برگشت داده شده به صورت زیر است

{
  "status": ...,
  "message": "..."
}
          

مقدار status مطابق با استانداردهای http است. به عنوان مثال مقدار ۴۰۴ به معنای عدم یافت شدن منبع است. مقدار message نیز یک توضیح کمکی است.

نمونه کدها