پنل جدید

پنل جدید وال مسیج

وال‌مسیج Whatsapp Web Service

آموزش اولیه پنل جدید وال‌مسیج

Play Video

امکانات پنل جدید

استفاده از Rest API

از این ابزار می‌توانید استفاده کنید تا این سیستم را با برنامه‌های دیگر ادغام نمایید.

ارسال پیام نبوه

پیام انبوه WA انتشار تعداد زیادی پیام برای تحویل به نرم افزار WASender است. این توسط شرکت های رسانه…

پیام‌های زمان‌بندی شده

کاربران واتس‌اپ می‌توانند برای برنامه‌ریزی و ارسال متن، عکس یا ویدیو، پست‌ها را در برنامه زمان‌بندی…

بات پاسخ خودکار

اگر به دنبال نحوه تنظیم پاسخ خودکار در واتس‌اپ بیزنس و نمونه پیام پاسخ خودکار واتس‌اپ هستید، جای منا…

ایجاد دکمه های اکشن

واتس‌اپ به شما امکان می دهد دکمه هایی را به قالب های پیام اضافه کنید. دو نوع دکمه وجود دارد: پاسخ ها…

الگو ارسال پیام

کمپین های چند مرحله ای را تنها با چند کلیک ایجاد و کمپین های خود را با الگوهای از پیش ساخته شده برنا…

مستندات API واتس‌اپ

این مستند شامل توضیحات کامل مربوط به API پنل جدید است. این API برای ارسال پیام‌های متنی، پیام‌های متنی با فایل پیوست، و پیام‌های قالبی طراحی شده است.

احراز هویت

برای استفاده از API، احراز هویت باید از طریق هدرهای درخواست صورت گیرد:

app_key: کلید برنامه که توسط سرور صادر می‌شود.
auth_key: کلید احراز هویت که توسط سرور صادر می‌شود.

برای دریافت app_key و auth_key وارد پنل کاربری خود شوید.

به بخش برنامه‌های من بروید.
برنامه مورد نظر خود را انتخاب کنید.
روی دکمه یکپارچه‌سازی کلیک کنید.
در بخش curl، اطلاعات app_key و auth_key را مشاهده کنید.

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

نقاط پایانی (Endpoints)

ارسال پیام متنی

آدرس: POST https://bulksend.wallmessage.com/api/create-message

هدرها:

				
					app_key: example-app-key
auth_key: example-auth-key

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

				
					{
    "to": "+989123456789",
    "message": "Hello, World!"
}

توجه: شماره تلفن دریافت کننده باید با کد کشور شروع شود، مثلا +98 برای ایران.
پاسخ موفقیت‌آمیز:

				
					{
    "message_status": "Success",
    "data": {
        "from": "SENDER_NUMBER",
        "to": "RECEIVER_NUMBER",
        "status_code": 200
    }
}

پاسخ خطا (مثال):

				
					{
    "message_status": "Failure",
    "error": "Invalid authentication keys"
}

ارسال پیام متنی با فایل پیوست

آدرس: POST https://bulksend.wallmessage.com/api/send-message-with-attachment

هدرها:

				
					app_key: example-app-key
auth_key: example-auth-key

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

				
					{
    "to": "+989123456789",
    "message": "Hello, World!",
    "file_url": "http://example.com/file.pdf"
}

توجه: آدرس فایل باید به گونه‌ای باشد که فایل در سرور شما آپلود شده و به صورت مستقیم قابل دسترسی باشد.

پاسخ موفقیت‌آمیز:

				
					{
    "message_status": "Success",
    "data": {
        "from": "SENDER_NUMBER",
        "to": "RECEIVER_NUMBER",
        "status_code": 200,
        "file_status": "Uploaded"
    }
}

پاسخ خطا (مثال):

				
					{
    "message_status": "Failure",
    "error": "File not found"
}

ارسال پیام قالبی با جایگزینی متغیرها

آدرس:POST https://bulksend.wallmessage.com/api/send-template-message

هدرها:

				
					app_key: example-app-key
auth_key: example-auth-key

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

				
					{
    "to": "+989123456789",
    "template_id": "TEMPLATE_ID",
    "variables": {
        "var1": "value1",
        "var2": "value2"
    }
}

توجه: ابتدا باید وارد پنل کاربری خود شوید و قالب (template) مورد نظر خود را بسازید. برای مشاهده کد الگو کافی است در پنل کاربری الگو را انتخاب کرده و در منوی عملیات، گزینه مشاهده کد الگو را انتخاب کنید.

پاسخ موفقیت‌آمیز:

				
					{
    "message_status": "Success",
    "data": {
        "from": "SENDER_NUMBER",
        "to": "RECEIVER_NUMBER",
        "status_code": 200
    }
}

پاسخ خطا (مثال):

				
					{
    "message_status": "Failure",
    "error": "Template not found"
}

وضعیت‌های خطا

API می‌تواند وضعیت‌های خطای مختلفی را بازگرداند. در زیر نمونه‌هایی از این وضعیت‌ها آمده است:

401 Unauthorized:

				
					{
    "message_status": "Failure",
    "error": "Invalid authentication keys"
}

400 Bad Request:

				
					{
    "message_status": "Failure",
    "error": "Invalid request parameters"
}

500 Internal Server Error:

				
					{
    "message_status": "Failure",
    "error": "An unexpected error occurred"
}

مثال‌ها

ارسال پیام متنی

درخواست:

				
					curl -X POST "https://maint.wallmessage.com/api/create-message" \
-H "app_key: example-app-key" \
-H "auth_key: example-auth-key" \
-H "Content-Type: application/json" \
-d '{
    "to": "+989123456789",
    "message": "Hello, World!"
}'

پاسخ:

				
					{
    "message_status": "Success",
    "data": {
        "from": "SENDER_NUMBER",
        "to": "RECEIVER_NUMBER",
        "status_code": 200
    }
}

ارسال پیام متنی با فایل پیوست

درخواست:

ارسال پیام متنی با فایل پیوست

درخواست:

				
					curl -X POST "https://maint.wallmessage.com/api/send-message-with-attachment" \
-H "app_key: example-app-key" \
-H "auth_key: example-auth-key" \
-H "Content-Type: application/json" \
-d '{
    "to": "+989123456789",
    "message": "Hello, World!",
    "file_url": "http://example.com/file.pdf"
}'

پاسخ:

				
					{
    "message_status": "Success",
    "data": {
        "from": "SENDER_NUMBER",
        "to": "RECEIVER_NUMBER",
        "status_code": 200,
        "file_status": "Uploaded"
    }
}

ارسال پیام قالبی با جایگزینی متغیرها

درخواست:

				
					curl -X POST "https://maint.wallmessage.com/api/send-template-message" \
-H "app_key: example-app-key" \
-H "auth_key: example-auth-key" \
-H "Content-Type: application/json" \
-d '{
    "to": "+989123456789",
    "template_id": "TEMPLATE_ID",
    "variables": {
        "var1": "value1",
        "var2": "value2"
    }
}'

پاسخ:

				
					{
    "message_status": "Success",
    "data": {
        "from": "SENDER_NUMBER",
        "to": "RECEIVER_NUMBER",
        "status_code": 200
    }
}

مثال‌های کد در زبان‌های مختلف – C#

ارسال پیام متنی:

				
					using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        var client = new HttpClient();
        client.DefaultRequestHeaders.Add("app_key", "example-app-key");
        client.DefaultRequestHeaders.Add("auth_key", "example-auth-key");

        var content = new StringContent(
            "{\"to\": \"+989123456789\", \"message\": \"Hello, World!\"}",
            Encoding.UTF8,
            "application/json");

        var response = await client.PostAsync("https://maint.wallmessage.com/api/create-message", content);
        var responseString = await response.Content.ReadAsStringAsync();

        Console.WriteLine(responseString);
    }
}

ارسال پیام متنی با فایل پیوست:

				
					using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        var client = new HttpClient();
        client.DefaultRequestHeaders.Add("app_key", "example-app-key");
        client.DefaultRequestHeaders.Add("auth_key", "example-auth-key");

        var content = new StringContent(
            "{\"to\": \"+989123456789\", \"message\": \"Hello, World!\", \"file_url\": \"http://example.com/file.pdf\"}",
            Encoding.UTF8,
            "application/json");

        var response = await client.PostAsync("https://maint.wallmessage.com/api/send-message-with-attachment", content);
        var responseString = await response.Content.ReadAsStringAsync();

        Console.WriteLine(responseString);
    }
}

ارسال پیام قالبی با جایگزینی متغیرها:

				
					using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        var client = new HttpClient();
        client.DefaultRequestHeaders.Add("app_key", "example-app-key");
        client.DefaultRequestHeaders.Add("auth_key", "example-auth-key");

        var content = new StringContent(
            "{\"to\": \"+989123456789\", \"template_id\": \"TEMPLATE_ID\", \"variables\": {\"var1\": \"value1\", \"var2\": \"value2\"}}",
            Encoding.UTF8,
            "application/json");

        var response = await client.PostAsync("https://maint.wallmessage.com/api/send-template-message", content);
        var responseString = await response.Content.ReadAsStringAsync();

        Console.WriteLine(responseString);
    }
}