Nhảy tới nội dung

Tích hợp trung tâm tin nhắn và nhân viên AI vào phần mềm và hệ thống kinh doanh của bạn

Giới thiệu

Chào mừng bạn đến với Tài liệu API của Chative.IO! Tích hợp các khả năng nhắn tin mạnh mẽ của chúng tôi một cách dễ dàng vào nền tảng hoặc ứng dụng của bạn. Nâng cao tương tác khách hàng, doanh số bán hàng và hỗ trợ trên nhiều kênh một cách dễ dàng.

Trao đổi dữ liệu dễ dàng giữa các ứng dụng phần mềm bằng cách sử dụng API của Chative.IO. Trao quyền cho nền tảng của bạn với sức mạnh của tích hợp ngay hôm nay.

Hình ảnh cung cấp tổng quan trực quan về API, thể hiện các tính năng và chức năng của nó

Quy ước

Để tương tác với API, sử dụng URL cơ sở: [https://api.chative.io/v1.0]. Hãy nhớ sử dụng HTTPS cho tất cả các yêu cầu API để đảm bảo giao tiếp an toàn.

API của Chative tuân theo các quy ước RESTful, sử dụng các yêu cầu GET, POST, PATCHDELETE cho tất cả các hoạt động liên quan đến liên hệ. Dữ liệu yêu cầu và phản hồi được mã hóa ở định dạng JSON.

Các điểm cuối được hỗ trợ

Phương thức HTTPĐiểm cuối
GETLấy danh sách liên hệ
GETLấy liên hệ theo ID
PATCHCập nhật thuộc tính liên hệ
DELETEXóa liên hệ

Mã trạng thái

Mã thành công

Mã trạng thái HTTPMô tả
200Mọi thứ hoạt động như mong đợi

Mã lỗi

Mã trạng thái HTTPThông báo
400Yêu cầu không hợp lệ
401Thiếu token
401Token không hợp lệ
404Không tìm thấy {{ tên tài nguyên }}
429Vượt quá giới hạn tốc độ. Thử lại sau 1 phút.
500Đã xảy ra lỗi từ phía Chative.

Giới hạn tốc độ

Khi vượt quá giới hạn tốc độ, các yêu cầu sẽ trả về mã lỗi "rate_limited" (trạng thái phản hồi HTTP 429).

Xin lưu ý rằng số lượng yêu cầu tối đa cho mỗi yêu cầu được giới hạn ở mức 200.

Đối tượng

Liên hệ

Đối tượng Liên hệ đại diện cho một liên hệ trong ứng dụng Chative.IO.

Thuộc tính liên hệ:

Để biết thông tin chi tiết về thuộc tính Liên hệ, vui lòng tham khảo tài liệu API.

Sử dụng

Tài liệu này cung cấp cho bạn tổng quan về các điểm cuối API mà chúng tôi cung cấp, và tài liệu tham khảo chi tiết.

thông tin

API công khai chỉ có sẵn cho người dùng đăng ký Gói Business.

API Key là gì?

API Key là một mã định danh duy nhất được sử dụng để xác thực người dùng hoặc nhà phát triển khi yêu cầu tới API của Chative.IO, ví dụ, để lấy danh sách liên hệ hoặc cập nhật thông tin liên hệ.

Sử dụng các bước sau để tạo API Key:

Bước 1: Truy cập ứng dụng Chative.IO.

Bước 2: Trên thanh bên, nhấp vào biểu tượng Cài đặt.

Bước 3: Trên menu thả xuống, nhấp vào Nhà phát triển > Khóa API.

Hình ảnh minh họa tùy chọn khóa API

Bước 4: Nhấp vào Tạo khóa API.

Hình ảnh hiển thị cửa sổ pop-up để tạo khóa API

Cách sử dụng API?

Bước 1: Đi tới phần API trong Chative để tạo API Key.

Bước 2: Sao chép khóa bí mật liên kết với API Key đã tạo. Vui lòng đảm bảo rằng API Key đang hoạt động.

Hình ảnh minh họa bước sao chép khóa bí mật

Bước 3: Quay lại trang này, và nhấp vào Ủy quyền. Sau đó, dán khóa bí mật vào trường nhập liệu.

Hình ảnh minh họa bước ủy quyền

Bước 4: Nhấp vào API mong muốn mà bạn muốn sử dụng, sau đó chọn Thử ngay để tiếp tục.

Hình ảnh minh họa bước kích hoạt sử dụng API

Cách tìm ID liên hệ?

Để xem chi tiết liên hệ, hãy vào phần Liên hệ và chọn một liên hệ cụ thể. ID sẽ được hiển thị.

Hình ảnh chỉ ra nơi tìm ID liên hệ

Cách cập nhật thông tin liên hệ?

Làm việc với điểm cuối 'cập nhật liên hệ'

Xin lưu ý rằng cập nhật chỉ được hỗ trợ cho các trường cụ thể, bao gồm:

  • firstName (ví dụ: Peter).
  • lastName (ví dụ: Parker).
  • email (ví dụ: 'user@example.com').
  • gender (ví dụ: 'male').
  • birthday (ví dụ: 1028221200).
  • phone (ví dụ: 0123456789).
  • trường tùy chỉnh: (ví dụ: VIP - Khách hàng rất quan trọng)

Hình ảnh hiển thị phần thông tin cơ bản của một liên hệ

Làm việc với kiểu dữ liệu

Khi làm việc với điểm cuối 'cập nhật liên hệ', chỉ bốn kiểu dữ liệu được hỗ trợ: văn bản, số, ngày tháng và boolean:

  • Văn bản (ví dụ: 'VIP').
  • Số (ví dụ: 123).
  • Boolean (ví dụ: 'true' hoặc 'false').
  • Ngày tháng (chúng tôi hỗ trợ cả dấu thời gian tính bằng mili giây và định dạng ISO 8601, ví dụ: '2023-05-02T00:00:00+00:00').

Hỗ trợ

Cần trợ giúp hoặc có câu hỏi? Vui lòng liên hệ với đội hỗ trợ của chúng tôi thông qua Hỗ trợ trong ứng dụng hoặc live chat để nhận được sự giúp đỡ bạn cần và khám phá cách chúng tôi có thể hỗ trợ thêm cho nỗ lực tích hợp của bạn.