Vodia PBX API (version 58.0 and above)
GET (Getting the Agent Group's list)
GET
1) (Info of the entire list of the Agent Groups)
rest/domain/domain_name/acds
Parameters
Field | Type | Description |
---|---|---|
domain_name | String | Name of the existing domain. |
Success (200 OK)
Example:
Request:
2) (Info of a SINGLE Agent Group)
rest/domain/domain_name/user_settings/agent_group_id
Parameters
Field | Type | Description |
---|---|---|
domain_name | String | Name of the existing domain. |
agent_group_id | Int / String | Unique ID (name or number) of the Agent group |
Success (200 OK)
Example:
Request:
Response | Code | Description |
---|---|---|
Success | 200 | OK |
Invalid ID supplied | 400 | Only authenticated Admins can access the data |
Permission Denied | 403 | Forbidden |
Not Found | 404 | The id of the User was not found or there are errors in the URL. |
POST (Create, Update and Delete the Attributes of the Webpage)
post
Create
/rest/domain/domain_name/addacc
Example:
Request:
Update
/rest/domain/domain_name/user_settings/agent_group_id
Parameters
Field | Type | Description |
---|---|---|
domain_name | String | Name of the existing domain. |
agent_group_id | Int / String | Unique ID (number or string) of the Agent group |
Request:
Delete
Example:The Agent group's account number in the API call can be obtained using the GET
for the entire Agent Group's list
There are 2 ways of deleting an entry.
1) Delete, multiple accounts (extension, auto-attendant, agent-groups etc. together) at once.
/rest/domain/domain_name/domain_action
Example:
Request:
2) Delete, single account at a time.
/rest/domain/domain_name/addacc/agent_group_id
Parameters used
Field | Type | Description |
---|---|---|
domain_name | String | Name of the existing domain. |
agent_group_id | Int / String | Unique ID (String or number) of the agent group account to be deleted. |
Request:
No extra parameters are needed to be specified, to delete a single agent group account.
If multiple agent group accounts are to be deleted, then the API has to be run multiple times with corresponding agent group IDs.
Response for Create, Update or Delete requests:
Response | Code | Description |
---|---|---|
Success | 200 | OK |
Invalid ID supplied | 400 | Only authenticated a Admins can access the data |
Permission Denied | 403 | Forbidden |
Not Found | 404 | The id of the User was not found or there are errors in the URL. |
GET (Getting the Agent Group's Calls)
GET
Get the CDR for a specific ACD group.
rest/user/user@domain/acdcalls?acd=acd
Parameters
Field | Type | Description |
---|---|---|
user | String | User account requesting the CDR |
domain | String | Name of the existing domain. |
acd | String | Name of the ACD |
Success (200 OK)
Example:
Request:
GET (Getting the Agent Group's CDR)
GET
Get the CDR for a specific ACD group.
rest/user/user@domain/acdcdr?acd=acd
Parameters
Field | Type | Description |
---|---|---|
user | String | User account requesting the CDR |
domain | String | Name of the existing domain. |
acd | String | Name of the ACD |
page | String | Requested page. If there is no page argument, the system will return the number of records for the query. |
size | String | Page size (default 50) |
day | String | Restrict the query to a specific day. The day must be in the format YYYYMMDD. |
Success (200 OK)
Example: