Module Zalo OA

- Quản lý API kênh Zalo OA. - Quản lý Template ZNS - Quản lý khách quan tâm các kênh Zalo OA. - Quản lý tin nhắn hội thoại. (chưa bao gồm phí lưu trữ tin nhắn). - API nội bộ liên thông với các module

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) ZaloOa Webhooks

Primary Key: Code

Schema

Field	Type	Description
Description	string	Description
ExtendData	string	Extend Data
Feature	string	Feature
Id	numeric	Id
InputType	string	Input Type
IsApplied	numeric	Is Applied
IsPublic	numeric	Is Public
Module	string	Module
Name	string	Name
Type	string	Type
User	string	User
Value	string	Value

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

• GET /v4/zalo-oa/webhooks/{Code}: for get exacly item

• GET /v4/zalo-oa/webhooks: for get multiple items

Parameters:

• token: authentication token (Type: string)

• offset: get items from offset (Type: int)

• limit: get number of items (Type: int)

• id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

• filter_<Field>: filter items by like value (Type: string)

• left_<Field>: filter items by like left of value (Type: string)

• right_<Field>: filter items by like right of value (Type: string)

• eq_<Field>: filter items by equal value (Type: string)

• ne_<Field>: filter items by not equal value (Type: string)

• lt_<Field>: filter items by less than value (Type: string)

• le_<Field>: filter items by less than or equal value (Type: string)

• gt_<Field>: filter items by greater then value (Type: string)

• ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/zalo-oa/webhooks

Payload:

• Content-Type: application/json

• Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

• PUT /v4/zalo-oa/webhooks/{Code}: for put exacly item

• PUT /v4/zalo-oa/webhooks: for put multiple items

Payload:

• Content-Type: application/json

• Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

• DELETE /v4/zalo-oa/webhooks/{Code}: for delete exacly item

• DELETE /v4/zalo-oa/webhooks?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) ZaloOa Callbacks

Primary Key: Code

Schema

Field	Type	Description
Description	string	Description
ExtendData	string	Extend Data
Feature	string	Feature
Id	numeric	Id
InputType	string	Input Type
IsApplied	numeric	Is Applied
IsPublic	numeric	Is Public
Module	string	Module
Name	string	Name
Type	string	Type
User	string	User
Value	string	Value

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

• GET /v4/zalo-oa/callbacks/{Code}: for get exacly item

• GET /v4/zalo-oa/callbacks: for get multiple items

Parameters:

• token: authentication token (Type: string)

• offset: get items from offset (Type: int)

• limit: get number of items (Type: int)

• id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

• filter_<Field>: filter items by like value (Type: string)

• left_<Field>: filter items by like left of value (Type: string)

• right_<Field>: filter items by like right of value (Type: string)

• eq_<Field>: filter items by equal value (Type: string)

• ne_<Field>: filter items by not equal value (Type: string)

• lt_<Field>: filter items by less than value (Type: string)

• le_<Field>: filter items by less than or equal value (Type: string)

• gt_<Field>: filter items by greater then value (Type: string)

• ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/zalo-oa/callbacks

Payload:

• Content-Type: application/json

• Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

• PUT /v4/zalo-oa/callbacks/{Code}: for put exacly item

• PUT /v4/zalo-oa/callbacks: for put multiple items

Payload:

• Content-Type: application/json

• Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

• DELETE /v4/zalo-oa/callbacks/{Code}: for delete exacly item

• DELETE /v4/zalo-oa/callbacks?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) ZaloOa OfficialAccounts

Primary Key: Code

Schema

Field	Type	Description
AccessToken	string	Access Token
AccessTokenExpired	string	Access Token Expired
ApiUrl	string	Api Url
AppDomain	string	App Domain
AppId	string	App Id
AppName	string	App Name
AppSecret	string	App Secret
CallbackUrl	string	Callback Url
ChallengeCode	string	Challenge Code
Code	string	Code
Description	string	Description
Forward	string	Forward
ForwardUserToken	string	Forward User Token
Id	numeric	Id
IsDefault	boolean	Is Default
IsEnabled	boolean	Is Enabled
LastRefreshToken	string	Last Refresh Token
Name	string	Name
OaId	string	Oa Id
RefreshToken	string	Refresh Token
Status	numeric	Status
Type	string	Type
VerifierCode	string	Verifier Code
WebhookUser	string	Webhook User
WebhookUserToken	string	Webhook User Token
WebhookUserTokenExpired	datetime	Webhook User Token Expired

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

• GET /v4/zalo-oa/official-accounts/{Code}: for get exacly item

• GET /v4/zalo-oa/official-accounts: for get multiple items

Parameters:

• token: authentication token (Type: string)

• offset: get items from offset (Type: int)

• limit: get number of items (Type: int)

• id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

• filter_<Field>: filter items by like value (Type: string)

• left_<Field>: filter items by like left of value (Type: string)

• right_<Field>: filter items by like right of value (Type: string)

• eq_<Field>: filter items by equal value (Type: string)

• ne_<Field>: filter items by not equal value (Type: string)

• lt_<Field>: filter items by less than value (Type: string)

• le_<Field>: filter items by less than or equal value (Type: string)

• gt_<Field>: filter items by greater then value (Type: string)

• ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/zalo-oa/official-accounts

Payload:

• Content-Type: application/json

• Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

• PUT /v4/zalo-oa/official-accounts/{Code}: for put exacly item

• PUT /v4/zalo-oa/official-accounts: for put multiple items

Payload:

• Content-Type: application/json

• Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

• DELETE /v4/zalo-oa/official-accounts/{Code}: for delete exacly item

• DELETE /v4/zalo-oa/official-accounts?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) ZaloOa Followers

Primary Key: Code

Schema

Field	Type	Description
Address	string	Address
Address2	string	Address2
Address3	string	Address3
Avatar	string	Avatar
AvatarBk	numeric	Avatar Bk
AvatarUrl	string	Avatar Url
BankAcc	string	Bank Acc
BankName	string	Bank Name
Birthday	string	Birthday
Branch	string	Branch
BranchId	numeric	Branch Id
CallcenterNumber	string	Callcenter Number
CanLogin	numeric	Can Login
Code	string	Code
CompanyEmail	string	Company Email
ContactType	string	Contact Type
Created	string	Created
Creator	string	Creator
CreatorName	string	Creator Name
CreditPoints	numeric	Credit Points
CurrentDevice	string	Current Device
DateOfIssueIdNumber	string	Date Of Issue Id Number
Debt	string	Debt
DeleteBy	string	Delete By
DeleteByName	string	Delete By Name
Deleted	string	Deleted
Department	string	Department
District	string	District
DistrictLabel	string	District Label
Email	string	Email
EthnicOrigion	string	Ethnic Origion
Fax	string	Fax
FirstName	string	First Name
FullAddress	string	Full Address
Gender	string	Gender
GlobalPhone	string	Global Phone
Group	string	Group
GtalkId	string	Gtalk Id
Homeland	string	Homeland
HomeTel	string	Home Tel
Id	numeric	Id
IdentifiedNumber	string	Identified Number
IdNumber	string	Id Number
IdNumberSnapshot	string	Id Number Snapshot
IdNumberSnapshot2	string	Id Number Snapshot2
IdNumberSnapshot2Bk	numeric	Id Number Snapshot2 Bk
IdNumberSnapshotBk	numeric	Id Number Snapshot Bk
IsDeleted	numeric	Is Deleted
IsReceiveAllNotifications	numeric	Is Receive All Notifications
JoinedDate	string	Joined Date
Keyword	string	Keyword
LastName	string	Last Name
Latitude	string	Latitude
Location	string	Location
Longitude	string	Longitude
MapLink	string	Map Link
MapUrl	string	Map Url
MaxDebt	string	Max Debt
MemberLevel	string	Member Level
MemberLevelName	string	Member Level Name
MsnId	string	Msn Id
Name	string	Name
Note	string	Note
OtherEmail	string	Other Email
OtherPhone	string	Other Phone
Parent	string	Parent
ParentIdBk	numeric	Parent Id Bk
PermanentAddress	string	Permanent Address
Permission	string	Permission
PersonalEmail	string	Personal Email
Phone	string	Phone
Phone2	string	Phone2
Phone3	string	Phone3
Phone4	string	Phone4
PhoneExt	string	Phone Ext
PlaceOfBirth	string	Place Of Birth
PlaceOfIssueIdNumber	string	Place Of Issue Id Number
Province	string	Province
ProvinceLabel	string	Province Label
Religion	string	Religion
RewardPoints	numeric	Reward Points
SearchRank	numeric	Search Rank
Sex	numeric	Sex
ShortName	string	Short Name
SignatureSnapshot	string	Signature Snapshot
SignsOwn	string	Signs Own
SipDomain	string	Sip Domain
SipPassword	string	Sip Password
SipUser	string	Sip User
SkypeId	string	Skype Id
State	string	State
TaxCode	string	Tax Code
Title	string	Title
Type	string	Type
User	string	User
Ward	string	Ward
WardLabel	string	Ward Label
Website	string	Website
WorkingState	string	Working State
WorkingType	string	Working Type
WorkStatus	string	Work Status
WorkTel	string	Work Tel
YahooId	string	Yahoo Id
Zalo	string	Zalo

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

• GET /v4/zalo-oa/followers/{Code}: for get exacly item

• GET /v4/zalo-oa/followers: for get multiple items

Parameters:

• token: authentication token (Type: string)

• offset: get items from offset (Type: int)

• limit: get number of items (Type: int)

• id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

• filter_<Field>: filter items by like value (Type: string)

• left_<Field>: filter items by like left of value (Type: string)

• right_<Field>: filter items by like right of value (Type: string)

• eq_<Field>: filter items by equal value (Type: string)

• ne_<Field>: filter items by not equal value (Type: string)

• lt_<Field>: filter items by less than value (Type: string)

• le_<Field>: filter items by less than or equal value (Type: string)

• gt_<Field>: filter items by greater then value (Type: string)

• ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/zalo-oa/followers

Payload:

• Content-Type: application/json

• Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

• PUT /v4/zalo-oa/followers/{Code}: for put exacly item

• PUT /v4/zalo-oa/followers: for put multiple items

Payload:

• Content-Type: application/json

• Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

• DELETE /v4/zalo-oa/followers/{Code}: for delete exacly item

• DELETE /v4/zalo-oa/followers?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) ZaloOa Templates

Primary Key: Code

Schema

Field	Type	Description
Code	string	Code
Description	string	Description
Id	numeric	Id
Name	string	Name
TemplateId	string	Template Id
ZaloOa	string	Zalo Oa

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

• GET /v4/zalo-oa/templates/{Code}: for get exacly item

• GET /v4/zalo-oa/templates: for get multiple items

Parameters:

• token: authentication token (Type: string)

• offset: get items from offset (Type: int)

• limit: get number of items (Type: int)

• id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

• filter_<Field>: filter items by like value (Type: string)

• left_<Field>: filter items by like left of value (Type: string)

• right_<Field>: filter items by like right of value (Type: string)

• eq_<Field>: filter items by equal value (Type: string)

• ne_<Field>: filter items by not equal value (Type: string)

• lt_<Field>: filter items by less than value (Type: string)

• le_<Field>: filter items by less than or equal value (Type: string)

• gt_<Field>: filter items by greater then value (Type: string)

• ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/zalo-oa/templates

Payload:

• Content-Type: application/json

• Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

• PUT /v4/zalo-oa/templates/{Code}: for put exacly item

• PUT /v4/zalo-oa/templates: for put multiple items

Payload:

• Content-Type: application/json

• Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

• DELETE /v4/zalo-oa/templates/{Code}: for delete exacly item

• DELETE /v4/zalo-oa/templates?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) ZaloOa Messages

Primary Key: Code

Schema

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

• GET /v4/zalo-oa/messages/{Code}: for get exacly item

• GET /v4/zalo-oa/messages: for get multiple items

Parameters:

• token: authentication token (Type: string)

• offset: get items from offset (Type: int)

• limit: get number of items (Type: int)

• id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

• filter_<Field>: filter items by like value (Type: string)

• left_<Field>: filter items by like left of value (Type: string)

• right_<Field>: filter items by like right of value (Type: string)

• eq_<Field>: filter items by equal value (Type: string)

• ne_<Field>: filter items by not equal value (Type: string)

• lt_<Field>: filter items by less than value (Type: string)

• le_<Field>: filter items by less than or equal value (Type: string)

• gt_<Field>: filter items by greater then value (Type: string)

• ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/zalo-oa/messages

Payload:

• Content-Type: application/json

• Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

• PUT /v4/zalo-oa/messages/{Code}: for put exacly item

• PUT /v4/zalo-oa/messages: for put multiple items

Payload:

• Content-Type: application/json

• Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

• DELETE /v4/zalo-oa/messages/{Code}: for delete exacly item

• DELETE /v4/zalo-oa/messages?id0=123&id1=456&...: for delete multiple items with id0 id1,...