DELETE api/v2/sms/messages/pendings

This method allows the client to cancel all the pending messages specified. Object containing a list of messageIDs that will be cancelled

Request Information

URI Parameters

None.

Body Parameters

TwoSms.CustomerPortalRole.API.SMS.DeletePendingRecurringMessagesRequest

Name	Description	Type	Additional information
All	Set this to true if all messages excluding those listed in MessageIDs should be deleted	boolean	None.
MessageIDs	List of MessageIDs of messages to be deleted	Collection of string	None.
StartDate	The start date filter for the deletion range	string	None.
EndDate	The end date filter for the deletion range	string	None.
Reference	The reference filter for deletions	string	None.
Destination	The destination filter for deletions	string	None.
Type	Whether it is Pending Or Recurring	TwoSms.CustomerPortalRole.API.SMS.PendingRecurringType	None.
Range	The range that was selected	TwoSms.CustomerPortalRole.API.Reports.FutureDateRange	None.

Request Formats

application/json, text/json

Sample:

{
  "All": true,
  "MessageIDs": [
    "sample string 1",
    "sample string 2"
  ],
  "StartDate": "sample string 2",
  "EndDate": "sample string 3",
  "Reference": "sample string 4",
  "Destination": "sample string 5",
  "Type": 0,
  "Range": 0
}

application/xml, text/xml

Sample:

<DeletePendingRecurringMessagesRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <All>true</All>
  <MessageIDs>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </MessageIDs>
  <StartDate>sample string 2</StartDate>
  <EndDate>sample string 3</EndDate>
  <Reference>sample string 4</Reference>
  <Destination>sample string 5</Destination>
  <Type>PENDING</Type>
  <Range>ALL</Range>
</DeletePendingRecurringMessagesRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'TwoSms.CustomerPortalRole.API.SMS.DeletePendingRecurringMessagesRequest'.

Response Information

Resource Description

TwoSms.CustomerPortalRole.API.Misc.ResponseOfTwoSms.CustomerPortalRole.API.SMS.DeletePendingMessagesResponse

Name	Description	Type	Additional information
Error		TwoSms.CustomerPortalRole.API.Misc.Error	None.
ResponseData		TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfTwoSms.CustomerPortalRole.API.SMS.DeletePendingMessagesResponse	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": {}
  }
}

application/xml, text/xml

Sample:

<ResponseOfDeletePendingMessagesResponse 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>
      <MessageIDs>
        <string>sample string 1</string>
        <string>sample string 2</string>
      </MessageIDs>
    </Detail>
  </ResponseData>
</ResponseOfDeletePendingMessagesResponse>