POST api/v1/sms/messages/replies

This method sends a message to the contacts specified in the request or contained in the groups specified in the request. This allows the user to set an expiry of the message and how many times the end user can view the message. The system will check that the contact has permission to perform this action.

Request Information

URI Parameters

None.

Body Parameters

Either xml or json request.

MessageResponse

Name	Type	Additional information
MessageID	globally unique identifier	None.
From	string	None.
DateInsert	date	None.
Response	string	None.
DateRead	date	None.
SenderSent	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "MessageID": "f1c7e963-9ec5-4dad-a09d-e1d772b6cb7a",
  "From": "sample string 2",
  "DateInsert": "2024-12-22T22:12:42.1035+00:00",
  "Response": "sample string 4",
  "DateRead": "2024-12-22T22:12:42.1035+00:00",
  "SenderSent": true
}

application/xml, text/xml

Sample:

<MessageResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <MessageID>f1c7e963-9ec5-4dad-a09d-e1d772b6cb7a</MessageID>
  <From>sample string 2</From>
  <DateInsert>2024-12-22T22:12:42.1035+00:00</DateInsert>
  <Response>sample string 4</Response>
  <DateRead>2024-12-22T22:12:42.1035+00:00</DateRead>
  <SenderSent>true</SenderSent>
</MessageResponse>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Sms Transaction

ResponseOfSMSResponse

Name	Description	Type	Additional information
Error		Error	None.
ResponseData		ResponseDataOfSMSResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "Error": {
    "ErrorCode": "sample string 1",
    "ErrorReason": "sample string 2"
  },
  "ResponseData": {
    "Identification": {
      "UserId": "sample string 1"
    },
    "Result": "sample string 1",
    "Detail": {
      "MessageID": "sample string 1"
    }
  }
}

application/xml, text/xml

Sample:

<ResponseOfSMSResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <ErrorCode>sample string 1</ErrorCode>
    <ErrorReason>sample string 2</ErrorReason>
  </Error>
  <ResponseData>
    <Result>sample string 1</Result>
    <Identification>
      <UserId>sample string 1</UserId>
    </Identification>
    <Detail>
      <MessageID>sample string 1</MessageID>
      <MessageText>sample string 2</MessageText>
    </Detail>
  </ResponseData>
</ResponseOfSMSResponse>