POST api/v4/sms/send

Request Information

URI Parameters

None.

Body Parameters

PatientComms.API.Public.V4API.ViewModels.Sms.SingleSendRequestDto
NameDescriptionTypeAdditional information
Destination

integer

Required

Range: inclusive between 1 and 9.22337203685478E+18
Message

string

Required
Source

string

String length: inclusive between 0 and 14
AllowReplies

boolean

None.
Metadata

Collection of Object

None.
DeliveryReportWebhook

URI

None.

Request Formats

application/json, text/json

Sample: 
{
  "Destination": 1,
  "Message": "sample string 2",
  "Source": "sample string 3",
  "AllowReplies": true,
  "Metadata": null,
  "DeliveryReportWebhook": "http://webapihelppage5.com"
}

application/xml, text/xml

Sample: 
<SingleSendRequestDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PatientComms.API.Public.V4API.ViewModels.Sms">
  <AllowReplies>true</AllowReplies>
  <DeliveryReportWebhook>http://webapihelppage5.com/</DeliveryReportWebhook>
  <Destination>1</Destination>
  <Message>sample string 2</Message>
  <Metadata i:nil="true" />
  <Source>sample string 3</Source>
</SingleSendRequestDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

System.Web.Http.IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.