EntitlementsResource
The entitlements resource provides methods for managing special features and permissions on your Contiguity account.
list()
await contiguity.entitlements.list(): Promise<any>
const entitlements = await contiguity.entitlements.list();
console.log(entitlements);
get()
await contiguity.entitlements.get(name: string): Promise<any>
The name of the entitlement to retrieve.
const entitlement = await contiguity.entitlements.get('imessage');
console.log(entitlement);
apply()
await contiguity.entitlements.apply(name: string): Promise<any>
The name of the entitlement to apply.
const result = await contiguity.entitlements.apply('imessage');
console.log('Entitlement applied:', result);
revoke()
await contiguity.entitlements.revoke(name: string): Promise<any>
The name of the entitlement to revoke.
await contiguity.entitlements.revoke('imessage');
console.log('Entitlement revoked');
Complete Example
import { Contiguity } from 'contiguity';
const contiguity = new Contiguity('contiguity_sk_...');
// Step 1: List all available entitlements
const all = await contiguity.entitlements.list();
console.log('Available entitlements:', all);
// Step 2: Check if a specific entitlement is available
const imessage = await contiguity.entitlements.get('imessage');
if (imessage.available) {
console.log('iMessage entitlement is available');
}
// Step 3: Apply an entitlement
if (!imessage.active) {
await contiguity.entitlements.apply('imessage');
console.log('iMessage entitlement activated');
}
// Step 4: Use the entitlement
await contiguity.imessage.send({
to: '+1234567890',
message: 'Hello via iMessage!'
});
// Step 5: Revoke entitlement when no longer needed
await contiguity.entitlements.revoke('imessage');
console.log('iMessage entitlement deactivated');
Common Entitlements
Here are some common entitlements you might work with:
imessage - Enable iMessage sending capabilitieswhatsapp - Enable WhatsApp messagingvoice - Enable voice calling featureshigher_limits - Increase rate limits and quotaspriority_support - Access to priority support channelscustom_branding - Remove Contiguity branding from messages
Checking Entitlement Status
const checkEntitlement = async (name: string) => {
try {
const entitlement = await contiguity.entitlements.get(name);
if (entitlement.active) {
console.log(`${name} is active`);
} else if (entitlement.available) {
console.log(`${name} is available but not active`);
} else {
console.log(`${name} is not available for your account`);
}
return entitlement;
} catch (error) {
console.error(`Error checking ${name}:`, error);
}
};
await checkEntitlement('imessage');
await checkEntitlement('whatsapp');
Error Handling
try {
await contiguity.entitlements.apply('premium_feature');
} catch (error) {
if (error.message.includes('not available')) {
console.log('This entitlement requires an upgrade');
} else if (error.message.includes('already active')) {
console.log('Entitlement is already applied');
} else {
console.error('Error applying entitlement:', error);
}
}
Notes
- Some entitlements may require account upgrades or additional billing
- Entitlements may have prerequisites (e.g., domain verification for certain features)
- Revoking an entitlement doesn’t immediately disable in-flight operations
- Check entitlement status before attempting to use premium features
