CareSoft Developer Docs
  • Giới thiệu
  • Thông tin chung
    • Phân trang dữ liệu
    • Trường động (Custom fields)
    • Rate limit - Giới hạn yêu cầu
  • Danh mục
    • Restful Api của CareSoft
      • Chuyên viên
      • Bộ phận
      • Dịch vụ
      • Phiếu ghi
        • Danh sách nguồn
        • Nguồn chi tiết
      • Lead
      • Deal
      • Khách hàng
        • Thông tin tỉnh/huyện
      • Chat
        • Danh sách tin nhắn chat
      • Cuộc gọi
      • Tin nhắn SMS
      • Tin nhắn Zalo
      • Tin nhắn Zalo ZNS
      • Chiến dịch
        • Kết quả chiến dịch
      • Khai thác dữ liệu chuyên sâu
      • Smart Dialer
      • QA
    • Tích hợp thoại
      • Danh sách dịch vụ gọi ra
      • Tích hợp kênh thoại trên ứng dụng Web (Voice API)
        • Xử lí multitab
        • Xử lí lỗi cross domain (CORS error)
        • Chuyển cuộc gọi (agent)
      • Tích hợp gọi ra sử dụng Click to call trên web
      • Tích hợp kênh thoại trên ứng dụng mobile
    • Webhook
    • Nhúng Live chat, Ticket Form
      • Nhúng live chat vào website
      • Nhúng ticket form
      • Hướng dẫn tích hợp Chat Caresoft vào Mobile App sử dụng React Native
    • Ứng dụng khác
      • Ladipage
    • Case study
      • Tạo phiếu ghi cho một chiến dịch đang chạy
      • Tạo phiếu ghi kèm thông tin trường động
  • Chatbot
    • Tổng quan Chatbot
    • Tích hợp hệ thống khác
      • Thẻ JSON API
Powered by GitBook
On this page
  • Lấy danh sách tỉnh/thành phố
  • Lấy danh sách tỉnh/thành phố
  • Lấy danh sách quận/huyện
  • Danh sách quận/huyện theo ID của tỉnh/thành phố
  1. Danh mục
  2. Restful Api của CareSoft
  3. Khách hàng

Thông tin tỉnh/huyện

Api cung cấp ID tỉnh/thành phố, Quận/Huyện hỗ trợ cập nhật thông tin khách hàng và phân loại theo tỉnh thành

PreviousKhách hàngNextChat

Last updated 2 years ago

Trong trường hợp cần gán địa chỉ khách hàng và phân cấp Tỉnh/Huyện thì sử dụng các api dưới đây để đồng bộ danh bạ tỉnh/thành, quận/huyện về ứng dụng.

Dữ liệu tỉnh/thành phố, quận/huyện chỉ áp dụng cho các địa phương ở Việt Nam

Lấy danh sách tỉnh/thành phố

Lấy danh sách tỉnh/thành phố

GET {{domain}}/api/v1/cities

Headers

Name
Type
Description

****

String

{
    "code": "ok",
    "numFound": 63,
    "data": [
        {
            "id": "01",
            "name": "Thành phố Hà Nội",
            "type": "Thành phố Trung ương"
        },
        {
            "id": "02",
            "name": "Tỉnh Hà Giang",
            "type": "Tỉnh"
        },
        ...
        ]
 }
STT
Trường dữ liệu
Chú thích

1

code

Trạng thái yêu cầu

2

numFound

Số lượng bản ghi tìm thấy

3

data

Mảng dữ liệu chứa các đối tượng thông tin từng tỉnh thành có cấu trúc - id: ID tỉnh thành, tương ứng với city_id khi tạo mới/cập nhật khách hàng hoặc lấy chi tiết các huyện/quận của 1 tỉnh - name: Tên thành phố/Tỉnh - type: Phân loại cấp thành phố/tỉnh

Lấy danh sách quận/huyện

Danh sách quận/huyện theo ID của tỉnh/thành phố

GET {{domain}}/api/v1/districts

Query Parameters

Name
Type
Description

city_id*

String

ID của tỉnh/thành phố dựa theo api Danh sách tỉnh

Headers

Name
Type
Description

***

String

{
    "code": "ok",
    "numFound": 30,
    "data": [
        {
            "id": "001",
            "name": "Quận Ba Đình",
            "type": "Quận",
            "city_id": "01"
        },
        {
            "id": "002",
            "name": "Quận Hoàn Kiếm",
            "type": "Quận",
            "city_id": "01"
        },
        ....
        ]
}
STT
Trường thông tin
Chú thích

1

code

Trạng thái yêu cầu

2

numFound

Số lượng bản ghi tìm thấy

3

data

Mảng dữ liệu quận huyện có cấu trúc

  • id: ID huyện/quận sẽ tương ứng với district_id khi tạo/cập nhật khách hàng và lấy thông tin khách hàng về

  • name: Tên huyện/quận

  • type: Kiểu quận hoặc huyện

  • city_id: ID của thành phố

{
    "code": "errors",
    "message": "Invalid city_id params"
}

Áp dụng từ 28/4/2023

Mô phỏng dữ liệu tỉnh thành từ POSTMAN
Chi tiết các quận/huyện theo city_id
Thông tin xác thực chung
Thông tin xác thực chung