KAkaleyra
3. List Records

GET /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.

Request

  • Base URL
    api.in.kaleyra.io (relative, and the document’s source URL is not known)
  • URL
    api.in.kaleyra.io/v1/{sid}/consent/list
  • Auth
    none declared. Required headers: api-key

Path parameters

sidstring required

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

Query parameters

channelstring required
Example:sms

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

status-1 | 0 | 1 | 2
Example:1

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

from_datestring date

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

to_datestring date

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

consent_categorystring
Example:marketing

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

sort_order'asc' | 'desc'
Example:desc

Sort order in ascending order or descending order.

pageinteger
Example:1

Page number for pagination.

limitinteger
Example:50

Number of records per page.

sort_bystring
Example:updated_at

Field to sort by. Example, created_at.

sender_identifierstring

Sender ID used to send the message.

contact_identifierstring

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

Headers

api-keystring required

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

Response

OK

object required

Changes

No recorded changes to this operation across all 1 revision of this API.