# Module Tổng Đài Ảo ### 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) Ivoip Cdrs #### Primary Key: `xml_cdr_uuid` #### Schema #### GET **Description: Get item or list paging by offset and limit parameters** **Endpoint(s):** * `GET /v4/ivoip/cdrs/{xml_cdr_uuid}`: for get exacly item * `GET /v4/ivoip/cdrs`: 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`: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: `string`) * `filter_`: filter items by like value (Type: `string`) * `left_`: filter items by like left of value (Type: `string`) * `right_`: filter items by like right of value (Type: `string`) * `eq_`: filter items by equal value (Type: `string`) * `ne_`: filter items by not equal value (Type: `string`) * `lt_`: filter items by less than value (Type: `string`) * `le_`: filter items by less than or equal value (Type: `string`) * `gt_`: filter items by greater then value (Type: `string`) * `ge_`: filter items by greater than or equal value (Type: `string`) #### POST **Description: Create new items** **Endpoint: `POST /v4/ivoip/cdrs`** **Payload:** * Content-Type: `application/json` * Data: JSON Array of objects defined in Schema #### PUT **Description: Update items by ids** * `PUT /v4/ivoip/cdrs/{xml_cdr_uuid}`: for put exacly item * `PUT /v4/ivoip/cdrs`: 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/ivoip/cdrs/{xml_cdr_uuid}`: for delete exacly item * `DELETE /v4/ivoip/cdrs?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) Ivoip Recordings #### Primary Key: `Id` #### Schema #### GET **Description: Get item or list paging by offset and limit parameters** **Endpoint(s):** * `GET /v4/ivoip/recordings/{Id}`: for get exacly item * `GET /v4/ivoip/recordings`: 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`: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: `string`) * `filter_`: filter items by like value (Type: `string`) * `left_`: filter items by like left of value (Type: `string`) * `right_`: filter items by like right of value (Type: `string`) * `eq_`: filter items by equal value (Type: `string`) * `ne_`: filter items by not equal value (Type: `string`) * `lt_`: filter items by less than value (Type: `string`) * `le_`: filter items by less than or equal value (Type: `string`) * `gt_`: filter items by greater then value (Type: `string`) * `ge_`: filter items by greater than or equal value (Type: `string`) #### POST **Description: Create new items** **Endpoint: `POST /v4/ivoip/recordings`** **Payload:** * Content-Type: `application/json` * Data: JSON Array of objects defined in Schema #### PUT **Description: Update items by ids** * `PUT /v4/ivoip/recordings/{Id}`: for put exacly item * `PUT /v4/ivoip/recordings`: 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/ivoip/recordings/{Id}`: for delete exacly item * `DELETE /v4/ivoip/recordings?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) Ivoip Pbxs #### Primary Key: `Code` #### Schema | Field | Type | Description | | -------------- | ------- | ---------------- | | ApiKey | string | Api Key | | ApiUrl | string | Api Url | | ApiVersion | string | Api Version | | BaseDomainName | string | Base Domain Name | | Code | string | Code | | Core | string | Core | | Description | string | Description | | Id | numeric | Id | | Name | string | Name | | Owner | string | Owner | | Platform | string | Platform | | State | string | State | #### GET **Description: Get item or list paging by offset and limit parameters** **Endpoint(s):** * `GET /v4/ivoip/pbxs/{Code}`: for get exacly item * `GET /v4/ivoip/pbxs`: 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`: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: `string`) * `filter_`: filter items by like value (Type: `string`) * `left_`: filter items by like left of value (Type: `string`) * `right_`: filter items by like right of value (Type: `string`) * `eq_`: filter items by equal value (Type: `string`) * `ne_`: filter items by not equal value (Type: `string`) * `lt_`: filter items by less than value (Type: `string`) * `le_`: filter items by less than or equal value (Type: `string`) * `gt_`: filter items by greater then value (Type: `string`) * `ge_`: filter items by greater than or equal value (Type: `string`) #### POST **Description: Create new items** **Endpoint: `POST /v4/ivoip/pbxs`** **Payload:** * Content-Type: `application/json` * Data: JSON Array of objects defined in Schema #### PUT **Description: Update items by ids** * `PUT /v4/ivoip/pbxs/{Code}`: for put exacly item * `PUT /v4/ivoip/pbxs`: 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/ivoip/pbxs/{Code}`: for delete exacly item * `DELETE /v4/ivoip/pbxs?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) Ivoip Extensions #### Primary Key: `extension_uuid` #### Schema #### GET **Description: Get item or list paging by offset and limit parameters** **Endpoint(s):** * `GET /v4/ivoip/extensions/{extension_uuid}`: for get exacly item * `GET /v4/ivoip/extensions`: 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`: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: `string`) * `filter_`: filter items by like value (Type: `string`) * `left_`: filter items by like left of value (Type: `string`) * `right_`: filter items by like right of value (Type: `string`) * `eq_`: filter items by equal value (Type: `string`) * `ne_`: filter items by not equal value (Type: `string`) * `lt_`: filter items by less than value (Type: `string`) * `le_`: filter items by less than or equal value (Type: `string`) * `gt_`: filter items by greater then value (Type: `string`) * `ge_`: filter items by greater than or equal value (Type: `string`) #### POST **Description: Create new items** **Endpoint: `POST /v4/ivoip/extensions`** **Payload:** * Content-Type: `application/json` * Data: JSON Array of objects defined in Schema #### PUT **Description: Update items by ids** * `PUT /v4/ivoip/extensions/{extension_uuid}`: for put exacly item * `PUT /v4/ivoip/extensions`: 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/ivoip/extensions/{extension_uuid}`: for delete exacly item * `DELETE /v4/ivoip/extensions?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) Ivoip CallBlocks #### Primary Key: `call_block_uuid` #### Schema #### GET **Description: Get item or list paging by offset and limit parameters** **Endpoint(s):** * `GET /v4/ivoip/call-blocks/{call_block_uuid}`: for get exacly item * `GET /v4/ivoip/call-blocks`: 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`: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: `string`) * `filter_`: filter items by like value (Type: `string`) * `left_`: filter items by like left of value (Type: `string`) * `right_`: filter items by like right of value (Type: `string`) * `eq_`: filter items by equal value (Type: `string`) * `ne_`: filter items by not equal value (Type: `string`) * `lt_`: filter items by less than value (Type: `string`) * `le_`: filter items by less than or equal value (Type: `string`) * `gt_`: filter items by greater then value (Type: `string`) * `ge_`: filter items by greater than or equal value (Type: `string`) #### POST **Description: Create new items** **Endpoint: `POST /v4/ivoip/call-blocks`** **Payload:** * Content-Type: `application/json` * Data: JSON Array of objects defined in Schema #### PUT **Description: Update items by ids** * `PUT /v4/ivoip/call-blocks/{call_block_uuid}`: for put exacly item * `PUT /v4/ivoip/call-blocks`: 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/ivoip/call-blocks/{call_block_uuid}`: for delete exacly item * `DELETE /v4/ivoip/call-blocks?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) Ivoip Domains #### Primary Key: `Id` #### Schema | Field | Type | Description | | ----------- | ------- | ----------- | | AdminKey | string | Admin Key | | Description | string | Description | | DomainId | string | Domain Id | | DomainName | string | Domain Name | | Id | numeric | Id | | Pbx | string | Pbx | #### GET **Description: Get item or list paging by offset and limit parameters** **Endpoint(s):** * `GET /v4/ivoip/domains/{Id}`: for get exacly item * `GET /v4/ivoip/domains`: 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`: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: `string`) * `filter_`: filter items by like value (Type: `string`) * `left_`: filter items by like left of value (Type: `string`) * `right_`: filter items by like right of value (Type: `string`) * `eq_`: filter items by equal value (Type: `string`) * `ne_`: filter items by not equal value (Type: `string`) * `lt_`: filter items by less than value (Type: `string`) * `le_`: filter items by less than or equal value (Type: `string`) * `gt_`: filter items by greater then value (Type: `string`) * `ge_`: filter items by greater than or equal value (Type: `string`) #### POST **Description: Create new items** **Endpoint: `POST /v4/ivoip/domains`** **Payload:** * Content-Type: `application/json` * Data: JSON Array of objects defined in Schema #### PUT **Description: Update items by ids** * `PUT /v4/ivoip/domains/{Id}`: for put exacly item * `PUT /v4/ivoip/domains`: 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/ivoip/domains/{Id}`: for delete exacly item * `DELETE /v4/ivoip/domains?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) Ivoip Devices #### Primary Key: `device_uuid` #### Schema #### GET **Description: Get item or list paging by offset and limit parameters** **Endpoint(s):** * `GET /v4/ivoip/devices/{device_uuid}`: for get exacly item * `GET /v4/ivoip/devices`: 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`: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: `string`) * `filter_`: filter items by like value (Type: `string`) * `left_`: filter items by like left of value (Type: `string`) * `right_`: filter items by like right of value (Type: `string`) * `eq_`: filter items by equal value (Type: `string`) * `ne_`: filter items by not equal value (Type: `string`) * `lt_`: filter items by less than value (Type: `string`) * `le_`: filter items by less than or equal value (Type: `string`) * `gt_`: filter items by greater then value (Type: `string`) * `ge_`: filter items by greater than or equal value (Type: `string`) #### POST **Description: Create new items** **Endpoint: `POST /v4/ivoip/devices`** **Payload:** * Content-Type: `application/json` * Data: JSON Array of objects defined in Schema #### PUT **Description: Update items by ids** * `PUT /v4/ivoip/devices/{device_uuid}`: for put exacly item * `PUT /v4/ivoip/devices`: 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/ivoip/devices/{device_uuid}`: for delete exacly item * `DELETE /v4/ivoip/devices?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) Ivoip DeviceVendors #### Primary Key: `device_vendor_uuid` #### Schema #### GET **Description: Get item or list paging by offset and limit parameters** **Endpoint(s):** * `GET /v4/ivoip/device-vendors/{device_vendor_uuid}`: for get exacly item * `GET /v4/ivoip/device-vendors`: 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`: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: `string`) * `filter_`: filter items by like value (Type: `string`) * `left_`: filter items by like left of value (Type: `string`) * `right_`: filter items by like right of value (Type: `string`) * `eq_`: filter items by equal value (Type: `string`) * `ne_`: filter items by not equal value (Type: `string`) * `lt_`: filter items by less than value (Type: `string`) * `le_`: filter items by less than or equal value (Type: `string`) * `gt_`: filter items by greater then value (Type: `string`) * `ge_`: filter items by greater than or equal value (Type: `string`) #### POST **Description: Create new items** **Endpoint: `POST /v4/ivoip/device-vendors`** **Payload:** * Content-Type: `application/json` * Data: JSON Array of objects defined in Schema #### PUT **Description: Update items by ids** * `PUT /v4/ivoip/device-vendors/{device_vendor_uuid}`: for put exacly item * `PUT /v4/ivoip/device-vendors`: 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/ivoip/device-vendors/{device_vendor_uuid}`: for delete exacly item * `DELETE /v4/ivoip/device-vendors?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) Ivoip PstnNumbers #### Primary Key: `destination_uuid` #### Schema #### GET **Description: Get item or list paging by offset and limit parameters** **Endpoint(s):** * `GET /v4/ivoip/pstn-numbers/{destination_uuid}`: for get exacly item * `GET /v4/ivoip/pstn-numbers`: 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`: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: `string`) * `filter_`: filter items by like value (Type: `string`) * `left_`: filter items by like left of value (Type: `string`) * `right_`: filter items by like right of value (Type: `string`) * `eq_`: filter items by equal value (Type: `string`) * `ne_`: filter items by not equal value (Type: `string`) * `lt_`: filter items by less than value (Type: `string`) * `le_`: filter items by less than or equal value (Type: `string`) * `gt_`: filter items by greater then value (Type: `string`) * `ge_`: filter items by greater than or equal value (Type: `string`) #### POST **Description: Create new items** **Endpoint: `POST /v4/ivoip/pstn-numbers`** **Payload:** * Content-Type: `application/json` * Data: JSON Array of objects defined in Schema #### PUT **Description: Update items by ids** * `PUT /v4/ivoip/pstn-numbers/{destination_uuid}`: for put exacly item * `PUT /v4/ivoip/pstn-numbers`: 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/ivoip/pstn-numbers/{destination_uuid}`: for delete exacly item * `DELETE /v4/ivoip/pstn-numbers?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) Ivoip DialplanActions #### Primary Key: `id` #### Schema | Field | Type | Description | | ------------------------- | ------- | --------------------------- | | Activated | string | Activated | | ActiveCode | string | Active Code | | Address | string | Address | | AllowLoginSignature | string | Allow Login Signature | | Avatar | string | Avatar | | AvatarId | numeric | Avatar Id | | AvatarThumbnail | string | Avatar Thumbnail | | Banner | string | Banner | | Birthday | string | Birthday | | BkAddress | string | Bk Address | | BkEmail | string | Bk Email | | BkGlobalPhone | string | Bk Global Phone | | BkPassword | string | Bk Password | | BkPhone | string | Bk Phone | | BkUsername | string | Bk Username | | BuildIn | numeric | Build In | | Code | string | Code | | ComplexId | string | Complex Id | | ContactAddress | string | Contact Address | | ContactEmail | string | Contact Email | | ContactFax | string | Contact Fax | | ContactGroupId | numeric | Contact Group Id | | ContactGtalkId | string | Contact Gtalk Id | | ContactHomeTel | string | Contact Home Tel | | ContactMaxDebt | string | Contact Max Debt | | ContactOtherEmail | string | Contact Other Email | | ContactOtherMobile | string | Contact Other Mobile | | ContactPersonalEmail | string | Contact Personal Email | | ContactPhone | string | Contact Phone | | ContactSkypeId | string | Contact Skype Id | | ContactTaxCode | string | Contact Tax Code | | ContactTypeId | numeric | Contact Type Id | | ContactWebsite | string | Contact Website | | ContactWorkTel | string | Contact Work Tel | | ContactYahooId | string | Contact Yahoo Id | | CookieCode | string | Cookie Code | | Created | string | Created | | CreationDate | string | Creation Date | | CreationUserId | numeric | Creation User Id | | DisabledNotificationTypes | string | Disabled Notification Types | | Email | string | Email | | EmailVerified | string | Email Verified | | ForceUpdate | numeric | Force Update | | ForgetPassCode | string | Forget Pass Code | | ForgetRequested | string | Forget Requested | | Gender | string | Gender | | GlobalPhone | string | Global Phone | | GroupId | numeric | Group Id | | Id | numeric | Id | | IdentityCardImage1 | string | Identity Card Image1 | | IdentityCardImage2 | string | Identity Card Image2 | | IdentityCardNumber | string | Identity Card Number | | IdentityCardVerified | string | Identity Card Verified | | IsActive | numeric | Is Active | | IsRegenerateCode | numeric | Is Regenerate Code | | IsSync | numeric | Is Sync | | LocationId | numeric | Location Id | | Name | string | Name | | NumOfChildren | numeric | Num Of Children | | OldCode | string | Old Code | | ParentId | numeric | Parent Id | | Password | string | Password | | Phone | string | Phone | | PhoneVerified | string | Phone Verified | | PinCodeSignature | string | Pin Code Signature | | ReferralByCode | string | Referral By Code | | ReferralByTypeId | numeric | Referral By Type Id | | ShortName | string | Short Name | | StoreId | numeric | Store Id | | TagName | string | Tag Name | | Title | string | Title | | Updated | string | Updated | | Username | string | Username | #### GET **Description: Get item or list paging by offset and limit parameters** **Endpoint(s):** * `GET /v4/ivoip/dialplan-actions/{id}`: for get exacly item * `GET /v4/ivoip/dialplan-actions`: 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`: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: `string`) * `filter_`: filter items by like value (Type: `string`) * `left_`: filter items by like left of value (Type: `string`) * `right_`: filter items by like right of value (Type: `string`) * `eq_`: filter items by equal value (Type: `string`) * `ne_`: filter items by not equal value (Type: `string`) * `lt_`: filter items by less than value (Type: `string`) * `le_`: filter items by less than or equal value (Type: `string`) * `gt_`: filter items by greater then value (Type: `string`) * `ge_`: filter items by greater than or equal value (Type: `string`) #### POST **Description: Create new items** **Endpoint: `POST /v4/ivoip/dialplan-actions`** **Payload:** * Content-Type: `application/json` * Data: JSON Array of objects defined in Schema #### PUT **Description: Update items by ids** * `PUT /v4/ivoip/dialplan-actions/{id}`: for put exacly item * `PUT /v4/ivoip/dialplan-actions`: 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/ivoip/dialplan-actions/{id}`: for delete exacly item * `DELETE /v4/ivoip/dialplan-actions?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) Ivoip Gateway #### Primary Key: `gateway_uuid` #### Schema #### GET **Description: Get item or list paging by offset and limit parameters** **Endpoint(s):** * `GET /v4/ivoip/gateways/{gateway_uuid}`: for get exacly item * `GET /v4/ivoip/gateways`: 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`: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: `string`) * `filter_`: filter items by like value (Type: `string`) * `left_`: filter items by like left of value (Type: `string`) * `right_`: filter items by like right of value (Type: `string`) * `eq_`: filter items by equal value (Type: `string`) * `ne_`: filter items by not equal value (Type: `string`) * `lt_`: filter items by less than value (Type: `string`) * `le_`: filter items by less than or equal value (Type: `string`) * `gt_`: filter items by greater then value (Type: `string`) * `ge_`: filter items by greater than or equal value (Type: `string`) #### POST **Description: Create new items** **Endpoint: `POST /v4/ivoip/gateways`** **Payload:** * Content-Type: `application/json` * Data: JSON Array of objects defined in Schema #### PUT **Description: Update items by ids** * `PUT /v4/ivoip/gateways/{gateway_uuid}`: for put exacly item * `PUT /v4/ivoip/gateways`: 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/ivoip/gateways/{gateway_uuid}`: for delete exacly item * `DELETE /v4/ivoip/gateways?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) Ivoip Dialplans #### Primary Key: `dialplan_uuid` #### Schema #### GET **Description: Get item or list paging by offset and limit parameters** **Endpoint(s):** * `GET /v4/ivoip/dialplans/{dialplan_uuid}`: for get exacly item * `GET /v4/ivoip/dialplans`: 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`: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: `string`) * `filter_`: filter items by like value (Type: `string`) * `left_`: filter items by like left of value (Type: `string`) * `right_`: filter items by like right of value (Type: `string`) * `eq_`: filter items by equal value (Type: `string`) * `ne_`: filter items by not equal value (Type: `string`) * `lt_`: filter items by less than value (Type: `string`) * `le_`: filter items by less than or equal value (Type: `string`) * `gt_`: filter items by greater then value (Type: `string`) * `ge_`: filter items by greater than or equal value (Type: `string`) #### POST **Description: Create new items** **Endpoint: `POST /v4/ivoip/dialplans`** **Payload:** * Content-Type: `application/json` * Data: JSON Array of objects defined in Schema #### PUT **Description: Update items by ids** * `PUT /v4/ivoip/dialplans/{dialplan_uuid}`: for put exacly item * `PUT /v4/ivoip/dialplans`: 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/ivoip/dialplans/{dialplan_uuid}`: for delete exacly item * `DELETE /v4/ivoip/dialplans?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) Ivoip IvrMenus #### Primary Key: `ivr_menu_uuid` #### Schema #### GET **Description: Get item or list paging by offset and limit parameters** **Endpoint(s):** * `GET /v4/ivoip/ivr-menus/{ivr_menu_uuid}`: for get exacly item * `GET /v4/ivoip/ivr-menus`: 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`: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: `string`) * `filter_`: filter items by like value (Type: `string`) * `left_`: filter items by like left of value (Type: `string`) * `right_`: filter items by like right of value (Type: `string`) * `eq_`: filter items by equal value (Type: `string`) * `ne_`: filter items by not equal value (Type: `string`) * `lt_`: filter items by less than value (Type: `string`) * `le_`: filter items by less than or equal value (Type: `string`) * `gt_`: filter items by greater then value (Type: `string`) * `ge_`: filter items by greater than or equal value (Type: `string`) #### POST **Description: Create new items** **Endpoint: `POST /v4/ivoip/ivr-menus`** **Payload:** * Content-Type: `application/json` * Data: JSON Array of objects defined in Schema #### PUT **Description: Update items by ids** * `PUT /v4/ivoip/ivr-menus/{ivr_menu_uuid}`: for put exacly item * `PUT /v4/ivoip/ivr-menus`: 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/ivoip/ivr-menus/{ivr_menu_uuid}`: for delete exacly item * `DELETE /v4/ivoip/ivr-menus?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) Ivoip Sounds #### Primary Key: `id` #### Schema #### GET **Description: Get item or list paging by offset and limit parameters** **Endpoint(s):** * `GET /v4/ivoip/sounds/{id}`: for get exacly item * `GET /v4/ivoip/sounds`: 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`: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: `string`) * `filter_`: filter items by like value (Type: `string`) * `left_`: filter items by like left of value (Type: `string`) * `right_`: filter items by like right of value (Type: `string`) * `eq_`: filter items by equal value (Type: `string`) * `ne_`: filter items by not equal value (Type: `string`) * `lt_`: filter items by less than value (Type: `string`) * `le_`: filter items by less than or equal value (Type: `string`) * `gt_`: filter items by greater then value (Type: `string`) * `ge_`: filter items by greater than or equal value (Type: `string`) #### POST **Description: Create new items** **Endpoint: `POST /v4/ivoip/sounds`** **Payload:** * Content-Type: `application/json` * Data: JSON Array of objects defined in Schema #### PUT **Description: Update items by ids** * `PUT /v4/ivoip/sounds/{id}`: for put exacly item * `PUT /v4/ivoip/sounds`: 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/ivoip/sounds/{id}`: for delete exacly item * `DELETE /v4/ivoip/sounds?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) Ivoip CallRoutes #### Primary Key: `call_route_uuid` #### Schema #### GET **Description: Get item or list paging by offset and limit parameters** **Endpoint(s):** * `GET /v4/ivoip/call-routes/{call_route_uuid}`: for get exacly item * `GET /v4/ivoip/call-routes`: 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`: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: `string`) * `filter_`: filter items by like value (Type: `string`) * `left_`: filter items by like left of value (Type: `string`) * `right_`: filter items by like right of value (Type: `string`) * `eq_`: filter items by equal value (Type: `string`) * `ne_`: filter items by not equal value (Type: `string`) * `lt_`: filter items by less than value (Type: `string`) * `le_`: filter items by less than or equal value (Type: `string`) * `gt_`: filter items by greater then value (Type: `string`) * `ge_`: filter items by greater than or equal value (Type: `string`) #### POST **Description: Create new items** **Endpoint: `POST /v4/ivoip/call-routes`** **Payload:** * Content-Type: `application/json` * Data: JSON Array of objects defined in Schema #### PUT **Description: Update items by ids** * `PUT /v4/ivoip/call-routes/{call_route_uuid}`: for put exacly item * `PUT /v4/ivoip/call-routes`: 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/ivoip/call-routes/{call_route_uuid}`: for delete exacly item * `DELETE /v4/ivoip/call-routes?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) Ivoip TimeConditions #### Primary Key: `dialplan_uuid` #### Schema #### GET **Description: Get item or list paging by offset and limit parameters** **Endpoint(s):** * `GET /v4/ivoip/time-conditions/{dialplan_uuid}`: for get exacly item * `GET /v4/ivoip/time-conditions`: 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`: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: `string`) * `filter_`: filter items by like value (Type: `string`) * `left_`: filter items by like left of value (Type: `string`) * `right_`: filter items by like right of value (Type: `string`) * `eq_`: filter items by equal value (Type: `string`) * `ne_`: filter items by not equal value (Type: `string`) * `lt_`: filter items by less than value (Type: `string`) * `le_`: filter items by less than or equal value (Type: `string`) * `gt_`: filter items by greater then value (Type: `string`) * `ge_`: filter items by greater than or equal value (Type: `string`) #### POST **Description: Create new items** **Endpoint: `POST /v4/ivoip/time-conditions`** **Payload:** * Content-Type: `application/json` * Data: JSON Array of objects defined in Schema #### PUT **Description: Update items by ids** * `PUT /v4/ivoip/time-conditions/{dialplan_uuid}`: for put exacly item * `PUT /v4/ivoip/time-conditions`: 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/ivoip/time-conditions/{dialplan_uuid}`: for delete exacly item * `DELETE /v4/ivoip/time-conditions?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) Ivoip CallCenters #### Primary Key: `call_center_queue_uuid` #### Schema #### GET **Description: Get item or list paging by offset and limit parameters** **Endpoint(s):** * `GET /v4/ivoip/call-centers/{call_center_queue_uuid}`: for get exacly item * `GET /v4/ivoip/call-centers`: 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`: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: `string`) * `filter_`: filter items by like value (Type: `string`) * `left_`: filter items by like left of value (Type: `string`) * `right_`: filter items by like right of value (Type: `string`) * `eq_`: filter items by equal value (Type: `string`) * `ne_`: filter items by not equal value (Type: `string`) * `lt_`: filter items by less than value (Type: `string`) * `le_`: filter items by less than or equal value (Type: `string`) * `gt_`: filter items by greater then value (Type: `string`) * `ge_`: filter items by greater than or equal value (Type: `string`) #### POST **Description: Create new items** **Endpoint: `POST /v4/ivoip/call-centers`** **Payload:** * Content-Type: `application/json` * Data: JSON Array of objects defined in Schema #### PUT **Description: Update items by ids** * `PUT /v4/ivoip/call-centers/{call_center_queue_uuid}`: for put exacly item * `PUT /v4/ivoip/call-centers`: 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/ivoip/call-centers/{call_center_queue_uuid}`: for delete exacly item * `DELETE /v4/ivoip/call-centers?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) Ivoip CallCenterAgents #### Primary Key: `call_center_agent_uuid` #### Schema #### GET **Description: Get item or list paging by offset and limit parameters** **Endpoint(s):** * `GET /v4/ivoip/call-center-agents/{call_center_agent_uuid}`: for get exacly item * `GET /v4/ivoip/call-center-agents`: 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`: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: `string`) * `filter_`: filter items by like value (Type: `string`) * `left_`: filter items by like left of value (Type: `string`) * `right_`: filter items by like right of value (Type: `string`) * `eq_`: filter items by equal value (Type: `string`) * `ne_`: filter items by not equal value (Type: `string`) * `lt_`: filter items by less than value (Type: `string`) * `le_`: filter items by less than or equal value (Type: `string`) * `gt_`: filter items by greater then value (Type: `string`) * `ge_`: filter items by greater than or equal value (Type: `string`) #### POST **Description: Create new items** **Endpoint: `POST /v4/ivoip/call-center-agents`** **Payload:** * Content-Type: `application/json` * Data: JSON Array of objects defined in Schema #### PUT **Description: Update items by ids** * `PUT /v4/ivoip/call-center-agents/{call_center_agent_uuid}`: for put exacly item * `PUT /v4/ivoip/call-center-agents`: 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/ivoip/call-center-agents/{call_center_agent_uuid}`: for delete exacly item * `DELETE /v4/ivoip/call-center-agents?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) Ivoip Customers #### 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/ivoip/customers/{Code}`: for get exacly item * `GET /v4/ivoip/customers`: 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`: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: `string`) * `filter_`: filter items by like value (Type: `string`) * `left_`: filter items by like left of value (Type: `string`) * `right_`: filter items by like right of value (Type: `string`) * `eq_`: filter items by equal value (Type: `string`) * `ne_`: filter items by not equal value (Type: `string`) * `lt_`: filter items by less than value (Type: `string`) * `le_`: filter items by less than or equal value (Type: `string`) * `gt_`: filter items by greater then value (Type: `string`) * `ge_`: filter items by greater than or equal value (Type: `string`) #### POST **Description: Create new items** **Endpoint: `POST /v4/ivoip/customers`** **Payload:** * Content-Type: `application/json` * Data: JSON Array of objects defined in Schema #### PUT **Description: Update items by ids** * `PUT /v4/ivoip/customers/{Code}`: for put exacly item * `PUT /v4/ivoip/customers`: 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/ivoip/customers/{Code}`: for delete exacly item * `DELETE /v4/ivoip/customers?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) Ivoip Deployments #### Primary Key: `id` #### Schema | Field | Type | Description | | ---------------- | ------- | ------------------ | | ApiKey | string | Api Key | | Code | string | Code | | Customer | string | Customer | | Description | string | Description | | Domain | string | Domain | | DomainName | string | Domain Name | | Extensions | string | Extensions | | Gateway | string | Gateway | | Id | numeric | Id | | MiniErp | string | Mini Erp | | Name | string | Name | | Pbx | string | Pbx | | PrivatePbxNumber | string | Private Pbx Number | | PstnNumber | string | Pstn Number | #### GET **Description: Get item or list paging by offset and limit parameters** **Endpoint(s):** * `GET /v4/ivoip/deployments/{id}`: for get exacly item * `GET /v4/ivoip/deployments`: 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`: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: `string`) * `filter_`: filter items by like value (Type: `string`) * `left_`: filter items by like left of value (Type: `string`) * `right_`: filter items by like right of value (Type: `string`) * `eq_`: filter items by equal value (Type: `string`) * `ne_`: filter items by not equal value (Type: `string`) * `lt_`: filter items by less than value (Type: `string`) * `le_`: filter items by less than or equal value (Type: `string`) * `gt_`: filter items by greater then value (Type: `string`) * `ge_`: filter items by greater than or equal value (Type: `string`) #### POST **Description: Create new items** **Endpoint: `POST /v4/ivoip/deployments`** **Payload:** * Content-Type: `application/json` * Data: JSON Array of objects defined in Schema #### PUT **Description: Update items by ids** * `PUT /v4/ivoip/deployments/{id}`: for put exacly item * `PUT /v4/ivoip/deployments`: 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/ivoip/deployments/{id}`: for delete exacly item * `DELETE /v4/ivoip/deployments?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) Ivoip Users #### Primary Key: `user_uuid` #### Schema #### GET **Description: Get item or list paging by offset and limit parameters** **Endpoint(s):** * `GET /v4/ivoip/users/{user_uuid}`: for get exacly item * `GET /v4/ivoip/users`: 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`: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: `string`) * `filter_`: filter items by like value (Type: `string`) * `left_`: filter items by like left of value (Type: `string`) * `right_`: filter items by like right of value (Type: `string`) * `eq_`: filter items by equal value (Type: `string`) * `ne_`: filter items by not equal value (Type: `string`) * `lt_`: filter items by less than value (Type: `string`) * `le_`: filter items by less than or equal value (Type: `string`) * `gt_`: filter items by greater then value (Type: `string`) * `ge_`: filter items by greater than or equal value (Type: `string`) #### POST **Description: Create new items** **Endpoint: `POST /v4/ivoip/users`** **Payload:** * Content-Type: `application/json` * Data: JSON Array of objects defined in Schema #### PUT **Description: Update items by ids** * `PUT /v4/ivoip/users/{user_uuid}`: for put exacly item * `PUT /v4/ivoip/users`: 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/ivoip/users/{user_uuid}`: for delete exacly item * `DELETE /v4/ivoip/users?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) Ivoip Click2Calls #### Primary Key: `call_block_uuid` #### Schema #### GET **Description: Get item or list paging by offset and limit parameters** **Endpoint(s):** * `GET /v4/ivoip/click2call/{call_block_uuid}`: for get exacly item * `GET /v4/ivoip/click2call`: 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`: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: `string`) * `filter_`: filter items by like value (Type: `string`) * `left_`: filter items by like left of value (Type: `string`) * `right_`: filter items by like right of value (Type: `string`) * `eq_`: filter items by equal value (Type: `string`) * `ne_`: filter items by not equal value (Type: `string`) * `lt_`: filter items by less than value (Type: `string`) * `le_`: filter items by less than or equal value (Type: `string`) * `gt_`: filter items by greater then value (Type: `string`) * `ge_`: filter items by greater than or equal value (Type: `string`) #### POST **Description: Create new items** **Endpoint: `POST /v4/ivoip/click2call`** **Payload:** * Content-Type: `application/json` * Data: JSON Array of objects defined in Schema #### PUT **Description: Update items by ids** * `PUT /v4/ivoip/click2call/{call_block_uuid}`: for put exacly item * `PUT /v4/ivoip/click2call`: 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/ivoip/click2call/{call_block_uuid}`: for delete exacly item * `DELETE /v4/ivoip/click2call?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) Ivoip PhoneBook Yealinks #### 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/ivoip/phone-book/yealinks/{Code}`: for get exacly item * `GET /v4/ivoip/phone-book/yealinks`: 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`: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: `string`) * `filter_`: filter items by like value (Type: `string`) * `left_`: filter items by like left of value (Type: `string`) * `right_`: filter items by like right of value (Type: `string`) * `eq_`: filter items by equal value (Type: `string`) * `ne_`: filter items by not equal value (Type: `string`) * `lt_`: filter items by less than value (Type: `string`) * `le_`: filter items by less than or equal value (Type: `string`) * `gt_`: filter items by greater then value (Type: `string`) * `ge_`: filter items by greater than or equal value (Type: `string`) #### POST **Description: Create new items** **Endpoint: `POST /v4/ivoip/phone-book/yealinks`** **Payload:** * Content-Type: `application/json` * Data: JSON Array of objects defined in Schema #### PUT **Description: Update items by ids** * `PUT /v4/ivoip/phone-book/yealinks/{Code}`: for put exacly item * `PUT /v4/ivoip/phone-book/yealinks`: 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/ivoip/phone-book/yealinks/{Code}`: for delete exacly item * `DELETE /v4/ivoip/phone-book/yealinks?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) Ivoip 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/ivoip/webhooks/{Code}`: for get exacly item * `GET /v4/ivoip/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`: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: `string`) * `filter_`: filter items by like value (Type: `string`) * `left_`: filter items by like left of value (Type: `string`) * `right_`: filter items by like right of value (Type: `string`) * `eq_`: filter items by equal value (Type: `string`) * `ne_`: filter items by not equal value (Type: `string`) * `lt_`: filter items by less than value (Type: `string`) * `le_`: filter items by less than or equal value (Type: `string`) * `gt_`: filter items by greater then value (Type: `string`) * `ge_`: filter items by greater than or equal value (Type: `string`) #### POST **Description: Create new items** **Endpoint: `POST /v4/ivoip/webhooks`** **Payload:** * Content-Type: `application/json` * Data: JSON Array of objects defined in Schema #### PUT **Description: Update items by ids** * `PUT /v4/ivoip/webhooks/{Code}`: for put exacly item * `PUT /v4/ivoip/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/ivoip/webhooks/{Code}`: for delete exacly item * `DELETE /v4/ivoip/webhooks?id0=123&id1=456&...`: for delete multiple items with id0 id1,... --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.crm.ai.vn/api-update-9-4-2025/module-tong-dai-ao.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.