POST api/SMS/sendSMS

Request Information

URI Parameters

None.

Body Parameters

SMSLog
NameDescriptionTypeAdditional information
SMSLogId

decimal number

None.

BranchId

decimal number

None.

DocumentId

decimal number

None.

RefrenceId

integer

None.

SMSCount

integer

None.

Credit

integer

None.

SenderId

string

None.

IsUnicode

integer

None.

Route

integer

None.

Mobile

string

None.

SMSText

string

None.

ErrorMesssgae

string

None.

SentDate

string

None.

SentTime

string

None.

SentBy

decimal number

None.

SiteId

string

None.

MessageId

string

None.

StatusChangeDate

date

None.

Status

string

None.

SubSource

string

None.

LeadId

integer

None.

CustomerId

integer

None.

VendorId

integer

None.

EmployeeId

integer

None.

Message

string

None.

SMSSchedule

integer

None.

ContactType

Collection of ContactType

None.

DLTTemplateId

string

None.

Request Formats

application/json, text/json

Sample:
{
  "SMSLogId": 1.0,
  "BranchId": 2.0,
  "DocumentId": 3.0,
  "RefrenceId": 4,
  "SMSCount": 5,
  "Credit": 6,
  "SenderId": "sample string 7",
  "IsUnicode": 8,
  "Route": 9,
  "Mobile": "sample string 10",
  "SMSText": "sample string 11",
  "ErrorMesssgae": "sample string 12",
  "SentDate": "sample string 13",
  "SentTime": "sample string 14",
  "SentBy": 15.0,
  "SiteId": "sample string 16",
  "MessageId": "sample string 17",
  "StatusChangeDate": "2022-08-16T12:03:30.7849887+05:30",
  "Status": "sample string 19",
  "SubSource": "sample string 20",
  "LeadId": 21,
  "CustomerId": 22,
  "VendorId": 23,
  "EmployeeId": 24,
  "Message": "sample string 25",
  "SMSSchedule": 26,
  "ContactType": [
    {
      "IsStudentMobileNo": 1,
      "IsPrimaryMobileNo": 2,
      "IsSecondaryMobileNo": 3,
      "IsWhatsappMobileNo": 4
    },
    {
      "IsStudentMobileNo": 1,
      "IsPrimaryMobileNo": 2,
      "IsSecondaryMobileNo": 3,
      "IsWhatsappMobileNo": 4
    }
  ],
  "DLTTemplateId": "sample string 27"
}

application/xml, text/xml

Sample:
<SMSLog xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ZenoxERP.API.Models.Extensions">
  <BranchId>2</BranchId>
  <ContactType>
    <ContactType>
      <IsPrimaryMobileNo>2</IsPrimaryMobileNo>
      <IsSecondaryMobileNo>3</IsSecondaryMobileNo>
      <IsStudentMobileNo>1</IsStudentMobileNo>
      <IsWhatsappMobileNo>4</IsWhatsappMobileNo>
    </ContactType>
    <ContactType>
      <IsPrimaryMobileNo>2</IsPrimaryMobileNo>
      <IsSecondaryMobileNo>3</IsSecondaryMobileNo>
      <IsStudentMobileNo>1</IsStudentMobileNo>
      <IsWhatsappMobileNo>4</IsWhatsappMobileNo>
    </ContactType>
  </ContactType>
  <Credit>6</Credit>
  <CustomerId>22</CustomerId>
  <DLTTemplateId>sample string 27</DLTTemplateId>
  <DocumentId>3</DocumentId>
  <EmployeeId>24</EmployeeId>
  <ErrorMesssgae>sample string 12</ErrorMesssgae>
  <IsUnicode>8</IsUnicode>
  <LeadId>21</LeadId>
  <Message>sample string 25</Message>
  <MessageId>sample string 17</MessageId>
  <Mobile>sample string 10</Mobile>
  <RefrenceId>4</RefrenceId>
  <Route>9</Route>
  <SMSCount>5</SMSCount>
  <SMSLogId>1</SMSLogId>
  <SMSSchedule>26</SMSSchedule>
  <SMSText>sample string 11</SMSText>
  <SenderId>sample string 7</SenderId>
  <SentBy>15</SentBy>
  <SentDate>sample string 13</SentDate>
  <SentTime>sample string 14</SentTime>
  <SiteId>sample string 16</SiteId>
  <Status>sample string 19</Status>
  <StatusChangeDate>2022-08-16T12:03:30.7849887+05:30</StatusChangeDate>
  <SubSource>sample string 20</SubSource>
  <VendorId>23</VendorId>
</SMSLog>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SMSLog'.

Response Information

Resource Description

integer

Response Formats

application/json, text/json

Sample:
1

application/xml, text/xml

Sample:
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>