Json Api

PreviousQuản lý tài nguyên NextGet Attributes

Last updated 4 years ago

Was this helpful?

Json Api

JSON API cho phép bạn gửi request dưới dạng POST (thời gian chờ là 5) để:

Tạo nội dung động (gửi các tin nhắn từ CMS hay CRM của bạn đến khách hàng).
Lưu thông tin khách hàng vào google sheet hoặc lấy thông tin từ google sheet ra cho khách hàng.
Chuyển hướng khách hàng đến các kịch bản khác.
Lưu và cài đặt thuộc tính (attribute) cho khách hàng, ví dụ như điểm thưởng, hành trình,...

Cú pháp

URL: https://api.botbanhang.vn/v1.3/public/json?access_token={{accessToken}}&psid={{clientID}}
HEADERS:
Content-Type: application/json
Giải thích các tham số trong URL:
{{accessToken}}: là mã xác thực trang trong phần "Thiết lập chung". Nếu chưa có mã xác thực thì chỉ cần nhấn Tạo mã mới.

{{clientID}}: là ID của người dùng trên trang. Dùng $ để gọi clientID người dùng trên trang.

Các mẫu tham khảo

1. Gửi văn bản

{
 "messages": [
   {"text": "Chào mừng bạn đến với Bot Bán Hàng!"},
   {"text": "Chúng tôi có thể giúp gì cho bạn?"}
 ]
}

Kết quả test từ Postman.

2. Gửi hình ảnh

{
  "messages": [
    {
      "attachment": {
        "type": "image",
        "payload": {
          "url": "https://botbanhang.vn/images/logo.png"
        }
      }
    }
  ]
}

3. Gửi video

{
  "messages": [
    {
      "attachment": {
        "type": "video",
        "payload": {
          "url": "https://www.sample-videos.com/video123/mp4/720/big_buck_bunny_720p_5mb.mp4"
        }
      }
    }
  ]
}

{
  "messages": [
    {
      "attachment": {
        "type": "template",
        "payload": {
          "template_type": "media",
          "elements": [
            {
              "media_type": "video",
              "url": "https://www.facebook.com/unofficial.abio/videos/2593801767328577/",
              "buttons": [
                {
                  "title": "Truy cập Bot Bán Hàng!",
                  "type": "web_url",
                  "url": "https://botbanhang.vn/"
                }
              ]
            }
          ]
        }
      },
      "quick_replies": [
        {
          "title": "Tuyệt!",
          "set_attributes": {
            "feedback": "Cool!"
          }
        },
        {
          "title": "Không hay!",
          "set_attributes": {
            "feedback": "Not good!"
          }
        }
      ]
    }
  ]
}

4. Gửi âm thanh

{
  "messages": [
    {
      "attachment": {
        "type": "audio",
        "payload": {
          "url": "https://www.sample-videos.com/audio/mp3/wave.mp3"
        }
      }
    }
  ]
}

5. Gửi tập tin

{
  "messages": [
    {
      "attachment": {
        "type": "file",
        "payload": {
          "url": "https://www.sample-videos.com/pdf/Sample-pdf-5mb.pdf"
        }
      }
    }
  ]
}

6. Gửi thẻ ảnh ngang

{
 "messages": [
    {
      "attachment":{
        "type":"template",
        "payload":{
          "template_type":"generic",
          "image_aspect_ratio": "square",
          "elements":[
            {
              "title":"ÁO PHÔNG NAM DÀI TAY",
              "image_url":"https://canifa.s3.amazonaws.com/media/catalog/product/8/t/8tl18w007-sb505-34.jpg",
              "subtitle":"Size: M",
              "buttons":[
                {
                  "type":"web_url",
                  "url":"https://botbanhang.vn",
                  "title":"Xem chi tiết"
                }
              ]
            },
            {
              "title":"ÁO PHÔNG NAM DÀI TAY",
              "image_url":"https://canifa.s3.amazonaws.com/media/catalog/product/8/t/8tl18w007-sb505-33-.jpg",
              "subtitle":"Size: L",
              "default_action": {
                "type": "web_url",
                "url": "https://botbanhang.vn",
                "messenger_extensions": true
              },
              "buttons":[
                {
                  "type":"web_url",
                  "url":"https://botbanhang.vn",
                  "title":"Xem chi tiết"
                }
              ]
            }
          ]
        }
      }
    }
  ]
}

7. Nút bấm

{
  "messages": [
    {
      "attachment": {
        "type": "template",
        "payload": {
          "template_type": "button",
          "text": "Hello!",
          "buttons": [
            {
              "type": "show_block",
              "block_names": ["ID Kịch bản"],
              "title": "Hiện kịch bản"
            },
            {
              "type": "web_url",
              "url": "https://botbanhang.vn",
              "title": "Truy cập Website"
            },
            {
              "url": "https://fb.com/groups/botbanhang",
              "type":"web_url",
              "title":"Tham gia cộng đồng"
            }
          ]
        }
      }
    }
  ]
}

{
  "messages":[
    {
      "attachment":{
        "type":"template",
        "payload":{
          "template_type":"generic",
          "elements":[
            {
              "title":"Thông tin liên lạc",
              "image_url":"https://ayokaflowers.com/wp-content/uploads/2017/08/contact-us.png",
              "subtitle":"Hãy liên hệ chúng tôi để được trợ giúp!",
              "buttons":[
                {
                  "type":"phone_number",
                  "phone_number":"+84763874340",
                  "title":"Gọi"
                }
              ]
            }
          ]
        }
      }
    }
  ]
}

8. Trả lời nhanh

{
  "messages": [
    {
      "text":  "Bạn có muốn tiếp tục sử dụng sản phẩm Bot Bán Hàng?",
      "quick_replies": [
      	{
          "title":"Có!",
          "block_names": ["ID kịch bản 1"]
        },
        {
          "title":"Không!",
          "block_names": ["ID kịch bản 2", "ID kịch bản 3"]
        },
        {
          "title":"Đang xem xét...",
          "url": "http://www.mocky.io/v2/5d761dc33200002d0029789b",
          "type":"json_plugin_url"
        }
      ]
    }
  ]
}

{
  "messages": [
    {
      "text": "Bạn muốn gọi sữa hay cà phê?",
      "quick_replies": [
        {
          "title": "Sữa",
          "set_attributes": {
            "drink": "milk"
          }
        },
        {
          "title": "Cà phê",
          "set_attributes": {
            "drink": "coffee"
          }
        }
      ]
    }
  ]
}

9. Cài đặt thuộc tính (attributes) cho người dùng

{
  "set_attributes": 
    {
      "thanhpho": "Hà Nội",
      "email": "tien@botbanhang.vn",
      "dienthoai": "0763874340"
    },
  "block_names": ["5c6796a21e622d0d48fd5645"],
  "type": "show_block",
  "title": "Go!"
}

{
  "set_attributes":
    {
      "text 1": "some value",
      "text 2": "another value",
      "number 1": 1,
      "number 2": 2
    },
    "messages":[
      . . .
    ]
}

{
  "set_attributes":
    {
      "text 1": "some value",
      "text 2": "another value",
      "number 1": 1,
      "number 2": 2
    },
    "messages":[
      {"text": ""}
    ]
}

10. Chuyển hướng đến các kịch bản khác

{
  "redirect_to_blocks": ["5c6796a21e622d0d48fd5645", "5c9b9a39f60b4f001164aca2"]
}

PreviousQuản lý tài nguyên NextGet Attributes

Last updated 4 years ago

Was this helpful?