POST api/QuickMessage/SendQuickMessages

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
MobileNo	string	Required
Message	string	Required
BrandNameList	Collection of BrandName	None.
BrandName	string	Required
Language	string	None.
LanguageList	Collection of DropDownText	None.
loginId	integer	None.
TotalCharacters	integer	None.
TotalMessages	integer	None.
IsSchedule	boolean	None.
ScheduleDateTime	date	None.
SMSType	integer	None.
IsDynamic	boolean	None.
MobileNoField	string	Required
FileName	string	None.
LstDynamicMessage	Collection of DynamicMessage	None.
MessageTemplateList	Collection of MessageTemplate	None.
MessageTemplate	string	None.
GroupList	Collection of Group	None.
AdminGroupList	Collection of Group	None.
Groups	Collection of integer	None.
AdminGroups	Collection of integer	None.
GroupIds	string	None.
DynamicMobileNoFieldList	Collection of DropDownText	None.
DynamicInsertFieldsList	Collection of DropDownText	None.
FileUploadMobileNoFieldsList	Collection of DropDownText	None.
FileUploadMobileNoField	string	None.
DynamicInsertFields	string	None.
DynamicMobileNoField	string	None.
JustShowSent	boolean	None.
UserSentLoginId	integer	None.
UserSentMask	string	None.
ShowSentFromDateTime	date	None.
ShowSentToDateTime	date	None.
lstUsers	Collection of usp_GetBrandNames_Result	None.
SpecialCharachtersCountTwo	string	None.
TextFileUploadPath	string	None.
CampaignName	string	None.
FileExtension	string	None.

Request Formats

application/json, text/json

Sample:

{
  "MobileNo": "sample string 1",
  "Message": "sample string 2",
  "BrandNameList": [
    {
      "Id": 1,
      "LoginId": 1,
      "Name": "sample string 2",
      "IsActive": true,
      "CreatedDate": "2025-12-06T10:52:12.4750058+05:00",
      "CreatedBy": "sample string 3",
      "UpdatedDate": "2025-12-06T10:52:12.4750058+05:00",
      "UpdateBy": "sample string 4"
    },
    {
      "Id": 1,
      "LoginId": 1,
      "Name": "sample string 2",
      "IsActive": true,
      "CreatedDate": "2025-12-06T10:52:12.4750058+05:00",
      "CreatedBy": "sample string 3",
      "UpdatedDate": "2025-12-06T10:52:12.4750058+05:00",
      "UpdateBy": "sample string 4"
    }
  ],
  "BrandName": "sample string 3",
  "Language": "sample string 4",
  "LanguageList": [
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "loginId": 5,
  "TotalCharacters": 6,
  "TotalMessages": 7,
  "IsSchedule": true,
  "ScheduleDateTime": "2025-12-06T10:52:12.4750058+05:00",
  "SMSType": 10,
  "IsDynamic": true,
  "MobileNoField": "sample string 12",
  "FileName": "sample string 13",
  "LstDynamicMessage": [
    {
      "Id": 1,
      "Message": "sample string 2",
      "MobileNo": "sample string 3",
      "Serial": 1,
      "CompaignId": 1,
      "TotalMessages": 1,
      "TotalCharacter": 1,
      "NetworkId": 4
    },
    {
      "Id": 1,
      "Message": "sample string 2",
      "MobileNo": "sample string 3",
      "Serial": 1,
      "CompaignId": 1,
      "TotalMessages": 1,
      "TotalCharacter": 1,
      "NetworkId": 4
    }
  ],
  "MessageTemplateList": [
    {
      "Id": 1,
      "LoginId": 1,
      "Name": "sample string 2",
      "Message": "sample string 3",
      "CreatedDate": "2025-12-06T10:52:12.4759713+05:00",
      "CreatedBy": "sample string 4",
      "UpdatedDate": "2025-12-06T10:52:12.4759713+05:00",
      "UpdateBy": "sample string 5"
    },
    {
      "Id": 1,
      "LoginId": 1,
      "Name": "sample string 2",
      "Message": "sample string 3",
      "CreatedDate": "2025-12-06T10:52:12.4759713+05:00",
      "CreatedBy": "sample string 4",
      "UpdatedDate": "2025-12-06T10:52:12.4759713+05:00",
      "UpdateBy": "sample string 5"
    }
  ],
  "MessageTemplate": "sample string 14",
  "GroupList": [
    {
      "Id": 1,
      "LoginId": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "TotalCount": 1,
      "CreatedDate": "2025-12-06T10:52:12.4759713+05:00",
      "UpdateDate": "2025-12-06T10:52:12.4759713+05:00"
    },
    {
      "Id": 1,
      "LoginId": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "TotalCount": 1,
      "CreatedDate": "2025-12-06T10:52:12.4759713+05:00",
      "UpdateDate": "2025-12-06T10:52:12.4759713+05:00"
    }
  ],
  "AdminGroupList": [
    {
      "Id": 1,
      "LoginId": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "TotalCount": 1,
      "CreatedDate": "2025-12-06T10:52:12.4759713+05:00",
      "UpdateDate": "2025-12-06T10:52:12.4759713+05:00"
    },
    {
      "Id": 1,
      "LoginId": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "TotalCount": 1,
      "CreatedDate": "2025-12-06T10:52:12.4759713+05:00",
      "UpdateDate": "2025-12-06T10:52:12.4759713+05:00"
    }
  ],
  "Groups": [
    1,
    2
  ],
  "AdminGroups": [
    1,
    2
  ],
  "GroupIds": "sample string 15",
  "DynamicMobileNoFieldList": [
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "DynamicInsertFieldsList": [
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "FileUploadMobileNoFieldsList": [
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "FileUploadMobileNoField": "sample string 16",
  "DynamicInsertFields": "sample string 17",
  "DynamicMobileNoField": "sample string 18",
  "JustShowSent": true,
  "UserSentLoginId": 1,
  "UserSentMask": "sample string 20",
  "ShowSentFromDateTime": "2025-12-06T10:52:12.4769476+05:00",
  "ShowSentToDateTime": "2025-12-06T10:52:12.4769476+05:00",
  "lstUsers": [
    {
      "LoginId": 1,
      "Name": "sample string 1"
    },
    {
      "LoginId": 1,
      "Name": "sample string 1"
    }
  ],
  "SpecialCharachtersCountTwo": "sample string 23",
  "TextFileUploadPath": "sample string 24",
  "CampaignName": "sample string 25",
  "FileExtension": "sample string 26"
}

application/xml, text/xml

Sample:

<QuickMessageViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SMS.DataModels">
  <AdminGroupList>
    <Group>
      <CreatedDate>2025-12-06T10:52:12.4759713+05:00</CreatedDate>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <LoginId>1</LoginId>
      <Name>sample string 2</Name>
      <TotalCount>1</TotalCount>
      <UpdateDate>2025-12-06T10:52:12.4759713+05:00</UpdateDate>
    </Group>
    <Group>
      <CreatedDate>2025-12-06T10:52:12.4759713+05:00</CreatedDate>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <LoginId>1</LoginId>
      <Name>sample string 2</Name>
      <TotalCount>1</TotalCount>
      <UpdateDate>2025-12-06T10:52:12.4759713+05:00</UpdateDate>
    </Group>
  </AdminGroupList>
  <AdminGroups xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </AdminGroups>
  <BrandName>sample string 3</BrandName>
  <BrandNameList>
    <BrandName>
      <CreatedBy>sample string 3</CreatedBy>
      <CreatedDate>2025-12-06T10:52:12.4750058+05:00</CreatedDate>
      <Id>1</Id>
      <IsActive>true</IsActive>
      <LoginId>1</LoginId>
      <Name>sample string 2</Name>
      <UpdateBy>sample string 4</UpdateBy>
      <UpdatedDate>2025-12-06T10:52:12.4750058+05:00</UpdatedDate>
    </BrandName>
    <BrandName>
      <CreatedBy>sample string 3</CreatedBy>
      <CreatedDate>2025-12-06T10:52:12.4750058+05:00</CreatedDate>
      <Id>1</Id>
      <IsActive>true</IsActive>
      <LoginId>1</LoginId>
      <Name>sample string 2</Name>
      <UpdateBy>sample string 4</UpdateBy>
      <UpdatedDate>2025-12-06T10:52:12.4750058+05:00</UpdatedDate>
    </BrandName>
  </BrandNameList>
  <CampaignName>sample string 25</CampaignName>
  <DynamicInsertFields>sample string 17</DynamicInsertFields>
  <DynamicInsertFieldsList>
    <DropDownText>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </DropDownText>
    <DropDownText>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </DropDownText>
  </DynamicInsertFieldsList>
  <DynamicMobileNoField>sample string 18</DynamicMobileNoField>
  <DynamicMobileNoFieldList>
    <DropDownText>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </DropDownText>
    <DropDownText>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </DropDownText>
  </DynamicMobileNoFieldList>
  <FileExtension>sample string 26</FileExtension>
  <FileName>sample string 13</FileName>
  <FileUploadMobileNoField>sample string 16</FileUploadMobileNoField>
  <FileUploadMobileNoFieldsList>
    <DropDownText>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </DropDownText>
    <DropDownText>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </DropDownText>
  </FileUploadMobileNoFieldsList>
  <GroupIds>sample string 15</GroupIds>
  <GroupList>
    <Group>
      <CreatedDate>2025-12-06T10:52:12.4759713+05:00</CreatedDate>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <LoginId>1</LoginId>
      <Name>sample string 2</Name>
      <TotalCount>1</TotalCount>
      <UpdateDate>2025-12-06T10:52:12.4759713+05:00</UpdateDate>
    </Group>
    <Group>
      <CreatedDate>2025-12-06T10:52:12.4759713+05:00</CreatedDate>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <LoginId>1</LoginId>
      <Name>sample string 2</Name>
      <TotalCount>1</TotalCount>
      <UpdateDate>2025-12-06T10:52:12.4759713+05:00</UpdateDate>
    </Group>
  </GroupList>
  <Groups xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </Groups>
  <IsDynamic>true</IsDynamic>
  <IsSchedule>true</IsSchedule>
  <JustShowSent>true</JustShowSent>
  <Language>sample string 4</Language>
  <LanguageList>
    <DropDownText>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </DropDownText>
    <DropDownText>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </DropDownText>
  </LanguageList>
  <LstDynamicMessage>
    <DynamicMessage>
      <CompaignId>1</CompaignId>
      <Id>1</Id>
      <Message>sample string 2</Message>
      <MobileNo>sample string 3</MobileNo>
      <NetworkId>4</NetworkId>
      <Serial>1</Serial>
      <TotalCharacter>1</TotalCharacter>
      <TotalMessages>1</TotalMessages>
    </DynamicMessage>
    <DynamicMessage>
      <CompaignId>1</CompaignId>
      <Id>1</Id>
      <Message>sample string 2</Message>
      <MobileNo>sample string 3</MobileNo>
      <NetworkId>4</NetworkId>
      <Serial>1</Serial>
      <TotalCharacter>1</TotalCharacter>
      <TotalMessages>1</TotalMessages>
    </DynamicMessage>
  </LstDynamicMessage>
  <Message>sample string 2</Message>
  <MessageTemplate>sample string 14</MessageTemplate>
  <MessageTemplateList>
    <MessageTemplate>
      <CreatedBy>sample string 4</CreatedBy>
      <CreatedDate>2025-12-06T10:52:12.4759713+05:00</CreatedDate>
      <Id>1</Id>
      <LoginId>1</LoginId>
      <Message>sample string 3</Message>
      <Name>sample string 2</Name>
      <UpdateBy>sample string 5</UpdateBy>
      <UpdatedDate>2025-12-06T10:52:12.4759713+05:00</UpdatedDate>
    </MessageTemplate>
    <MessageTemplate>
      <CreatedBy>sample string 4</CreatedBy>
      <CreatedDate>2025-12-06T10:52:12.4759713+05:00</CreatedDate>
      <Id>1</Id>
      <LoginId>1</LoginId>
      <Message>sample string 3</Message>
      <Name>sample string 2</Name>
      <UpdateBy>sample string 5</UpdateBy>
      <UpdatedDate>2025-12-06T10:52:12.4759713+05:00</UpdatedDate>
    </MessageTemplate>
  </MessageTemplateList>
  <MobileNo>sample string 1</MobileNo>
  <MobileNoField>sample string 12</MobileNoField>
  <SMSType>10</SMSType>
  <ScheduleDateTime>2025-12-06T10:52:12.4750058+05:00</ScheduleDateTime>
  <ShowSentFromDateTime>2025-12-06T10:52:12.4769476+05:00</ShowSentFromDateTime>
  <ShowSentToDateTime>2025-12-06T10:52:12.4769476+05:00</ShowSentToDateTime>
  <SpecialCharachtersCountTwo>sample string 23</SpecialCharachtersCountTwo>
  <TextFileUploadPath>sample string 24</TextFileUploadPath>
  <TotalCharacters>6</TotalCharacters>
  <TotalMessages>7</TotalMessages>
  <UserSentLoginId>1</UserSentLoginId>
  <UserSentMask>sample string 20</UserSentMask>
  <loginId>5</loginId>
  <lstUsers>
    <usp_GetBrandNames_Result>
      <LoginId>1</LoginId>
      <Name>sample string 1</Name>
    </usp_GetBrandNames_Result>
    <usp_GetBrandNames_Result>
      <LoginId>1</LoginId>
      <Name>sample string 1</Name>
    </usp_GetBrandNames_Result>
  </lstUsers>
</QuickMessageViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

MessageReturnInfo

Name	Type	Additional information
InvalidMobileNo	Collection of string	None.
NetWorkCount	Collection of integer	None.
UserBalance	decimal number	None.
status	string	None.
TotalMessages	decimal number	None.
CompaignId	integer	None.
BrandName	string	None.
LoginId	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "InvalidMobileNo": [
    "sample string 1",
    "sample string 2"
  ],
  "NetWorkCount": [
    1,
    2
  ],
  "UserBalance": 1.1,
  "status": "sample string 2",
  "TotalMessages": 3.1,
  "CompaignId": 4,
  "BrandName": "sample string 5",
  "LoginId": 6
}

application/xml, text/xml

Sample:

<MessageReturnInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SMS.DataModels.ViewModels">
  <BrandName>sample string 5</BrandName>
  <CompaignId>4</CompaignId>
  <InvalidMobileNo xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </InvalidMobileNo>
  <LoginId>6</LoginId>
  <NetWorkCount xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </NetWorkCount>
  <TotalMessages>3.1</TotalMessages>
  <UserBalance>1.1</UserBalance>
  <status>sample string 2</status>
</MessageReturnInfo>