1. Telebroad | Support Center
  2. Solution home
  3. Legacy API Documentation
  4. REST API - DELETE Requests
Open navigation

DELETE/sms/conversation (Legacy)

Articles in this support section discuss Telebroad's legacy APIs. To learn about the current version of Telebroad APIs, which offer additional authentication options and support for advanced features, please go to https://developers.telebroad.com/.


The specific current version of the DELETE/sms/conversation API is discussed here. 



The DELETE/sms/conversation request will delete one or more SMS conversations from the user's account. 

Parameters


All parameters go in the header.


Parameter
Type
Operation
SMS linestring
The SMS line from which the conversations are to be deleted.

You can get this from the GET/sms/lines request.
conversationinteger
The ID of the conversation to be deleted (several can be specified in one request, each in a separate parameter.)

You obtain this ID using the get/sms/conversations request.

Example


To delete a conversation with ID 19177224344 in the inbox directory for voicemail line 16468605270 use this syntax:


HTTPS method: DELETE


webserv.telebroad.com/api/teleconsole/rest/sms/conversation?sms_line=16468605270&conversation=19177324344


Response:


A "null" error indicates successful deletion.


Full details of the conversation that was deleted are included.


    {"error":null,

        "result":

        [{"id":"2567965","new":"0","direction":"out",

        "sender":"16468605270","receiver":"19177324344",

        "time":"1512318577",

        "msgdata":"Hi there, just wanted to see you got my                 report",

        "sent_by":"13697","read_by":"","seen":"0"},

        {"id":"2159236","new":"0","direction":"in",

        "sender":"19177324344","receiver":"16468605270",

        "time":"1500544816","msgdata":"I did. Looks     

        good.",

        "sent_by":null,"read_by":"13697","seen":"0"}

        ]}