Tag Management
Tags are used to group Maskyoo numbers for reporting, segmentation and automation. These services manage the tags and the assignment of Maskyoo numbers to them.
Tag members are always Maskyoo numbers. The parameter name in the API calls is
maskyoo.
view_tags
Get tag details by name. This is an alias of view_tag_by_name; when tag_name is omitted all tags are returned.
Endpoint: /api/?service=view_tags
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
tag_name | string | NO | The tag name. Omit it to get all tags. |
format | string | NO | json / xml. |
Error codes
| Code | Description |
|---|---|
5082 | No results |
view_tag_by_name
Tag details by name. When tag_name is empty, all tags are returned.
Endpoint: /api/?service=view_tag_by_name
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
tag_name | string | YES | The tag name (required in view_tag_by_name; in view_tags it may be omitted to get everything). |
format | string | NO | json / xml. |
Error codes
| Code | Description |
|---|---|
5081 | tag_name is missing in view_tag_by_name |
5082 | No results |
view_tag_by_id
Tag details by ID.
Endpoint: /api/?service=view_tag_by_id
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
tag_id | int | YES | The tag ID. |
format | string | NO | json / xml. |
Error codes
| Code | Description |
|---|---|
5091 | tag_id is missing |
5092 | No results |
view_tags_by_maskyoo
Return the list of tags that a given Maskyoo number is a member of.
Endpoint: /api/?service=view_tags_by_maskyoo
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
maskyoo | string | YES | The number. |
format | string | NO | json / xml. |
Error codes
| Code | Description |
|---|---|
50811 | maskyoo is missing / shorter than 4 |
50821 | No results |
create_tag
Create a new tag. The tag name must be unique.
Endpoint: /api/?service=create_tag
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
tag_name | string | YES | The tag name. |
format | string | NO | json / xml. |
Error codes
| Code | Description |
|---|---|
5071 | tag_name is empty |
5072 | The tag name already exists |
5073 | Creating the tag failed |
update_tag
Rename an existing tag.
Endpoint: /api/?service=update_tag
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
tag_id | int | YES | The tag ID. |
tag_name | string | YES | The new name. |
format | string | NO | json / xml. |
Error codes
| Code | Description |
|---|---|
5061 | tag_id / tag_name is missing |
5062 | tag_name is empty |
5063 | tag_id does not exist |
5064 | No update was performed |
delete_tag
Delete a tag and all of its members.
Endpoint: /api/?service=delete_tag
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
tag_id | int | YES | The tag ID. |
format | string | NO | json / xml. |
Error codes
| Code | Description |
|---|---|
5051 | tag_id is missing |
5052 | The tag does not exist |
5053 / 5054 | The deletion failed |
add_member_to_tag
Add a Maskyoo number to a tag.
Endpoint: /api/?service=add_member_to_tag
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
tag_id | int | YES | The tag. |
maskyoo | string | YES | The number to add. |
format | string | NO | json / xml. |
Error codes
| Code | Description |
|---|---|
5041 | tag_id or maskyoo is missing |
5042 | The tag does not exist |
5043 | The Maskyoo number does not exist |
5044 | The Maskyoo number is already in the tag |
5045 | Adding failed |
remove_member_from_tag_id
Remove a Maskyoo number from a tag by tag ID.
Endpoint: /api/?service=remove_member_from_tag_id
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
tag_id | int | YES | The tag. |
maskyoo | string | YES | The number to remove. |
format | string | NO | json / xml. |
Error codes
| Code | Description |
|---|---|
5031 | tag_id or maskyoo is missing |
5032 | The Maskyoo number does not exist |
5033 | The tag does not exist |
5034 | The removal failed |
remove_member_from_tag_name
Remove a Maskyoo number from a tag by tag name.
Endpoint: /api/?service=remove_member_from_tag_name
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
tag_name | string | YES | The tag name. |
maskyoo | string | YES | The number to remove. |
format | string | NO | json / xml. |
Error codes
| Code | Description |
|---|---|
5021 | tag_name or maskyoo is missing |
5022 | The tag was not found |
5023 | The Maskyoo number does not exist |
5024 | The tag does not exist |
5025 | The removal failed |
view_maskyoo_members_by_tag_id
The list of active Maskyoo numbers that are members of the tag.
Endpoint: /api/?service=view_maskyoo_members_by_tag_id
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
tag_id | int | YES | The tag ID. |
format | string | NO | json / xml. |
Error codes
| Code | Description |
|---|---|
50911 | tag_id is missing |
50921 | No results |
get_members_by_tag_id
The list of tag members with the full Maskyoo details: description, active status, call destinations, working hours, private fields, prompts, email and more.
Endpoint: /api/?service=get_members_by_tag_id
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
tag_id | int | YES | The tag. |
format | string | NO | json / xml. |
Error codes
| Code | Description |
|---|---|
5001 | tag_id is missing |
5002 | No results |
get_members_by_tag_name
The same as get_members_by_tag_id, but by tag name.
Endpoint: /api/?service=get_members_by_tag_name
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
tag_name | string | YES | The tag name. |
format | string | NO | json / xml. |
Error codes
| Code | Description |
|---|---|
5011 | tag_name is missing |
5012 | The tag was not found |
5013 | No results |
System impact
Tags are the main grouping mechanism of Maskyoo numbers:
- Tag management screen — creating / updating / deleting tags and assigning numbers through the API is visible immediately in the tag management screen
- Reports — reports filtered by tag (tags report, call detail report, notifications report) reflect the change immediately
- Automation — automation rules with a tag filter apply immediately to numbers that are added to or removed from the tag
- Personal user tag — creating a user automatically creates a tag named
#<email>; deleting it breaks the permission assignment - Uniqueness — a tag name must be unique within the account; trying to create an existing name returns
5072