| Requires any of the roles: | SystemAdministrator, Manager, Customer |
| GET | /reports/endpoints |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Types | query | List<EndpointTypes> | No | The types of endpoints to return |
| CustomerId | query | string | No | Filter by specific customer |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountId | form | string | No | The account ID this report should be run for |
| EmailAddressToNotify | form | string | No | The email address to notify after the report is run |
| WebhookUrl | form | string | No | The webhook to call after the report is complete with the data from the report |
| PhoneNumber | |
| User | |
| FaxNumber | |
| EmailAddress | |
| Unused_1 | |
| Unused_2 | |
| Unused_3 | |
| Unused_4 | |
| Unused_5 | |
| Team | |
| Assistant |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| Name | form | string | No | |
| Status | form | ReportStatuses | No | |
| StatusMessage | form | string | No | |
| DateCreated | form | string | No | |
| DateUpdated | form | string | No | |
| DownloadLink | form | string | No | |
| JobId | form | string | No | |
| EmailAddressToNotify | form | string | No | |
| Server | form | string | No |
| Queued | |
| Running | |
| Completed | |
| Error |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /reports/endpoints HTTP/1.1 Host: evovoice.io Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <ReportInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Reports"> <DateCreated>String</DateCreated> <DateUpdated>String</DateUpdated> <DownloadLink>String</DownloadLink> <EmailAddressToNotify>String</EmailAddressToNotify> <Id>String</Id> <JobId>String</JobId> <Name>String</Name> <Server>String</Server> <Status>Queued</Status> <StatusMessage>String</StatusMessage> </ReportInfo>