POST api/Sms

Enviar SMS.

Request Information

URI Parameters

None.

Body Parameters

Sms

Name	Description	Type	Additional information
Number	Número do Contacto a quem enviar a sms.	string	None.
Message	Texto da mensagem a enviar.	string	None.
ResponseAcceptedMessage	Mensagem de resposta a enviar, quando o destinatário responde à sms.	string	None.
Type	Tipo de sms. De momento, não está a ser utilizado.	string	None.
RegardingObjectName	Caso se pretenda associar a uma entidade do Dynamics, colocar o logical name.	string	None.
RegardingObjectId	Caso se pretenda associar a uma entidade do Dynamics, colocar o id do registo.	string	None.
ReceivedDate	Utilizado apenas para a consulta de respostas de sms. Data em que o destinatário respondeu.	date	None.

Request Formats

application/json, text/json

Sample:

{
  "Number": "sample string 1",
  "Message": "sample string 2",
  "ResponseAcceptedMessage": "sample string 3",
  "Type": "sample string 4",
  "RegardingObjectName": "sample string 5",
  "RegardingObjectId": "sample string 6",
  "ReceivedDate": "2025-10-28T20:39:52.0378325+00:00"
}

application/xml, text/xml

Sample:

<Sms xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hydra.Filtrarte.WebService.Models">
  <Message>sample string 2</Message>
  <Number>sample string 1</Number>
  <ReceivedDate>2025-10-28T20:39:52.0378325+00:00</ReceivedDate>
  <RegardingObjectId>sample string 6</RegardingObjectId>
  <RegardingObjectName>sample string 5</RegardingObjectName>
  <ResponseAcceptedMessage>sample string 3</ResponseAcceptedMessage>
  <Type>sample string 4</Type>
</Sms>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseMessage

Name	Description	Type	Additional information
Details		Collection of DetailMessage	None.

Response Formats

application/json, text/json

Sample:

{
  "Details": [
    {
      "Cod": 0,
      "Message": "sample string 1"
    },
    {
      "Cod": 0,
      "Message": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample:

<ResponseMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hydra.Filtrarte.Plugins.Models">
  <Details>
    <DetailMessage>
      <Cod>OK</Cod>
      <Message>sample string 1</Message>
    </DetailMessage>
    <DetailMessage>
      <Cod>OK</Cod>
      <Message>sample string 1</Message>
    </DetailMessage>
  </Details>
</ResponseMessage>