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/.
Function and Response Fields
The GET/sms/lines is a simple request that returns a list of all SMS lines for a user. It is useful for other SMS-related requests such as GET/SMS/Conversations or POST/send/SMS.
The same information can also be obtained from the get/myProfile request, but many non-relevant fields will also be returned.
The request returns the following fields of information:
- sms_line - the phone number of the SMS line.
- sms_linename - the name associated with the SMS line
Parameters
None are required. The Limit and Offset optional parameters may be used if dealing with a large list of lines (rarely, if ever, the case.)
Only the Username and Password for the relevant account need to be supplied using basic authorization on your API client app.
Example
To get the list of SMS lines for a user use this syntax:
HTTPS method: GET
webserv.telebroad.com/api/teleconsole/rest/sms/lines
Response:
{
"error":null,
"result":
[{"sms_line":"13106731860",
"sms_linename":"Mike Robinson main"},
{"sms_line":"13106731861",
"sms_linename":"Mike Robinson backup"}
]
}