Evo Voice

ListIntegrations

Retrieve integrations

The following routes are available for this service:
GET	/integrations

**ListIntegrations** Parameters:
Name	Parameter	Data Type	Required	Description
AccountIds	query	List<string>	No	Filter by accounts
NameFilter	query	string	No	Filter by name
CustomerIds	query	List<string>	No	The IDs of the parent customers you want to filter by
ShallowParent	query	bool	No	If you want a shall customer integration filter (e.g. no deep children)

**ListRequest<T>** Parameters:
Name	Parameter	Data Type	Required	Description
Page	form	int	No	The page of data to retrieve
All	form	bool	No	If you want all objects to be returned. This should be used with care
CountPerPage	form	int	No	The number per page to retrieve
SpecificIds	form	List<string>	No	Specific IDs
SortField	form	string	No	Specify a sort field
SortOrder	form	SortOrders	No	Specify a sort order
SimplifiedPaging	form	bool	No	Disables total / page counts - improves performance. Returns only data. If there is no more data, Items will be empty array

**SortOrders** Enum:
Ascend
Descend

**IntegrationInfo** Parameters:
Name	Parameter	Data Type	Required	Description
AccountId	form	string	No	The ID of the account associated with this integration
CustomerId	form	string	No	The ID of the customer this integration is associated with
CustomerName	form	string	No	The name of the customer this integration is associated with
DateLastSync	form	string	No	The date the integration was sync'd last
CustomerBreadcrumb	form	List<CustomerBreadcrumb>	No	The breadcrumb to the customer for this integration
Name	form	string	No	The name of the integration (e.g. HostedSuite Dallas)
AutomaticallyCreateCustomers	form	bool	No	Automatically create new customers / users when sync'ing with CRM?
Type	form	IntegrationTypes	No	The type of integration
Status	form	IntegrationStatuses	No	The status of the integration
StatusMessage	form	string	No	The status of the integration
SettingsDataType	form	DataType	No	The settings type for this integration
Settings	form	Struct	No	The settings for this integration
Features	form	List<IntegrationFeatures>	No	The features supported by this integration
IsAuthorized	form	bool	No	Is this integration authorized (OAuth)?

**EntityInfo** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	string	No	The ID of the object
DateCreated	form	string	No	The date the object was created
DateLastModified	form	string	No	The date the object was last modified
CreatedBy	form	string	No	The user that created this object
LastModifiedBy	form	string	No	The user that last modified this object

**CustomerBreadcrumb** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	string	No
Name	form	string	No

**IntegrationTypes** Enum:
HostedSuite
OfficeRnd
Zoho

**IntegrationStatuses** Enum:
NotConfigured
Error
OK

**DataType** Parameters:
Name	Parameter	Data Type	Required	Description
TypeName	form	string	No
Fields	form	List<DataField>	No

**DataField** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Name	form	string	No
Type	form	ValueTypes	No
UIHint	form	UIHints	No
UITab	form	string	No
IsAsync	form	bool	No
DisableBinding	form	bool	No
StructType	form	DataType	No
ListType	form	DataType	No
Description	form	string	No
PossibleValues	form	List<string>	No
IsOutput	form	bool	No
CustomFieldValuesUrl	form	string	No
DefaultValue	form	Value	No
TransitionNameFormat	form	string	No
Uniqueness	form	DataFieldUniqueness	No
VoiceOnly	form	bool	No
ConditionalVisibilityField	form	string	No
ConditionalVisibilityValue	form	string	No
NoEvalTemplate	form	bool	No
UserMode	form	UserDataFieldModes	No
AnyValueType	form	bool	No

**ValueTypes** Enum:
NotSpecified
String
Boolean
Number
List
Struct
Transition
Custom
Date
AudioFile
TimeZoneId
PhoneNumber
User
Endpoint
Time
File
FaxNumber
EmailAccount
Customer
Flow
Team
FlowReference
Integration
Assistant

**UIHints** Enum:
None
LargeText
InlineForm
Password
InlineStruct

**Value** Parameters:
Name	Parameter	Data Type	Required
BoolValue	form	bool?	No
StringValue	form	string	No
NumberValue	form	double?	No
ListValue	form	List<Struct>	No
StructValue	form	Struct	No

**DataFieldUniqueness** Enum:
NotUnique
Unique
UniqueToCustomer

**UserDataFieldModes** Enum:
Hidden
ReadOnly
ReadWrite

**IntegrationFeatures** Enum:
CrmSync
OAuth2

**ListResponse<T>** Parameters:
Name	Parameter	Data Type	Required	Description
Items	form	List<AccountInfo>	No	The items
TotalCount	form	int	No	The total number of items
TotalPages	form	int	No	The total number of pages
HasMorePages	form	bool	No	Are there more pages of items? Used with simplified paging

**AccountInfo** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No	The name of this account
ParentAccountId	form	string	No	The ID of this account's parent
TwilioAccountSid	form	string	No	The twilio account SID
AncestorIds	form	List<string>	No	The ancestors of this account. Useful for breadcrumbs
MaxPhoneNumbers	form	int	No	The max number of phone numbers this account can have
IsBYOA	form	bool	No	This account is BYOA
TrustHubProfileSid	form	string	No	TrustHub Profile Sid
LogoId	form	string	No	The ID of the logo file
LogoUri	form	string	No	The URI of the logo file
BillingSettings	form	BillingSettings	No	The billing settings for this account

**BillingSettings** Parameters:
Name	Parameter	Data Type	Required
Base	form	BillingItem	No
LocalNumbers	form	BillingItem	No
TollFreeNumbers	form	BillingItem	No
InboundVoiceCalls	form	BillingItem	No
OutboundVoiceCalls	form	BillingItem	No
InboundFaxes	form	BillingItem	No
OutboundFaxes	form	BillingItem	No
InboundSmsMessages	form	BillingItem	No
OutboundSmsMessages	form	BillingItem	No
AIInsights	form	BillingItem	No
AILiveMinutes	form	BillingItem	No
AIMessages	form	BillingItem	No

**BillingItem** Parameters:
Name	Parameter	Data Type	Required
BaseCost	form	double	No
RawUnitMultiplier	form	double	No
UnitCost	form	double	No
Allowance	form	int	No

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /integrations HTTP/1.1 
Host: evovoice.io 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ListResponseOfIntegrationInfo_SFbT5aKg xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">
  <HasMorePages>false</HasMorePages>
  <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/Voice.Api.Integrations">
    <d2p1:IntegrationInfo>
      <CreatedBy>String</CreatedBy>
      <DateCreated>String</DateCreated>
      <DateLastModified>String</DateLastModified>
      <Id>String</Id>
      <LastModifiedBy>String</LastModifiedBy>
      <d2p1:AccountId>String</d2p1:AccountId>
      <d2p1:AutomaticallyCreateCustomers>false</d2p1:AutomaticallyCreateCustomers>
      <d2p1:CustomerBreadcrumb xmlns:d4p1="http://schemas.datacontract.org/2004/07/Voice.Api.Customers">
        <d4p1:CustomerBreadcrumb>
          <d4p1:Id>String</d4p1:Id>
          <d4p1:Name>String</d4p1:Name>
        </d4p1:CustomerBreadcrumb>
      </d2p1:CustomerBreadcrumb>
      <d2p1:CustomerId>String</d2p1:CustomerId>
      <d2p1:CustomerName>String</d2p1:CustomerName>
      <d2p1:DateLastSync>String</d2p1:DateLastSync>
      <d2p1:Features>
        <d2p1:IntegrationFeatures>CrmSync</d2p1:IntegrationFeatures>
      </d2p1:Features>
      <d2p1:IsAuthorized>false</d2p1:IsAuthorized>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Settings xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <d2p1:SettingsDataType xmlns:d4p1="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data" i:nil="true" />
      <d2p1:Status>NotConfigured</d2p1:Status>
      <d2p1:StatusMessage>String</d2p1:StatusMessage>
      <d2p1:Type>HostedSuite</d2p1:Type>
    </d2p1:IntegrationInfo>
  </Items>
  <TotalCount>0</TotalCount>
  <TotalPages>0</TotalPages>
</ListResponseOfIntegrationInfo_SFbT5aKg>