POST MyPortal/SendSms

Request Information

URI Parameters

None.

Body Parameters

PatientComms.API.Public.DTOs.Request.SingleSendRequest

Name	Type	Additional information
APIKey	globally unique identifier	Required
Username	string	Required
Destination	integer	Required
Source	string	Required String length: inclusive between 3 and 14
Message	string	Required String length: inclusive between 0 and 612
CustomerSiteId	string	String length: inclusive between 0 and 100
ScheduleDateTime	date	None.
UseTwoWay	boolean	None.
RestrictSends	boolean	None.
Date	date	None.
Times	Collection of date	None.

Request Formats

application/json, text/json

Sample:

{
  "APIKey": "092dbae4-dd39-4d95-9a97-191f4c232099",
  "Username": "sample string 2",
  "Destination": 3,
  "Source": "sample string 4",
  "Message": "sample string 5",
  "CustomerSiteId": "sample string 6",
  "ScheduleDateTime": "2025-04-04T07:18:48.8955958+01:00",
  "UseTwoWay": true,
  "RestrictSends": true,
  "Date": "2025-04-04T07:18:48.8955958+01:00",
  "Times": [
    "2025-04-04T07:18:48.8955958+01:00",
    "2025-04-04T07:18:48.8955958+01:00"
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PatientComms.API.Public.DTOs.Response.SingleSendResponse

Name	Type	Additional information
StatusId	integer	None.
Status	string	None.
Success	boolean	None.
Errors	Dictionary of string [key] and string [value]	None.
MessageId	integer	None.
Credits	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "StatusId": 1,
  "Status": "sample string 2",
  "Success": true,
  "Errors": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "MessageId": 1,
  "Credits": 1
}

application/xml, text/xml

Sample:

<SingleSendResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PatientComms.API.Public.DTOs.Response">
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/PatientComms.API.Public.DTOs">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Errors>
  <Status xmlns="http://schemas.datacontract.org/2004/07/PatientComms.API.Public.DTOs">sample string 2</Status>
  <StatusId xmlns="http://schemas.datacontract.org/2004/07/PatientComms.API.Public.DTOs">1</StatusId>
  <Success xmlns="http://schemas.datacontract.org/2004/07/PatientComms.API.Public.DTOs">true</Success>
  <Credits>1</Credits>
  <MessageId>1</MessageId>
</SingleSendResponse>