Gửi Facebook Marketing Message

  • Tài liệu đang được cập nhật, xin vui lòng thử lại sau.

  • API này dùng để tạo chiến dịch gửi Facebook Marketing Message. Để gửi được tin, bạn cần bắt đầu bằng việc:

  • Chú ý:

    • Facebook giới hạn mỗi user chỉ được nhận 1 tin nhắn quảng cáo trong vòng 12h, nếu bạn vi phạm quy định này, page của bạn có thể sẽ bị khóa tính năng gửi Marketing Message.

    • Vpage sẽ tự động chặn việc bạn gửi spam quá nhiều bằng cách loại trừ các user token đã nhận được tin trong vòng 12h gần nhất. Cơ chế này chỉ hoạt động được khi bạn chỉ sử dụng Vpage để gửi tin, nếu bạn dùng thêm 1 app khác, Vpage không thể đảm bảo được việc này.

Request

curl --location 'https://vpage.open.nhanh.vn/v3.0/marketing/fmmcampaigncreate?appId={{appId}}&businessId={{businessId}}' \
--header 'Authorization: {{accessToken}}' \
--data '{
  "campaign": {
    "pageId": "page id",
    "adAccountId": "act_987654321",
    "segmentIds": [],
    "name": "fmm message",
    "budget": 200000,
    "budgetType": "daily",
    "adStartAt": 1761294919,
    "adEndAt": 1761813319,
    "type": "creative"
  },
  "settings": {
    "noResendWithinDays": 1,
    "excludes": {
      "topicsIds": [],
      "audienceIds": [],
      "campaignIds": []
    }
  },
  "message": {
    "greeting": "welcome",
    "attachments": [
      {
        "name": "Welcome!",
        "url": "https://abc.jpg",
        "description": "We have the right hat for everyone.",
        "link": "https://vpage.nhanh.vn",
        "buttons": [
          {
            "type": "URL",
            "url": "https://vpage.nhanh.vn",
            "text": "View Website"
          },
          {
            "type": "SCRIPT",
            "text": "Start Chatting",
            "blockId": "",
            "botId": ""
          }
        ]
      }
    ]
  }
}'

campaign

Key
Type
Description

pageId

string

ID của Trang (Page) Facebook sẽ dùng để gửi tin nhắn.

adAccountId

string

ID của Tài khoản Quảng cáo (Ad Account ID) liên kết. (Format: act_...)

name

string

Tên của chiến dịch

type

string

Loại tin nhắn gửi đi: creative: Gửi loại creative. template: Gửi loại template.

budget

number

Ngân sách cho chiến dịch (theo budgetType)

budgetType

string

Loại ngân sách áp dụng: life_time: Ngân sách toàn chiến dịch. daily: Ngân sách mỗi ngày

adStartAt

number

Thời gian bắt đầu chiến dịch (Unix Timestamp)

adEndAt

number

Thời gian kết thúc chiến dịch (Unix Timestamp)

settings

Key
Type
Description

noResendWithinDays

number

Không gửi cho khách đã nhận tin trong vòng x ngày gần nhất

excludes.topicsIds

array

Không gửi cho khách đã đăng ký Chủ đề (Topic)

excludes.audienceIds

array

Không gửi cho khách trong các tệp đối tượng tuỳ chỉnh (Custom Audience)

excludes.campaignIds

array

Không gửi cho khách đã gửi trong chiến dịch

message

Key
Optional
Type
Description

greeting

optional

string

(Chỉ áp dụng cho campaign.type: creative) Lời chào mở đầu. Giới hạn 160 kí tự

attachments

required

array

Mảng chứa một hoặc nhiều phần tử tin nhắn. Giới hạn tối đa là 10 phần tử.

name

required

string

Tiêu đề của card tin nhắn Giới hạn 80 kí tự

url

required

string

URL của hình ảnh hiển thị trên card. Bắt buộc phải là HTTPS. Giới hạn 120 kí tự

description

optional

string

Nội dung/Phụ đề của card. Hiển thị dưới tiêu đề. creative: Giới hạn 640 kí tự template: Giới hạn 80 kí tự

link

optional

string

URL mặc định được mở khi người dùng nhấp vào bất kỳ đâu trên card (trừ nút bấm)

buttons

optional

array

Mảng chứa các nút bấm tương tác (CTA) cho card này. Tối đa 3 nút/card

buttons

Key
Type
Description

type

string

Loại hành động của nút "URL" hoặc "SCRIPT"

text

string

Văn bản hiển thị trên nút bấm

url

string

(Chỉ áp dụng cho type: URL) URL sẽ được mở khi người dùng nhấp vào nút.

botId

string

(Chỉ áp dụng cho type: SCRIPT) ID của Chatbot

blockId

string

(Chỉ áp dụng cho type: SCRIPT) ID Kịch bản của Chatbot sẽ được kích hoạt khi người dùng nhấp vào nút.

Response

Failed response

  • Xem các mã lỗi chung tại đây.

  • Danh sách errorCode của riêng API này:

errorCode
Description

ERR_FMM_INVALID_EXCLUSE_SEGMENT_IDS

Sai điều kiện loại trừ tệp. VD bạn đang chọn gửi tin cho tệp A, nhưng lại chọn loại trừ chính tệp A này

Successful response

{
  "code": 1,
  "data": {
      "campaignId": "(string) Id of Facebook Marketing Message campaign",
  }
}

Last updated