Developer Docs

Table of contents

Get list by ID

The method allows to get information about the contact list by its identifier. 

To get list by ID, make a request to this URL:

GET http://one-api.bsg.world/api/groups/{id}

Request parameters:

ParameterRequiredTypeDescription 
idYesintegerThe contact list ID that is generated by the BSG system when the list is created

Response parameters:

ParameterTypeDescription 
idintegerContact list ID
namestringContact list name
descriptionstringContact list description
defaultbooleanWhether the contact list is a default one: true or false value
created_atdatetimeDate and time when the contact list was created. Display format Y-m-d H:i:s
itemsstringThe number of numbers in the contact list.
stop_list_countstringThe number of numbers that are in the stop list of SMS and Viber.

If request is successful, you will receive a response:

{
  "data": {
    "id": 1,
    "name": "string",
    "description": "string",
    "default": 0,
    "created_at": "2022-04-28 14:21:16",
    "items": 10,
    "stop_list_count": 0
  }
}