v1

latestOpenAPI 3.0.02026-07-2411724301.7 KB

default

Get Blocklist

get/v1/{sid}/contacts/blocklisted

Path parameters

sidstring required

Query parameters

limitinteger

Specifies the number of elements returned in the response.  Note: It is not possible to retrieve more than 100 contacts per response. By default, the limit is set to 100.

offsetinteger

Position in the dataset of a particular record. By specifying offset, you retrieve a subset of records starting with the offset value. By default, offset is set to 0 (which returns result for the first 100 contacts found).

channelstring

Channel for which the contacts are blocklisted. The acceptable value is "sms", "whatsapp", and "voice".

Headers

api-keystring required

Your API Key generated by Kaleyra.io.

Response

successful request

object required