Message-ID: <1902992090.15751.1614957982428.JavaMail.confluence@wiki> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_15750_540154445.1614957982427" ------=_Part_15750_540154445.1614957982427 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html sms DELETE method

sms DELETE method

=20
=20
=20
=20

 

=20
=20
=20
=20
=20
=20

Delete a previously scheduled text message, provided that it hasn't been= sent yet.

=20
=20
=20
=20
=20
=20

The DELETE request should be sent to the Resource URL in the following f= ormat:

=20
=20
=20
=20
=20
=20
=20

http://api.textmarketer.co.uk/ser= vices/rest/sms/<scheduledID>

=20
=20
=20
=20
=20

 

=20
=20
=20
=20
=20
=20

e.g. for a scheduled message with ID '101', the URL would be:

=20
=20
=20
=20
=20
=20
=20

http://api.textm= arketer.co.uk/services/rest/sms/101

=20
=20
=20
=20
=20

 

=20
=20
=20
=20
=20
=20

Example successful response body XML:

=20
=20
=20
=20
=20 
<?xml version=3D"1.0" encoding=3D"ISO-8859-1"?&=
gt;
<!DOCTYPE response PUBLIC
"-//textmarketer.biz//DTD Web Services REST 1.6//EN"
"http://api.textmarketer.co.uk/services/rest/DTD/sms_delete.dtd"&=
gt;
<response processed_date=3D"2013-07-15T15:14:18+01:00">
=09<scheduled_id>101</scheduled_id>
=09<status>DELETED</status>
</response>
=20
=20
=20
=20
=20
=20
=20

Response meanings:

=20
=20
=20
=20
XML tag/attribute Meaning
scheduled_id 

The Unique ID of the scheduled message that w= as deleted.
status  The status of the message, i.e., DELETED.
=20
=20
=20
=20
=20
=20

specific errors:

=20
=20
=20
=20
Code Meaning
35 The provided Resource ID is not valid or is malf= ormed.
36

This can have multiple meanings: either 1) th= e scheduled message id doesn't exist or belongs to other account than the o= ne using the REST API; or 2) the scheduled message has already been sent an= d, as so, can't be deleted.
=20
=20
=20
=20
=20
=20

Example error response body XML:

=20
=20
=20
=20
=20 
<?xml version=3D"1.0" encoding=3D"ISO-8859-1"?&=
gt;
<!DOCTYPE response PUBLIC
"-//textmarketer.biz//DTD Web Services REST 1.6//EN"
"http://api.textmarketer.co.uk/services/rest/DTD/errors.dtd">
<response processed_date=3D"2013-07-15T15:35:56+01:00">
<errors>
=09<error code=3D"36">Scheduled message with id: 101 doesn'=
t exist or has already=20

been delivered.</error>
</errors>
</response>
=20
=20
=20
=20
=20
=20
=20

DTD for sms DELETE:

=20
=20
=20
=20
=20 
<?xml version=3D"1.0" encoding=3D"UTF-8"?>
<!--
=09 PUBLIC ID : -//textmarketer.biz//DTD Web Services REST 1.6//EN
=09 SYSTEM ID : http:/api.textmarketer.co.uk/services/rest/DTD/sms_delete.d=
td
-->
<!ELEMENT response (scheduled_id, status)>
<!ATTLIST response
=09 processed_date CDATA #REQUIRED
>
<!ELEMENT scheduled_id (#PCDATA)>
<!ELEMENT status (#PCDATA)>
=20
=20
=20
=20
------=_Part_15750_540154445.1614957982427--