Skip to main content

Xem hiệu quả gửi tin nhắn

MoMo BP cũng cung cấp cho Doanh nghiệp báo cáo thông tin lịch sử và mức độ hiệu quả của các chương trình chăm sóc để Đối tác có thể điều chỉnh lại chiến dịch, đối tượng tập khách hàng mục tiêu và thời điểm chăm sóc để tối ưu hiệu quả.

HTTP Request:

POST /v1/business-pages/{id}/chat/messages/report


Example Request

curl --location 'https://test-business.momo.vn/api/v1/business-pages/{id}/chat/messages/report' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}' \
--data '{
"oa_id": "130035",
"report_time_range": "DAY_AGO_60",
"limit": 90,
"target_created_at": 0,
"filter": {
"filter_type": "CONDITION",
"condition_id": "FOLLOW_NO_PAYMENT"
}
}

Header:

Tham sốKiểuBắt buộcMô tả
AuthorizationStringAuthorization: Bearer {{token}}
Với token lấy từ Xác thực và uỷ quyền truy cập tài nguyên BP

Query Path:

Tham sốKiểuBắt buộcMô tả
idNumberBusiness Page ID

Request Body:

Tham sốKiểuBắt buộcMô tả
report_time_rangeStringĐiều kiện filter tin nhắn theo thời gian:
- DAY_AGO_30 : Tin nhắn 30 ngày gần nhất
- DAY_AGO_60 : Tin nhắn 60 ngày gần nhất
- DAY_AGO_90 : Tin nhắn 90 ngày gần nhất
- ALL : Toàn bộ tin nhắn trong 1 năm gần nhất
oa_idStringBusiness Page ID
target_created_atNumberMặc định (target_created_at=0) API sẽ chỉ trả về danh sách max 20 tin nhắn được tạo mới nhất. Để lấy các tin nhắn cũ hơn, khai báo target_created_at, API sẽ trả về list index cũ hơn target_created_at
limitNumberSố lượng tin nhắn trả về trong 1 request. Mặc định 20.
filterObject JsonĐiều kiện filter tin nhắn khác

Thuộc tính filter của Request:

Tham sốKiểuBắt buộcMô tả
filter_typeStringLoại filter:
- CONDITION
condition_idStringĐiều kiện tệp khách hàng để gửi tin nhắn, tham khảo Lấy thông tin Tập khách hàng :
- PAYMENT_NO_FOLLOW : Tổng số user payment trong 90 ngày nhưng chưa follow
- FOLLOW_NO_PAYMENT : Tổng số user Follower nhưng chưa có giao dịch nào trong 90 ngày
- NO_ACTIVITIES_14 : Tổng số khách hàng lâu rồi chưa quay lại trong 7-14
- NO_ACTIVITIES_30 : Tổng số khách hàng lâu rồi chưa quay lại trong 14-30
- NO_ACTIVITIES_90 : Tổng số khách hàng lâu rồi chưa quay lại trong 30-90

Example Response:

{
"json": {
"oa_id": "130035",
"range": 60,
"date_time_unit": "DAY",
"filter_type": "CONDITION",
"data": [
{
"segment_id": "1327",
"campaign_id": "1701059872524",
"segment_size": 5,
"template_data": "{\"chatMessage\":{\"messageType\":\"ENGAGEMENT_CARD\",\"title\":\"Mời bạn ghé quán với ưu đãi đặc biệt\",\"content\":\"Nhiều chương trình ưu đãi hấp dẫn đang chờ bạn, ghé Trà sữa Bảo Quân xem và thu thập ngay thôi!\",\"url\":\"https://attachment-dev.momocdn.net/social/u/ccf6bc8723a0cfe2324c44a04027bff8056ccdb26eb616294ef66e48a65ebdea/003ba05e-ac4d-46ad-a491-c6fee491ad82j0wc3yxf.jpg\",\"button1Title\":\"Xem thêm\",\"button1Type\":\"REDIRECT\",\"button1Endpoint\":\"official_account\",\"button1Params\":{\"oaId\":\"130035\",\"oaName\":\"Trà sữa Bảo Quân\",\"campaignId\":null,\"isAutoRedirect\":null,\"redirectScreen\":{\"refId\":null,\"params\":null,\"giftType\":null,\"campaignId\":null,\"type_\":4,\"source\":\"official_account\"}},\"messageActionType\":\"REDIRECT\",\"messageActionEndpoint\":\"official_account\",\"messageActionParams\":{\"oaId\":\"130035\",\"oaName\":\"Trà sữa Bảo Quân\",\"campaignId\":null,\"isAutoRedirect\":\"0\",\"redirectScreen\":{\"refId\":null,\"params\":null,\"giftType\":null,\"campaignId\":null,\"type_\":4,\"source\":\"official_account\"}}}}",
"segment_status": "SEGMENT_COMPLETE",
"condition_id": "FOLLOW_NO_PAYMENT",
"create_at": 1701059874844,
"reports": {
"SENDING": 5,
"FAILED": 0,
"SENT": 5,
"RECEIVED": 0,
"READ": 0,
"CLICKED": 0
}
}
]
},
"success": true
}

Cấu trúc Response:

Tham sốKiểuMô tả
jsonObject JsonData trả về
successBooleanThành công hay thất bại

Thuộc tính json của Response:

Tham sốKiểuMô tả
oa_idStringBusiness Page Id
rangeNumberKhỏang thời gian
date_time_unitStringĐơn vị khoảng thời gian:
- DAY : ngày
filter_typeStringLoại filter:
- CONDITION
dataList Object JsonData báo cáo tin nhắn

Thuộc tính data của json:

Tham sốKiểuMô tả
template_dataStringString json nội dung tin nhắn
create_atNumberTimestamp thời gian tạo tin nhắn, dùng để lấy các tin nhắn cũ hơn trong request tiếp theo
reportsObject JsonCác thông số của tin nhắn đã gửi

Thuộc tính reports của data:

Tham sốKiểuMô tả
SENDINGNumberSố lượng tin nhắn đang gửi đi
FAILEDNumberSố lượng tin nhắn gửi đi thất bại
SENTNumberSố lượng tin nhắn đã gửi thành công
RECEIVEDNumberSố lượng tin nhắn đã đuợc khách hàng nhận
READNumberSố lượng tin nhắn đã đuợc khách hàng đọc
CLICKEDNumberSố lượng tin nhắn đã đuợc khách hàng click tương tác