GET api/sms/{id}

Returns information about a short message.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

SMS identifier.

 integer

Required

Body Parameters

None.

Response Information

Resource Description

Message
NameDescriptionTypeAdditional information
Id

Message identifier.

 integer

None.
IdParent

Parent message identifier.

 integer

None.
IdUser

User identifier of the sender of the message.

 integer

None.
IdUserRecipient

User identifier of the recipient of the message.

 integer

None.
Recipient

Phone number of the recipient of the message.

 string

None.
SentDate

Date and time the message was sent.

 date

None.
IdSmsType

Type of message.

 SmsCertificationType

None.
CertificatePN

Code of the sending request certificate.

 string

None.
CertificateOperator

Code of the delivery certificate.

 string

None.
SendingStatus

State of the message.

 SmsStateId

None.
Text

Content of the message.

 string

None.
IP

IP address from where the message was sent.

 string

None.
SmsSenderId

SMS sender identifier used to send the message.

 string

None.
Rsn

Error code.

 integer

None.
IdTalk

Communication identifier.

 integer

None.
ChildMessages

Child messages.

 Collection of Message

None.

Response Formats

application/json, text/json

Sample: 
{
  "Id": 1,
  "IdParent": 1,
  "IdUser": 2,
  "IdUserRecipient": 1,
  "Recipient": "sample string 3",
  "SentDate": "2024-12-03T12:54:12.6138085+01:00",
  "IdSmsType": "None",
  "CertificatePN": "sample string 5",
  "CertificateOperator": "sample string 6",
  "SendingStatus": "Failed",
  "Text": "sample string 7",
  "IP": "sample string 8",
  "SmsSenderId": "sample string 9",
  "Rsn": 1,
  "IdTalk": 1,
  "ChildMessages": [
    {
      "$ref": "1"
    },
    {
      "$ref": "1"
    }
  ]
}

application/xml, text/xml

Sample: 
<Message xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" xmlns="http://schemas.datacontract.org/2004/07/PuntoNeutro.Core.WebApi">
  <CertificateOperator>sample string 6</CertificateOperator>
  <CertificatePN>sample string 5</CertificatePN>
  <ChildMessages>
    <Message z:Ref="i1" />
    <Message z:Ref="i1" />
  </ChildMessages>
  <IP>sample string 8</IP>
  <Id>1</Id>
  <IdParent>1</IdParent>
  <IdSmsType>None</IdSmsType>
  <IdTalk>1</IdTalk>
  <IdUser>2</IdUser>
  <IdUserRecipient>1</IdUserRecipient>
  <Recipient>sample string 3</Recipient>
  <Rsn>1</Rsn>
  <SendingStatus>Failed</SendingStatus>
  <SentDate>2024-12-03T12:54:12.6138085+01:00</SentDate>
  <SmsSenderId>sample string 9</SmsSenderId>
  <Text>sample string 7</Text>
</Message>