Sign in

v1

latestOpenAPI 3.0.02026-07-2411724301.7 KB
2. 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 StatusDescription
-1Number Not Found in the database.
0Opt-out.
1Opt-in.
2Deactivated.
post/v1/{sid}/consent/validate

Path parameters

sidstring required

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

Headers

api-keystring required

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

Request body

channelstring required

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

sender_identifierstring required

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

contact_identifiersstring[] required

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

consent_categorystring

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

consent_topicstring

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

Response

OK

object required