This method deletes a recipient from a contact list. Possible results from this method are:



DELETED - recipient was deleted succesfully.
DELETE FAILED - recipient was not deleted because they did not exist on the contact list (possibly previously deleted).


  • list_id - list identifier required in one of the two following formats:

    • integer - the list id as a numeric value, this can be found by requesting 'contact-lists.get' and using corresponding id values from the dataset
      OR

    • string - the list name EXACTLY as it is in the 'contact-lists.get' response.



  • mobile - string - recipients mobile number in INTERNATIONAL format (the mobile number as returned in a 'contact-lists.get-recipients' call)


 




 




XML Request Example


<?xml version='1.0'?>

<request>
<interface>PHP</interface>
<version>0.3</version>
<key>API_KEY</key>
<secret>API_SECRET</secret>
<method>contact-lists.delete-recipient</method>
<params>
<list_id>175</list_id>
<mobile>6141xxxxxxx</mobile>
</params>
</request>







XML Response Example


<?xml version='1.0'?>

<xml>
<method>contact-lists.delete-recipient</method>
<total>1</total>
<time>2009-12-21 23:07:05 GMT</time>
<timestamp>1261436825 GMT</timestamp>
<result>DELETED</result>
</xml>







PHP Example


<?xml version='1.0'?>

<request>
<interface>PHP</interface>
<version>0.3</version>
<key>API_KEY</key>
<secret>API_SECRET</secret>
<method>recipient.delete-global</method>
<params>
<mobile>6141xxxxxx</mobile>
</params>
</request>






GET Example


Using a URL based request system you can request this method by using the below URL - be sure to url encode all your variables!


http://burst.transmitsms.com/api-wrapper/contact-lists.delete-recipient?apikey=API_KEY&apisecret=API_SECRET&list_id=LIST_ID&mobile=MOBILE