Campaign
Retrieve a specific campaign
Copy
Ask AI
import sys
sys.path.append("../plivo-python")
import plivo
client = plivo.RestClient("<auth_id>", "<auth_token>")
response = client.campaign.list(limit=1, offset=0)
print(response)
Copy
Ask AI
{
"api_id": "4dea744b-7b9b-4525-a380-d2b2c26c523c",
"campaign": {
"campaign_id": "CY5JZZZ",
"registration_status": "ACTIVE",
"reseller_id": "",
"brand_id": "BOANNZO",
"usecase": "CUSTOMER_CARE",
"campaign_alias": "campaign name",
"mno_metadata": {
"AT&T": {
"tpm": 4500
},
"T-Mobile": {
"brand_tier": "TOP"
},
"US Cellular": {
"tpm": 4500
},
"Verizon Wireless": {
"tpm": 4500
}
},
"sample1": "You can confirm by responding to this text or by logging into the customer portal.",
"sample2": "Your next scheduled deposit is on [Deposit Date]",
"description": "We use this campaign for customer care communications for opted in customers.",
"campaign_attributes": {
"embedded_link": true,
"embedded_phone": true,
"age_gated": false,
"direct_lending": false,
"subscriber_optin": true,
"subscriber_optout": true,
"subscriber_help": true,
"affiliate_marketing": false
},
"message_flow": "Customer opts in by sending an inbound YES message.",
"help_message": "Reply YES to receive text communications, STOP to opt out. Call [Company Phone] for support. Msg rates may apply.",
"optout_message": "You will not receive any more text communications. Reply YES to subscribe.",
"created_at": "2023-04-04T15:21:01.064199Z",
"vertical": "ENTERNTAINMENT"
"campaign_source": "plivo"
}
}
This API lets you fetch details about a specific campaign associated with your account.
API Endpoint
GET
Copy
Ask AI
https://api.plivo.com/v1/Account/{auth_id}/10dlc/Campaign/{campaign_id}/
Arguments
No arguments need to be passed.
Returns
api_id and the campaign object identified by the campaign_id specified in the request URL.
Copy
Ask AI
import sys
sys.path.append("../plivo-python")
import plivo
client = plivo.RestClient("<auth_id>", "<auth_token>")
response = client.campaign.list(limit=1, offset=0)
print(response)
Copy
Ask AI
{
"api_id": "4dea744b-7b9b-4525-a380-d2b2c26c523c",
"campaign": {
"campaign_id": "CY5JZZZ",
"registration_status": "ACTIVE",
"reseller_id": "",
"brand_id": "BOANNZO",
"usecase": "CUSTOMER_CARE",
"campaign_alias": "campaign name",
"mno_metadata": {
"AT&T": {
"tpm": 4500
},
"T-Mobile": {
"brand_tier": "TOP"
},
"US Cellular": {
"tpm": 4500
},
"Verizon Wireless": {
"tpm": 4500
}
},
"sample1": "You can confirm by responding to this text or by logging into the customer portal.",
"sample2": "Your next scheduled deposit is on [Deposit Date]",
"description": "We use this campaign for customer care communications for opted in customers.",
"campaign_attributes": {
"embedded_link": true,
"embedded_phone": true,
"age_gated": false,
"direct_lending": false,
"subscriber_optin": true,
"subscriber_optout": true,
"subscriber_help": true,
"affiliate_marketing": false
},
"message_flow": "Customer opts in by sending an inbound YES message.",
"help_message": "Reply YES to receive text communications, STOP to opt out. Call [Company Phone] for support. Msg rates may apply.",
"optout_message": "You will not receive any more text communications. Reply YES to subscribe.",
"created_at": "2023-04-04T15:21:01.064199Z",
"vertical": "ENTERNTAINMENT"
"campaign_source": "plivo"
}
}
Copy
Ask AI
import sys
sys.path.append("../plivo-python")
import plivo
client = plivo.RestClient("<auth_id>", "<auth_token>")
response = client.campaign.list(limit=1, offset=0)
print(response)
Copy
Ask AI
{
"api_id": "4dea744b-7b9b-4525-a380-d2b2c26c523c",
"campaign": {
"campaign_id": "CY5JZZZ",
"registration_status": "ACTIVE",
"reseller_id": "",
"brand_id": "BOANNZO",
"usecase": "CUSTOMER_CARE",
"campaign_alias": "campaign name",
"mno_metadata": {
"AT&T": {
"tpm": 4500
},
"T-Mobile": {
"brand_tier": "TOP"
},
"US Cellular": {
"tpm": 4500
},
"Verizon Wireless": {
"tpm": 4500
}
},
"sample1": "You can confirm by responding to this text or by logging into the customer portal.",
"sample2": "Your next scheduled deposit is on [Deposit Date]",
"description": "We use this campaign for customer care communications for opted in customers.",
"campaign_attributes": {
"embedded_link": true,
"embedded_phone": true,
"age_gated": false,
"direct_lending": false,
"subscriber_optin": true,
"subscriber_optout": true,
"subscriber_help": true,
"affiliate_marketing": false
},
"message_flow": "Customer opts in by sending an inbound YES message.",
"help_message": "Reply YES to receive text communications, STOP to opt out. Call [Company Phone] for support. Msg rates may apply.",
"optout_message": "You will not receive any more text communications. Reply YES to subscribe.",
"created_at": "2023-04-04T15:21:01.064199Z",
"vertical": "ENTERNTAINMENT"
"campaign_source": "plivo"
}
}
Assistant
Responses are generated using AI and may contain mistakes.