DELETE api/v1/sms/messages

This method allows the user to cancel the messages specified to prevent the end users from viewing the messages. The messages will not be removed from the user’s account but be marked as removed. The system will check that the user has permission to perform this action and the action of the user is log. If the NotifiyRecipients flag is set to true, then the system will notify all the recipients of the message that the message has been expired and is no longer viewable A object listing all the messages to be deleted.

Request Information

URI Parameters

None.

Body Parameters

MessageExpiry
NameDescriptionTypeAdditional information
MessageIDs

Collection of globally unique identifier

Required

NotifyRecipients

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "MessageIDs": [
    "59fb145c-500e-43d9-b8ab-f460ecbfec20",
    "7ff34155-9cca-4928-81bf-fb5dacae4016"
  ],
  "NotifyRecipients": true
}

application/xml, text/xml

Sample:
<MessageExpiry xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <MessageIDs>
    <guid>59fb145c-500e-43d9-b8ab-f460ecbfec20</guid>
    <guid>7ff34155-9cca-4928-81bf-fb5dacae4016</guid>
  </MessageIDs>
  <NotifyRecipients>true</NotifyRecipients>
</MessageExpiry>

Response Information

Resource Description

ResponseOfMessageDeleteResponse
NameDescriptionTypeAdditional information
Error

Error

None.

ResponseData

ResponseDataOfMessageDeleteResponse

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": {
      "NumberOfMessagesDeleted": 1
    }
  }
}

application/xml, text/xml

Sample:
<ResponseOfMessageDeleteResponse 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>
      <NumberOfMessagesDeleted>1</NumberOfMessagesDeleted>
    </Detail>
  </ResponseData>
</ResponseOfMessageDeleteResponse>