Skip to main content

Documentation Index

Fetch the complete documentation index at: https://plivo.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Fetches details about what kind of campaigns are supported under a particular brand ID.

​
API Endpoint

GET
https://api.plivo.com/v1/Account/{auth_id}/Brand/{brand_id}/usecases/

​
Arguments

No arguments need to be passed.

​
Returns

api_id, brand_id and a tuple containing all the types of campaign types allowed for the brand. 
import sys
sys.path.append("../plivo-python")
import plivo

client = plivo.RestClient("<auth_id>", "<auth_token>") 

response = client.brand.get_usecases(brand_id='<Brand_ID>') 
print(response)

​
Response

Response
{
"api_id": "0db62668-5f2d-11ed-bee0-0242ac110002",
"brand_id": "BJZN6KW",
"use_cases": [
{
"code": "2FA",
"details": "Any two-factor authentication with passcodes used to unlock accounts",
"name": "Two-Factor Authentication"
},
{
"code": "ACCOUNT_NOTIFICATION",
"details": "Notification sent to account holders about changes in accounts",
"name": "Account Notification"
},
{
"code": "CUSTOMER_CARE",
"details": "Customer care interactions by the support and other customer-facing teams",
"name": "Customer Care"
},
{
"code": "DELIVERY_NOTIFICATION",
"details": "Updates about the delivery of products and services",
"name": "Delivery Notification"
},
{
"code": "FRAUD_ALERT",
"details": "Notifications of suspicious behavior identified the business",
"name": "Fraud Alert"
},
{
"code": "HIGHER_EDUCATION",
"details": "Messages sent by colleges, universities, and other educational institutions",
"name": "Higher Education"
},
{
"code": "LOW_VOLUME",
"details": "A combination of two to five standard usage cases - for low throughput requirements",
"name": "Low Volume"
},
{
"code": "MARKETING",
"details": "Communications related to time-bound events and sales",
"name": "Marketing"
},
{
"code": "MIXED",
"details": "A combination of two to five standard usage cases",
"name": "Mixed"
},
{
"code": "POLLING_VOTING",
"details": "Surveys, polling, and voting campaigns used for non-political purposes",
"name": "Polling Voting"
},
{
"code": "PUBLIC_SERVICE_ANNOUNCEMENT",
"details": "Messages aimed at creating awareness about important topics",
"name": "Public Service Announcement"
},
{
"code": "SECURITY_ALERT",
"details": "Notifications that alert users about a potential breach of systems",
"name": "Security Alert"
}
]
}