Method : GET
Endpoint : /api/stoplist/
Description: method to get the list of contacts that are in the RCS stop list.
| Parameter | Mandatory | Type | Description. |
|---|---|---|---|
| page[limit] | No | integer | The number of records in the response. The range of values: min – 15, max – 500. The default is 50. |
| page[offset] | No | integer | Get stop list contacts starting from offset. The default is 0 |
| types | No | string | Type of the stop list for which you want to get the list of contacts. Possible values: sms, viber, rcs. If the sheet stop type is not specified, the method returns data for all sheet stop types. |
| Parameter | Type | Description. |
|---|---|---|
| id | integer | id of the contact that is in the stop list. |
| phone | string | Phone number of the contact. |
| created_at | datetime | The date when the contact was added to the stop list. |
| sms_stoplist | boolean | Indicates whether the contact is in the SMS stop list. Possible values: true/false. |
| viber_stoplist | boolean | Indicates whether the contact is in the Viber stop list. Possible values: true/false. |
| rcs_stoplist | boolean | Indicates whether there is a contact in the RCS stop list. Possible values: true/false. |
| total | string | Total number of contacts. |
{
"data":[
{
"id":9392897,
"phone":380661231231,
"created_at":"2022-04-18 19:22:16",
"sms_stoplist":true,
"viber_stoplist":true,
"rcs_stoplist":true
}
],
"total":1
}