GET | /portal/form-completions |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AccountId | query | string | No | |
CustomerId | query | string | No | |
EmailSubjectFilter | query | string | No |
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 |
Ascend | |
Descend |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Name | form | string | No | |
DateCreated | form | string | No | |
DateCompleted | form | string | No | |
FormId | form | string | No | |
FormName | form | string | No | |
ClientId | form | string | No | |
ClientName | form | string | No | |
ContactId | form | string | No | |
ContactName | form | string | No | |
ContactsIds | form | List<string> | No | |
ContactsNames | form | List<string> | No | |
EmailSubject | form | string | No | |
CallerNumber | form | string | No | |
Fields | form | List<HostedSuiteCompletedFormField> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | No | |
Values | form | List<string> | No |
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 |
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 |
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /portal/form-completions HTTP/1.1 Host: team.evovoice.io Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <ListResponseOfHostedSuiteCompletedFormqR0suAWv 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.Portal"> <d2p1:HostedSuiteCompletedForm> <d2p1:CallerNumber>String</d2p1:CallerNumber> <d2p1:ClientId>String</d2p1:ClientId> <d2p1:ClientName>String</d2p1:ClientName> <d2p1:ContactId>String</d2p1:ContactId> <d2p1:ContactName>String</d2p1:ContactName> <d2p1:ContactsIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>String</d4p1:string> </d2p1:ContactsIds> <d2p1:ContactsNames xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>String</d4p1:string> </d2p1:ContactsNames> <d2p1:DateCompleted>String</d2p1:DateCompleted> <d2p1:DateCreated>String</d2p1:DateCreated> <d2p1:EmailSubject>String</d2p1:EmailSubject> <d2p1:Fields> <d2p1:HostedSuiteCompletedFormField> <d2p1:Name>String</d2p1:Name> <d2p1:Values xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d6p1:string>String</d6p1:string> </d2p1:Values> </d2p1:HostedSuiteCompletedFormField> </d2p1:Fields> <d2p1:FormId>String</d2p1:FormId> <d2p1:FormName>String</d2p1:FormName> <d2p1:Id>String</d2p1:Id> <d2p1:Name>String</d2p1:Name> </d2p1:HostedSuiteCompletedForm> </Items> <TotalCount>0</TotalCount> <TotalPages>0</TotalPages> </ListResponseOfHostedSuiteCompletedFormqR0suAWv>