List Records API

get

https://api.in.kaleyra.io/v1/{sid}/consent/list

The Kaleyra platform allows you to extract end-users' mobile numbers based on specific filters provided in the request and retrieve their corresponding consent data.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

sid

string

required

Account SID (Security Identifier). For more information, see View API Key and SID.

Query Params

channel

string

required

Channel name for which you want to update the consent. Example - sms.

status

integer

enum

The statuses that will be returned in the response. Example,
-1 - Number Not Found in database
0 - Opt-out
1 - OPT_IN
2 - Deactivated.

Allowed:

from_date

date

The start date from which you want to list the consent record in (YYYY-MM-DD) format.

to_date

date

The end date up to which you want to list the consent record in (YYYY-MM-DD) format.

consent_category

string

Message category, like marketing or promotional, for which consent is given or revoked.

sort_order

string

enum

Sort order in ascending order or descending order.

Allowed:

page

integer

Page number for pagination.

limit

integer

Number of records per page.

sort_by

string

Field to sort by. Example, created_at.

sender_identifier

string

Sender ID used to send the message.

contact_identifier

string

specific contact to fetch for or the end-user's mobile number.

Headers

api-key

string

required

API key generated from the Kaleyra platform account. For more information, see View API Key and SID.

Responses

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

401Unauthorized