Consent Validate API

post

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

The Kaleyra platform enables you to retrieve consent status for the channel based on mobile numbers and specific filters included in the request in real-time.

The statuses that can be returned in the response are as follows:

Returned Status	Description
`-1`	Number Not Found in the database.
`0`	Opt-out.
`1`	Opt-in.
`2`	Deactivated.

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.

Body Params

channel

string

required

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

sender_identifier

string

required

Inbound Sender ID. Inbound Sender ID. In case of SMS, it’s the customer short code.

contact_identifiers

array of strings

required

Contact identifier of end-user or end-users mobile number.

contact_identifiers*

consent_category

string

Consent category. Example - Marketing, Transactional, or Promotional. Optional, defaults is for 'all' when no value is passed.

consent_topic

string

Consent topic. Example - Offers, Loan, or Insurance. Optional, defaults is for 'all' when no value is passed.

Headers

api-key

string

required

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

Responses

Language

Credentials

Header

URL

Loading…

Response

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

application/json

200OK

401Unauthorized