پرش به محتویات

ارسال پیام در بله

آدرس سرویس: POST https:/carbon/v4.0/messaging_service/bale/notify_message


شرح

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


Headers

مقادیر زیر باید در هدر قرار بگیرد

  Authorization : Bearer {Token}
  clientAddress : client IP

توجه : برای دریافت توکن مربوطه به بخش سرویس توکن مراجعه فرمایید

توضیحات

  • Authorization : در این قسمت توکن دریافت شده از سرویس توکن را وارد نمایید
  • clientAddress : آی پی مشتری نهایی که سرویس را دریافت کرده است .

Parameters

  • request_number (نوع داده عددی) : (اجباری) این شناسه جهت پیگیری های بعدی مورد استفاده قرار می گیرد و پیشنهاد میگردد یه شناسه یکتا به ازای هر درخواست توسط سامانه مشتری تولید و به این سرویس ارسال گردد. سامانه ابری کربن هیچ کنترلی بر روی عدم تکراری بودن این مقدار انجام نمی دهد.

  • message (نوع داده رشته) : (اجباری) پیام جهت ارسال

  • destination (نوع داده عددی) : (اجباری) آیدی گروهی که پیام ارسال می شود

نمونه درخواست:

curl --location --request POST 'https:/carbon/v4.0/messaging_service/bale/notify_message'\
--header 'Authorization: Bearer ....' \
--header 'Content-Type: application/json' \
--data-raw '{
    "request_number": ....,
    "message": "....",
    "destination": "...."
}'

جواب موفق:

{
    "status":"0",
    "message":"تراکنش با موفقیت انجام شد",
    "timestamp":"2026-02-04 23:52:14.868",
    "tracking_number":"926401188",
    "request_number":"202602042351",
    "result":{ 
        "message_status":"true"
    },
    "transaction_details": {
        "available_wallet_balance":"....",
        "provider_name":"Pertikan",
        "service_price":"....",
        "curency":"IRR",
        "remaining_number_of_calls":"85",
        "remaining_number_of_calls_day":"85"
    },
    "errors":{}
}

جواب ناموفق:

{
    "status": "1",
    "message": "تراکنش ناموفق",
    "timestamp": "2026-01-12 15:58:42.364",
    "tracking_number": "875153592",
    "request_number": "2025123452026",
    "result": {},
    "transaction_details": {},
    "errors": {
        "error_code": "5002",
        "error_description": "Transaction failed : Provider  Error",
        "reference_name": "47_",
        "original_value": ""
    }
}
  • status: عدد 0 به معنی موفق و عدد 1 به معنی ناموفق می باشد
  • message: پاسخ از طرف سرویس سامانه ابری کربن
  • timestamp: زمان و تاریخ درخواست
  • request_number: شماره پیگیری ارسال شده در زمان فراخوانی
  • tracking_number: شماره پیگیری ایجاد شده توسط سامانه ابری کربن جهت بررسی های بعدی
  • result: آبجکتی از پاسخ سرویس شامل:
  • message_status : وضعیت پیام
  • در صورت بروز خطا در درخواست :

  • errors: جزییات خطا
  • error_code: کد مربوط به خطایی که پیش آمده است
  • error_description: متن خطا
  • reference_name: اطلاعات تکمیلی خطا
  • original_value: اطلاعات تکمیلی خطا