POST api/SendSMS

Request Information

URI Parameters

None.

Body Parameters

SendSmsPostVm
NameDescriptionTypeAdditional information
Sender

string

None.

Type

string

None.

To

Collection of string

None.

Message

string

None.

LeadId

integer

None.

CustomerId

integer

None.

ContactId

integer

None.

Attachment

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Sender": "sample string 1",
  "Type": "sample string 2",
  "To": [
    "sample string 1",
    "sample string 2"
  ],
  "Message": "sample string 3",
  "LeadId": 1,
  "CustomerId": 1,
  "ContactId": 1,
  "Attachment": "sample string 4"
}

application/xml, text/xml

Sample:
<SendSmsPostVm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BrokerServer.Services">
  <Attachment>sample string 4</Attachment>
  <ContactId>1</ContactId>
  <CustomerId>1</CustomerId>
  <LeadId>1</LeadId>
  <Message>sample string 3</Message>
  <Sender>sample string 1</Sender>
  <To xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </To>
  <Type>sample string 2</Type>
</SendSmsPostVm>

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 'SendSmsPostVm'.

Response Information

Resource Description

Response
NameDescriptionTypeAdditional information
Success

boolean

None.

Message

string

None.

Description

string

None.

Data

Object

None.

Count

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Message": "sample string 2",
  "Description": "sample string 3",
  "Data": {},
  "Count": 5
}

application/xml, text/xml

Sample:
<Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BrokerServer.Models">
  <Count>5</Count>
  <Data />
  <Description>sample string 3</Description>
  <Message>sample string 2</Message>
  <Success>true</Success>
</Response>