| All Verbs | /not-used |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PushNotification | query | PushNotification | No | |
| Notifications | query | List<NotificationInfo> | No | |
| NodeParameter | query | NodeParameter | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Type | form | PushNotificationTypes | No | |
| Channel | form | FlowChannels | No | |
| EndpointId | form | string | No | |
| EndpointUserName | form | string | No | |
| SessionId | form | string | No | |
| Sender | form | string | No | |
| Title | form | string | No | |
| Body | form | string | No | |
| Badge | form | int? | No | |
| AttachmentUri | form | string | No | |
| AttachmentContentType | form | string | No | |
| AgentState | form | AgentStates | No | |
| AgentStateReason | form | AgentStateReasons | No |
| SessionDisconnected | |
| SessionInvite | |
| ChatMessage | |
| SessionInactivated | |
| AgentStateChanged | |
| SessionHeld | |
| SessionAnswered | |
| ActiveSessionsChanged | |
| Ping | |
| SessionScreenChanged | |
| Toast | |
| SessionInfoChanged | |
| MessageReceived | |
| SessionHolding |
| Voice | |
| Chat | |
| Fax |
| Unknown | |
| Ready | |
| NotReady | |
| LoggedOut | |
| WrapUp | |
| Outgoing | |
| Other |
| Unknown | |
| SetByUser | |
| MissedCall | |
| SetBySystem |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountId | form | string | No | The account ID this endpoint is associated with |
| AccountName | form | string | No | The name of the account this endpoint is associated with |
| CustomerId | form | string | No | The ID of the customer this endpoint is associated with |
| CustomerName | form | string | No | The name of the customer this endpoint is associated with |
| CustomerBreadcrumb | form | List<CustomerBreadcrumb> | No | The breadcrumb to the customer for this endpoint |
| Type | form | NotificationTypes | No | The type of notification |
| Subject | form | string | No | The subject of the notification |
| Body | form | string | No | The body of the notification |
| Recipients | form | List<NotificationRecipientInfo> | No | The recipients of this notification |
| Attachments | form | List<FileInfo> | No | The list of attachments |
| From | form | string | No | The original from for the session |
| To | form | string | No | The original To for the session |
| Error | form | bool | No | Was there an error? |
| ErrorMessage | form | string | No | The error message |
| 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 |
|---|---|---|---|---|
| Id | form | string | No | |
| Name | form | string | No |
| Sms | |
| Push | |
| IncomingCall | |
| OutgoingCall |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Address | form | string | No | The address of the recipient |
| Extra | form | string | No | Extra info about the recipient e.g. CC, BCC |
| Name | form | string | No | The name of the recipient |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Type | form | FileTypes | No | The type of file this is |
| AccountId | form | string | No | The account ID this file is associated with |
| AccountName | form | string | No | The name of the account this file is associated with |
| CustomerId | form | string | No | The ID of the customer this file is associated with |
| CustomerName | form | string | No | The name of the customer this file is associated with |
| CustomerBreadcrumb | form | List<CustomerBreadcrumb> | No | The breadcrumb to the customer for this file |
| UserId | form | string | No | The ID of the user this file is assocaited with |
| UserName | form | string | No | The name of the user this file is associated with |
| FileName | form | string | No | The original file name for the file |
| Uri | form | string | No | The URI of the file |
| ContentType | form | string | No | The Content type of the file |
| ContentLength | form | long | No | The size of the file |
| RecordingSid | form | string | No | The Twilio ID of the recording |
| RecordingDuration | form | int | No | The duration of the recording in seconds |
| RecordingFrom | form | string | No | Who is the recording from? |
| Transcription | form | string | No | Transcription (if available) |
| FromAddress | form | string | No | From Address (e.g. caller ID) for incoming calls |
| ToAddress | form | string | No | To Address (e.g. dialed number) for outgoing calls |
| AITranscription | form | string | No | The AI transcription for this call |
| Upload | |
| VoiceMessage | |
| CallRecording | |
| Fax | |
| Attachment | |
| FaxOutgoing |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| Type | form | ValueTypes | No | |
| Source | form | ValueSources | No | |
| IsAsync | form | bool | No | |
| ReferenceId | form | string | No | |
| Value | form | Value | No | |
| NoEvalTemplate | form | bool | No | |
| ListParameters | form | List<NodeParameterMap> | No | |
| StructParameters | form | NodeParameterMap | No | |
| IsOutput | form | bool | No | |
| Expression | form | string | No | |
| ListType | form | DataType | No |
| NotSpecified | |
| String | |
| Boolean | |
| Number | |
| List | |
| Struct | |
| Transition | |
| Custom | |
| Date | |
| AudioFile | |
| TimeZoneId | |
| PhoneNumber | |
| User | |
| Endpoint | |
| Time | |
| File | |
| FaxNumber | |
| EmailAccount | |
| Customer | |
| Flow | |
| Team | |
| FlowReference | |
| Integration | |
| Assistant |
| Value | |
| Flow | |
| System | |
| Customer | |
| Session | |
| Endpoint | |
| Expression | |
| User |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BoolValue | form | bool? | No | |
| StringValue | form | string | No | |
| NumberValue | form | double? | No | |
| ListValue | form | List<Struct> | No | |
| StructValue | form | Struct | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TypeName | form | string | No | |
| Fields | form | List<DataField> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 |
| None | |
| LargeText | |
| InlineForm | |
| Password | |
| InlineStruct |
| NotUnique | |
| Unique | |
| UniqueToCustomer |
| Hidden | |
| ReadOnly | |
| ReadWrite |
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.
POST /not-used HTTP/1.1
Host: team.evovoice.io
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<NotUsedRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">
<NodeParameter xmlns:d2p1="http://schemas.datacontract.org/2004/07/Voice.Api.Flows" i:nil="true" />
<Notifications xmlns:d2p1="http://schemas.datacontract.org/2004/07/Voice.Api.Notifications">
<d2p1:NotificationInfo>
<CreatedBy>String</CreatedBy>
<DateCreated>String</DateCreated>
<DateLastModified>String</DateLastModified>
<Id>String</Id>
<LastModifiedBy>String</LastModifiedBy>
<d2p1:AccountId>String</d2p1:AccountId>
<d2p1:AccountName>String</d2p1:AccountName>
<d2p1:Attachments xmlns:d4p1="http://schemas.datacontract.org/2004/07/Voice.Api.Files">
<d4p1:FileInfo>
<CreatedBy>String</CreatedBy>
<DateCreated>String</DateCreated>
<DateLastModified>String</DateLastModified>
<Id>String</Id>
<LastModifiedBy>String</LastModifiedBy>
<d4p1:AITranscription>String</d4p1:AITranscription>
<d4p1:AccountId>String</d4p1:AccountId>
<d4p1:AccountName>String</d4p1:AccountName>
<d4p1:ContentLength>0</d4p1:ContentLength>
<d4p1:ContentType>String</d4p1:ContentType>
<d4p1:CustomerBreadcrumb xmlns:d6p1="http://schemas.datacontract.org/2004/07/Voice.Api.Customers">
<d6p1:CustomerBreadcrumb>
<d6p1:Id>String</d6p1:Id>
<d6p1:Name>String</d6p1:Name>
</d6p1:CustomerBreadcrumb>
</d4p1:CustomerBreadcrumb>
<d4p1:CustomerId>String</d4p1:CustomerId>
<d4p1:CustomerName>String</d4p1:CustomerName>
<d4p1:FileName>String</d4p1:FileName>
<d4p1:FromAddress>String</d4p1:FromAddress>
<d4p1:RecordingDuration>0</d4p1:RecordingDuration>
<d4p1:RecordingFrom>String</d4p1:RecordingFrom>
<d4p1:RecordingSid>String</d4p1:RecordingSid>
<d4p1:ToAddress>String</d4p1:ToAddress>
<d4p1:Transcription>String</d4p1:Transcription>
<d4p1:Type>Upload</d4p1:Type>
<d4p1:Uri>String</d4p1:Uri>
<d4p1:UserId>String</d4p1:UserId>
<d4p1:UserName>String</d4p1:UserName>
</d4p1:FileInfo>
</d2p1:Attachments>
<d2p1:Body>String</d2p1:Body>
<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:Error>false</d2p1:Error>
<d2p1:ErrorMessage>String</d2p1:ErrorMessage>
<d2p1:From>String</d2p1:From>
<d2p1:Recipients>
<d2p1:NotificationRecipientInfo>
<d2p1:Address>String</d2p1:Address>
<d2p1:Extra>String</d2p1:Extra>
<d2p1:Name>String</d2p1:Name>
</d2p1:NotificationRecipientInfo>
</d2p1:Recipients>
<d2p1:Subject>String</d2p1:Subject>
<d2p1:To>String</d2p1:To>
<d2p1:Type>Email</d2p1:Type>
</d2p1:NotificationInfo>
</Notifications>
<PushNotification xmlns:d2p1="http://schemas.datacontract.org/2004/07/Voice.Api.App">
<d2p1:AgentState>Unknown</d2p1:AgentState>
<d2p1:AgentStateReason>Unknown</d2p1:AgentStateReason>
<d2p1:AttachmentContentType>String</d2p1:AttachmentContentType>
<d2p1:AttachmentUri>String</d2p1:AttachmentUri>
<d2p1:Badge>0</d2p1:Badge>
<d2p1:Body>String</d2p1:Body>
<d2p1:Channel>Voice</d2p1:Channel>
<d2p1:EndpointId>String</d2p1:EndpointId>
<d2p1:EndpointUserName>String</d2p1:EndpointUserName>
<d2p1:Sender>String</d2p1:Sender>
<d2p1:SessionId>String</d2p1:SessionId>
<d2p1:Title>String</d2p1:Title>
<d2p1:Type>SessionDisconnected</d2p1:Type>
</PushNotification>
</NotUsedRequest>