Evo Voice

<back to all web services

EndpointsReport

This report returns all of the endpoints broken down by type per tab

Requires Authentication
Requires any of the roles:SystemAdministrator, Manager, Customer
The following routes are available for this service:
GET/reports/endpoints
EndpointsReport Parameters:
NameParameterData TypeRequiredDescription
TypesqueryList<EndpointTypes>NoThe types of endpoints to return
CustomerIdquerystringNoFilter by specific customer
ReportRequest Parameters:
NameParameterData TypeRequiredDescription
AccountIdformstringNoThe account ID this report should be run for
EmailAddressToNotifyformstringNoThe email address to notify after the report is run
EndpointTypes Enum:
PhoneNumber
User
FaxNumber
EmailAddress
Unused_1
Unused_2
Unused_3
Unused_4
Unused_5
Team
ReportInfo Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo
StatusformReportStatusesNo
StatusMessageformstringNo
DateCreatedformstringNo
DateUpdatedformstringNo
DownloadLinkformstringNo
JobIdformstringNo
EmailAddressToNotifyformstringNo
ServerformstringNo
ReportStatuses Enum:
Queued
Running
Completed
Error

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"id":"String","name":"String","status":"Queued","statusMessage":"String","dateCreated":"String","dateUpdated":"String","downloadLink":"String","jobId":"String","emailAddressToNotify":"String","server":"String"}