پرش به مطلب اصلی

وب‌هوک منشی پیامکی

اگر در تنظیمات منشی پیامکی، گزینه‌ی وب‌هوک را فعال و آدرس خود را وارد کنید، هر بار که پیامی برای خط منشی برسد، سامانه آن را به آدرس شما ارسال می‌کند. نحوه‌ی ساخت منشی و محرک‌ها در منشی و پیام‌های دریافتی توضیح داده شده است. این وب‌هوک آدرس عمومی ندارد؛ شما سروری می‌سازید که درخواست را دریافت کند.

ویژگی‌های درخواست​

موردمقدار
متدPOST
نوع بدنهapplication/json
نام‌گذاری فیلدهاcamelCase؛ فیلدهای null در بدنه نمی‌آیند
احراز هویتندارد (بدون امضا)
تلاش مجددندارد؛ در صورت شکست فقط ثبت (log) می‌شود

چون درخواست امضا ندارد، آدرس وب‌هوک را غیرقابل‌حدس انتخاب کنید (مثلاً شامل یک توکن تصادفی) و ورودی را اعتبارسنجی کنید. پاسخ سرور شما نادیده گرفته می‌شود، ولی بهتر است سریع 200 برگردانید.

بدنه​

فیلدنوعتوضیح
toLineرشتهخط منشی که پیام به آن رسیده است
handledByرشتهآیدی پاسخ‌دهنده
handlerNameرشتهنام منشی یا پاسخ‌دهنده
sourceProviderرشتهنام ارائه‌دهنده‌ی دریافت پیام
campaignRefرشتهشناسه‌ی کمپین مرتبط، اگر وجود داشته باشد
messagesآرایهپیام‌های دریافتی
messages[].messageIdرشتهشناسه‌ی پیام
messages[].messageBodyرشتهمتن پیام
messages[].fromرشتهشماره‌ی فرستنده
messages[].sentAtUtcتاریخزمان ارسال توسط فرستنده (UTC)
messages[].receivedAtUtcتاریخزمان دریافت در سامانه (UTC)
messages[].repliedAtUtcتاریخزمان پاسخ؛ فقط اگر پاسخی ارسال شده باشد

نمونه‌ی بدنه​

{
"toLine": "YOUR_LINE_NUMBER",
"handledBy": "Secretary",
"handlerName": "منشی فروش",
"sourceProvider": "PROVIDER_NAME",
"campaignRef": null,
"messages": [
{
"messageId": "665f0c2e9b1d4a0012ab34e1",
"messageBody": "اطلاعات بیشتر",
"from": "989120000000",
"sentAtUtc": "2026-11-19T07:30:00.0000000Z",
"receivedAtUtc": "2026-11-19T07:30:02.0000000Z"
}
]
}

نمونه‌ی سرور دریافت‌کننده​

var app = WebApplication.Create();

app.MapPost("/payava/secretary/YOUR_RANDOM_TOKEN", async (HttpRequest req) =>
{
using var doc = await System.Text.Json.JsonDocument.ParseAsync(req.Body);
foreach (var m in doc.RootElement.GetProperty("messages").EnumerateArray())
{
var from = m.GetProperty("from").GetString();
var body = m.GetProperty("messageBody").GetString();
Console.WriteLine($"{from}: {body}");
}
return Results.Ok();
});

app.Run();