Broadcast bài viết

Broadcast là chức năng cho phép OA gửi thông báo miễn phí đến người quan tâm. Mỗi lượt broadcast có thể bao gồm tối đa 5 bài viết (article) đi kèm. Nhóm người nhận broadcast có thể được phân loại tùy theo nhu cầu gửi thông báo, bao gồm giới tính, độ tuổi, vị trí địa lý và nền tảng di động của thiết bị.

Để gửi broadcast, bạn cần chuẩn bị trước các nội dung bài viết cần gửi. Xem thêm về cách upload bài viết với Article API tại đây.

Quyền cần có:

  • Quyền gửi tin và thông báo qua OA để sử dụng API broadcast

  • Quyền quản lý bài viết để sử dụng Article API

Lưu ý: Nội dung broadcast sẽ cần được kiểm duyệt (mất khoảng 30 phút) trước khi gửi đến người dùng. Các tin broadcast sau khi được duyệt sẽ được đưa vào hàng đợi và được gửi đi theo thứ tự thời gian gửi.

HTTP request

URL: https://zns.api.gobysend.com/api/follower/message/broadcast Method: POST Content Type: application/json Response Type: text/json

Example request

curl
-X POST
-H "Content-Type: application/json" -d '{
  "recipient": {
    "target": {
      "gender": "0",
      "cities": "4"
    }
  },
  "message": {
    "attachment": {
      "type": "template",
      "payload": {
        "template_type": "media",
        "elements": [
          {
            "media_type": "article",
            "attachment_id": "bd5ea46bb32e5a0033f"
          }
        ]
      }
    }
  }
}' "https://zns.api.gobysend.com/api/follower/message/broadcast"

Tham số header

Tham số

Kiểu dữ liệu

Tính bắt buộc

Mô tả

access_token

string

yes

Token cho phép ứng dụng đại diện OA gọi API. Xem chi tiết cách lấy access token tại đây.

Cấu trúc body của request

Tham số

Kiểu dữ liệu

Tính bắt buộc

Mô tả

recipient

object

yes

Thông tin người nhận

message

object

yes

Nội dung và các attachment cần gửi

Cấu trúc thuộc tính recipient.target

Tham số

Kiểu dữ liệu

Tính bắt buộc

Mô tả

ages

string

Optional

Danh sách các nhóm tuổi sẽ nhận thông báo. Các giá trị phân tách nhau bởi dấu “,”

Các giá trị nhận vào:

  • 0: Tuổi từ 0-12

  • 1: Tuổi từ 13-17

  • 2: Tuổi từ 18-24

  • 3: Tuổi từ 25-34

  • 4: Tuổi từ 35-44

  • 5: Tuổi từ 45-54

  • 6: Tuổi từ 55-64

  • 7: Tuổi lớn hơn hay bằng 65

gender

string

Optional

Danh sách nhóm giới tính sẽ nhận thông báo. Các giá trị phân tách nhau bởi dấu “,”

Các giá trị nhận vào:

  • 0: Tất cả các giới tính

  • 1: Nam

  • 2: Nữ

locations

string

Optional

Danh sách các địa điểm sẽ nhận thông báo. Các giá trị phân tách nhau bởi dấu “,”

Các giá trị nhận vào:

  • 0: Miền Bắc Việt Nam

  • 1: Miền Trung Việt Nam

  • 2: Miền Nam Việt Nam

cities

string

Optional

Danh sách các tỉnh, thành phố sẽ nhận thông báo. Các giá trị phân tách nhau bởi dấu “,”

Các giá trị nhận vào: Xem bảng recipient.target.cities bên dưới.

Lưu ý: nếu được thiết lập, thuộc tính này sẽ thay thế thuộc tính “locations” ở trên.

platform

string

Optional

Danh sách các hệ điều hành di động sẽ nhận thông báo. Các giá trị phân tách nhau bởi dấu “,”

Các giá trị nhận vào:

  • 1: IOS

  • 2: Android

  • 3: Window Phone

Các giá trị của thuộc tính recipient.target.cities

Tên tỉnh, thành phố
Giá trị

Đồng Tháp

0

Bình Phước

1

Ninh Bình

2

Bạc Liêu

3

Hồ Chí Minh

4

Vĩnh Long

5

Lâm Đồng

6

Yên Bái

7

Hà Nam

8

Hà Nội

9

Hải Dương

10

Hậu Giang

11

An Giang

12

Trà Vinh

13

Tiền Giang

14

Tây Ninh

15

Đồng Nai

16

Đắk Lắk

17

Bình Định

18

Kon Tum

19

Đà Nẵng

20

Bắc Giang

21

Bắc Kạn

22

Điện Biên

23

Hòa Bình

24

Thái Bình

25

Vĩnh Phúc

26

Hà Giang

27

Kiên Giang

28

Bình Dương

29

Bình Thuận

30

Đắk Nông

31

Khánh Hòa

32

Gia Lai

33

Quảng Nam

34

Quảng Trị

35

Hà Tĩnh

36

Hưng Yên

37

Quảng Ninh

38

Thanh Hóa

39

Phú Thọ

40

Lai Châu

41

Thái Nguyên

42

Cao Bằng

43

Cà Mau

44

Cần Thơ

45

Sóc Trăng

46

Bến Tre

47

Long An

48

Bà Rịa Vũng Tàu

49

Ninh Thuận

50

Phú Yên

51

Quãng Ngãi

52

Thừa Thiên Huế

53

Quảng Bình

54

Nghệ An

55

Nam Định

56

Hải Phòng

57

Lạng Sơn

58

Lào Cai

59

Sơn La

60

Bắc Ninh

61

Tuyên Quang

62

Không Thuộc VN

63

Cấu trúc thuộc tính message.attachment

Tham số

Loại

Tính bắt buộc

Mô tả

type

string

yes

Loại attachment.

Giá trị nhận vào bắt buộc:

  • <type> = template

payload

object

yes

Chứa payload của attachment muốn gửi. Xem cấu trúc payload tại mục bên dưới.

Cấu trúc thuộc tính message.attachment.payload

Tham số

Loại

Tính bắt buộc

Mô tả

template_type

string

yes

Loại template.

Giá trị nhận vào bắt buộc:

  • <template_type> = media

elements

array

yes

Chứa các đối tượng của template.

Cấu trúc thuộc tính message.attachment.payload.element

Tham số

Loại

Tính bắt buộc

Mô tả

media_type

string

yes

Loại media

Giá trị nhận vào bắt buộc:

  • <media_type> = article

attachment_id

string

yes

ID của bài viết bạn muốn broadcast.

Example respond

{
  "data": {
    "msg_id": "ec1cf390d7d53e8b67c4"
  },
  "error": 0,
  "message": "Success"
}

Cấu trúc thuộc tính data

Thuộc tính

Kiểu dữ liệu

Mô tả

msg_id

string

ID của tin broadcast

English version:

Broadcast is a function that allows OA to send free announcements to followers. Each broadcast can include up to 5 posts (articles). Broadcast groups can be categorized depending on the need to send notifications, including gender, age, geographic location, and mobile platform of their device.

To send broadcast, you'll need to prepare for posts that want to send. See more about uploading posts with the article API.

Required permissions:

  • OA message and announcement permission to use broadcast API

  • Article management permission to use Article API

Note: Broadcast content will need to be moderated (about 30 minutes) before being sent to users. After being approved, broadcasts will be queued and sent in the order of sending time.

HTTP request

URL: https://zns.api.gobysend.com/api/follower/message/broadcast Method: POST Content Type: application/json Response Type: text/json

Example request

curl
-X POST
-H "Content-Type: application/json" -d '{
  "recipient": {
    "target": {
      "gender": "0",
      "cities": "4"
    }
  },
  "message": {
    "attachment": {
      "type": "template",
      "payload": {
        "template_type": "media",
        "elements": [
          {
            "media_type": "article",
            "attachment_id": "bd5ea46bb32e5a0033f"
          }
        ]
      }
    }
  }
}' "https://zns.api.gobysend.com/api/follower/message/broadcast"

Header param

Param

Data type

Compulsory

Description

access_token

string

yes

The token allows the OA agent to call the API. Reference document

Request body structure

Param

Data type

Compulsory

Description

recipient

object

yes

Recipient information

message

object

yes

Content and attachment need to be sent

Recipient.target attribute structure

Param

Data type

Compulsory

Description

ages

string

optional

List of age groups that will receive notifications. Values are separated by "," Input values:

  • 0: Age 0-12

  • 1: Age 13-17

  • 2: Age 18-24

  • 3: Age 25-34

  • 4: Age 35-44

  • 5: Age 45-54

  • 6: Age 55-64

  • 7: Age greater than or equal to 65

gender

string

optional

The list of gender groups will receive notifications. Values are separated by "," Input values:

  • 0: All genders

  • 1: Male

  • 2: Female

locations

string

optional

List of locations that will receive notifications. Values are separated by ","

Input values:

  • 0: North Vietnam

  • 1: Central Vietnam

  • 2: South Vietnam

cities

string

optional

List of provinces and cities that will receive notifications. Values are separated by ","

Input values: See the recipient.target.cities table below.

Note: If set, this property will replace the "locations" attribute above.

platform

string

optional

List of mobile operating systems that will receive notifications. Values are separated by ","

Input values:

  • 1: IOS

  • 2: Android

  • 3: Windows Phone

Recipient.target.cities attribute values

Name of city/ province

Value

Đồng Tháp

0

Bình Phước

1

Ninh Bình

2

Bạc Liêu

3

Hồ Chí Minh

4

Vĩnh Long

5

Lâm Đồng

6

Yên Bái

7

Hà Nam

8

Hà Nội

9

Hải Dương

10

Hậu Giang

11

An Giang

12

Trà Vinh

13

Tiền Giang

14

Tây Ninh

15

Đồng Nai

16

Đắk Lắk

17

Bình Định

18

Kon Tum

19

Đà Nẵng

20

Bắc Giang

21

Bắc Kạn

22

Điện Biên

23

Hoà Bình

24

Thái Bình

25

Vĩnh Phúc

26

Hà Giang

27

Kiên Giang

28

Bình Dương

29

Bình Thuận

30

Đắk Nông

31

Khánh Hoà

32

Gia Lai

33

Quảng Nam

34

Quảng Trị

35

Hà Tĩnh

36

Hưng Yên

37

Quảng Ninh

38

Thanh Hoá

39

Phú Thọ

40

Lai Châu

41

Thái Nguyên

42

Cao Bằng

43

Cà Mau

44

Cần Thơ

45

Sóc Trăng

46

Bến Tre

47

Long An

48

Bà Rịa Vũng Tàu

49

Ninh Thuận

50

Phú Yên

51

Quảng Ngãi

52

Thừa Thiên Huế

53

Quảng Bình

54

Nghệ An

55

Nam Định

56

Hải Phòng

57

Lạng Sơn

58

Lào Cai

59

Sơn La

60

Bắc Ninh

61

Tuyên Quang

62

Không thuộc VN

63

Message.attachment attribute structure

Param

Data type

Compulsory

Description

type

string

yes

Attachment type. Required input value: <type> = template

payload

object

yes

Contains the payload of the attachment want to send. See the payload structure in the table below.

Message.attachment.payload attribute structure

Param

Data type

Compulsory

Description

template_type

string

yes

Template type. Required input value: <template_type> = media

elements

array

yes

Contains template objects.

Message.attachment.payload.element attribute structure

Param

Data type

Compulsory

Description

media_type

string

yes

Media type. Required input value: <media_type> = article

attachment_id

string

yes

The ID of the post you want to broadcast.

Example respond

{
  "data": {
    "msg_id": "ec1cf390d7d53e8b67c4"
  },
  "error": 0,
  "message": "Success"
}

Data attribute structure

Attribute

Data type

Description

msg_id

string

ID of broadcast message

PreviousGửi tin nhắn theo mẫu đính kèm danh sáchNextLấy thông tin trạng thái tin nhắn

Last updated