GET api/smsOutput/GetForWorkflow?accountID={accountID}&workflowItemID={workflowItemID}&metaValue_ActionFlowGroupID={metaValue_ActionFlowGroupID}&isAutomatic={isAutomatic}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
accountID

integer

Required

workflowItemID

integer

Required

metaValue_ActionFlowGroupID

integer

Required

isAutomatic

boolean

Required

Body Parameters

None.

Response Information

Resource Description

SmsOutputEditVM
NameDescriptionTypeAdditional information
SmsOutputVM

SmsOutputVM

None.

ContactWithList

Collection of ContactForList

None.

MergeTemplateList

Collection of MergeTemplateForList

None.

Response Formats

application/json, text/json

Sample:
{
  "SmsOutputVM": {
    "SmsOutput": {
      "SMSOutputID": 1,
      "AccountID": 1,
      "SMSOutputStatusID": 1,
      "Mobile": "sample string 1",
      "MessageFrom": "sample string 2",
      "MessageContent": "sample string 3",
      "StatusID": 1,
      "CreateID": 1,
      "CreateSessionID": 1,
      "CreateTS": "2025-09-02T23:04:39.2232653+00:00",
      "ModifyID": 1,
      "ModifySessionID": 1,
      "ModifyTS": "2025-09-02T23:04:39.2232653+00:00",
      "InactiveID": 1,
      "InactiveSessionID": 1,
      "InactiveTS": "2025-09-02T23:04:39.2232653+00:00",
      "DomainUserName": "sample string 4",
      "DateForSending": "2025-09-02T23:04:39.2232653+00:00",
      "CommunicationID": 1,
      "ContactDetailID": 1,
      "ContactID": 1,
      "LandLine": "sample string 5",
      "Email": "sample string 6",
      "ResponseData": "sample string 7",
      "ResponseReference": "sample string 8",
      "MergeTemplateID": 1,
      "MergeTemplateContactID": 1
    },
    "SkipIfNumberDoesNotExist": true,
    "SelectedMergeTemplateID": 1,
    "MobilePhoneList": [
      {
        "DisplayNameAndPhone": "sample string 1",
        "MobilePhone": "sample string 2",
        "ContactDetailID": 1,
        "IsChecked": true
      },
      {
        "DisplayNameAndPhone": "sample string 1",
        "MobilePhone": "sample string 2",
        "ContactDetailID": 1,
        "IsChecked": true
      }
    ]
  },
  "ContactWithList": [
    {
      "ContactID": 1,
      "Name": "sample string 2",
      "IsChecked": true,
      "ContactIDEncrypted": "sample string 4",
      "RelationshipID": 5
    },
    {
      "ContactID": 1,
      "Name": "sample string 2",
      "IsChecked": true,
      "ContactIDEncrypted": "sample string 4",
      "RelationshipID": 5
    }
  ],
  "MergeTemplateList": [
    {
      "MergeTemplateID": 1,
      "MergeTemplate": "sample string 2"
    },
    {
      "MergeTemplateID": 1,
      "MergeTemplate": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<SmsOutputEditVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels.SmsOutput">
  <ContactWithList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Contact">
    <d2p1:ContactForList>
      <d2p1:ContactID>1</d2p1:ContactID>
      <d2p1:ContactIDEncrypted>sample string 4</d2p1:ContactIDEncrypted>
      <d2p1:IsChecked>true</d2p1:IsChecked>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:RelationshipID>5</d2p1:RelationshipID>
    </d2p1:ContactForList>
    <d2p1:ContactForList>
      <d2p1:ContactID>1</d2p1:ContactID>
      <d2p1:ContactIDEncrypted>sample string 4</d2p1:ContactIDEncrypted>
      <d2p1:IsChecked>true</d2p1:IsChecked>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:RelationshipID>5</d2p1:RelationshipID>
    </d2p1:ContactForList>
  </ContactWithList>
  <MergeTemplateList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.MergeTemplate">
    <d2p1:MergeTemplateForList>
      <d2p1:MergeTemplate>sample string 2</d2p1:MergeTemplate>
      <d2p1:MergeTemplateID>1</d2p1:MergeTemplateID>
    </d2p1:MergeTemplateForList>
    <d2p1:MergeTemplateForList>
      <d2p1:MergeTemplate>sample string 2</d2p1:MergeTemplate>
      <d2p1:MergeTemplateID>1</d2p1:MergeTemplateID>
    </d2p1:MergeTemplateForList>
  </MergeTemplateList>
  <SmsOutputVM>
    <MobilePhoneList xmlns:d3p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Phone">
      <d3p1:MobilePhoneForList>
        <d3p1:ContactDetailID>1</d3p1:ContactDetailID>
        <d3p1:DisplayNameAndPhone>sample string 1</d3p1:DisplayNameAndPhone>
        <d3p1:IsChecked>true</d3p1:IsChecked>
        <d3p1:MobilePhone>sample string 2</d3p1:MobilePhone>
      </d3p1:MobilePhoneForList>
      <d3p1:MobilePhoneForList>
        <d3p1:ContactDetailID>1</d3p1:ContactDetailID>
        <d3p1:DisplayNameAndPhone>sample string 1</d3p1:DisplayNameAndPhone>
        <d3p1:IsChecked>true</d3p1:IsChecked>
        <d3p1:MobilePhone>sample string 2</d3p1:MobilePhone>
      </d3p1:MobilePhoneForList>
    </MobilePhoneList>
    <SelectedMergeTemplateID>1</SelectedMergeTemplateID>
    <SkipIfNumberDoesNotExist>true</SkipIfNumberDoesNotExist>
    <SmsOutput xmlns:d3p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.SmsOutput">
      <d3p1:AccountID>1</d3p1:AccountID>
      <d3p1:CommunicationID>1</d3p1:CommunicationID>
      <d3p1:ContactDetailID>1</d3p1:ContactDetailID>
      <d3p1:ContactID>1</d3p1:ContactID>
      <d3p1:CreateID>1</d3p1:CreateID>
      <d3p1:CreateSessionID>1</d3p1:CreateSessionID>
      <d3p1:CreateTS>2025-09-02T23:04:39.2232653+00:00</d3p1:CreateTS>
      <d3p1:DateForSending>2025-09-02T23:04:39.2232653+00:00</d3p1:DateForSending>
      <d3p1:DomainUserName>sample string 4</d3p1:DomainUserName>
      <d3p1:Email>sample string 6</d3p1:Email>
      <d3p1:InactiveID>1</d3p1:InactiveID>
      <d3p1:InactiveSessionID>1</d3p1:InactiveSessionID>
      <d3p1:InactiveTS>2025-09-02T23:04:39.2232653+00:00</d3p1:InactiveTS>
      <d3p1:LandLine>sample string 5</d3p1:LandLine>
      <d3p1:MergeTemplateContactID>1</d3p1:MergeTemplateContactID>
      <d3p1:MergeTemplateID>1</d3p1:MergeTemplateID>
      <d3p1:MessageContent>sample string 3</d3p1:MessageContent>
      <d3p1:MessageFrom>sample string 2</d3p1:MessageFrom>
      <d3p1:Mobile>sample string 1</d3p1:Mobile>
      <d3p1:ModifyID>1</d3p1:ModifyID>
      <d3p1:ModifySessionID>1</d3p1:ModifySessionID>
      <d3p1:ModifyTS>2025-09-02T23:04:39.2232653+00:00</d3p1:ModifyTS>
      <d3p1:ResponseData>sample string 7</d3p1:ResponseData>
      <d3p1:ResponseReference>sample string 8</d3p1:ResponseReference>
      <d3p1:SMSOutputID>1</d3p1:SMSOutputID>
      <d3p1:SMSOutputStatusID>1</d3p1:SMSOutputStatusID>
      <d3p1:StatusID>1</d3p1:StatusID>
    </SmsOutput>
  </SmsOutputVM>
</SmsOutputEditVM>