Quản lý doanh nghiệp

Quản lý doanh nghiệp thuộc đối tác hoặc đại lý

Tạo doanh nghiệp

POST [URL]/api/partner/tenant/add

Tạo doanh nghiệp đối tác Sau khi tạo doanh nghiệp xong, sẽ mất khoảng 3 - 10s để kích hoạt xong doanh nghiệp và khởi tạo dữ liệu ban đầu

Headers

NameTypeDescription

Authorization

string

Bearer Access Token : Bearer 'token'

Request Body

NameTypeDescription

email

string

Email chủ doanh nghiệp

password

string

Mật khẩu. Bao gồm 8 ký tự (In hoa, thường, số và ký tự đặc biệt)

fullName

string

Tên doanh nghiệp (Nhỏ hơn 255 ký tự)

ownerName

string

Tên chủ doanh nghiệp (Nhỏ hơn 255 ký tự)

phone

string

Số điện thoại chủ doanh nghiệp

isAutoActive

boolean

Tự động kích hoạt tài khoản hoặc không

{
    "status_code": 9999,
    "instance_id": "stg",
    "instance_name": "DESKTOP-1OB3SFM",
    "payload": {
        "id": "5f59784273227343222243" // ID doanh nghiệp
    },
    "key_enabled": false
}

Mã lỗi khi tạo doanh nghiệp

Mã lỗi

Mô tả

partner_invalid

Access token không phải của đối tác

tenant_invalid

Access token không phải của đối tác

body_request_is_required

Thiếu request body

request_invalid

Các dữ liệu bắt buộc không được nhập hoặc nhập không hợp lệ

email_invalid

Email không hợp lệ

password_invalid

Mật khẩu không hợp lệ

Mật khẩu bao gồm (In hoa, thường, số , ký tự đặc biệt)

email_registered

Email này đã được đăng ký với 1 chủ doanh nghiệp trước đó

create_tenant_error

Tạo doanh nghiệp bị lỗi

Danh sách doanh nghiệp

POST [URL]/api/partner/tenant/list

Danh sách doanh nghiệp thuộc đối tác

Query Parameters

NameTypeDescription

size

number

Kích thước trang

page

integer

Trang tìm kiếm, bắt đầu từ 1

Headers

NameTypeDescription

Authorization

string

Access token : Bearer 'token'

Request Body

NameTypeDescription

keyword

string

Từ khóa tìm kiếm - Tên doanh nghiệp - Email

Chi tiết doanh nghiệp thuộc đối tác

GET [URL]/api/partner/tenant/info?id=

Thông tin chi tiết doanh nghiệp thuộc đối tác

Query Parameters

NameTypeDescription

id

string

id của doanh nghiệp (tenant_id)

Headers

NameTypeDescription

Authorization

string

Access token : Bearer 'token'

{
    "status_code": 9999,
    "instance_id": "stg",
    "instance_name": "DESKTOP-1OB3SFM",
    "payload": {
        "full_name": "Omi Team",
        "email": "support@omicrm.com",
        "description": "Nâng cao trải nghiệm khách hàng, lấy sự hài lòng của khách hàng làm tiêu chí phấn đấu của doanh nghiệp",
        "enabled": true, //Đang hoạt động hoặc ngưng hoạt động
        "domain": "omiteam", // Tên miền truy cập OMI
        "domain_fusion": "omiteam", // Tên miền tổng đài
        "domain_expire": 1584606068154, // Ngày hết hạn domain
        "effective_date": 1583396482840, // Ngày kích hoạt
        "expire_date": 1614936981790, // Ngày hết hạn
        "phone": "0844441900", // SĐT chủ doanh nghiệp
        "status": "activated", // Trạng thái: Đã kích hoạt / Chưa kích hoạt
        "paid_type": "prepaid", // Hình thức thanh toán : prepaid : Trả trước, postpaid : Trả sau
        "nation": "vn", // Quốc gia
        "currency": "VND", // Tiền tệ
        "language": "vi", // Ngôn ngữ
        "balance": 3007855, // Số dư tài khoản
        "api_key": "K343KDK9-2I34K3K-3I33K3-2222" // Api key của doanh nghiệp
        "public_numbers": [
            {
                "number": "842877788056", // Số hotline
                "provider": "itel", // Nhà mạng
                "expire_date": 1602731734809, //Ngày hết hạn số
                "status": "active" // Tình trạng số
            }
        ],
        "service_package": {
            "code_name": "trial", // Mã gói
            "service_name": "Trial", // Tên gói
            "staff_num": 5, // Số lượng nhân viên
            "customer_num": 100, // Số lượng khách hàng
            "expiry_date": 1606300035002, // Ngày gói hết hạn
            "cashback" : 2092202 // Số tiền hoàn lại nếu khách hàng lên gói cao hơn
        }
    },
    "key_enabled": false
}

Nạp tiền

POST [URL]/api/partner/tenant/update_balance

Nạp tiền cho doanh nghiệp thông qua email

Headers

NameTypeDescription

Authorization

string

Access token : Bearer 'partner token'

Request Body

NameTypeDescription

email

string

Email chủ doanh nghiệp

amount

number

Số tiền (lớn hơn 10,000 VNĐ)

description

string

Nội dung nạp tiền (lớn hơn 50 ký tự)

THÔNG BÁO LỖI KHI NẠP TIỀN

Mô tả

access_denied

Nạp tiền bị từ chối

amount_gte_10.000_vnd

Số tiền tối thiểu 10,000 VNĐ

description_is_required

Mô tả là bắt buộc

description_is_to_short.gte_50_characters

Mô tả phải lớn 50 ký tự

Last updated