Retrieve all campaigns
import sys
sys.path.append("../plivo-python")
import plivo
client = plivo.RestClient("<auth_id>", "<auth_token>")
response = client.campaign.get_number(
campaign_id="<campaign_id>", number="14845197139"
)
print(response)
{
"api_id": "f5013b11-8d0e-4156-b7a2-feeea076b6fb",
"meta": {
"limit": 1,
"offset": 0,
"next": "/v1/Account/<auth_id>/10dlc/Campaign/?limit=1&offset=1",
"previous": null,
"total_count": 16
},
"campaigns": [
{
"campaign_id": "CY2UXXX",
"registration_status": "FAILED",
"reseller_id": "",
"brand_id": "BANGXXX",
"usecase": "2FA",
"campaign_alias": "campaign name",
"mno_metadata": {
"AT&T": {
"tpm": 4500
},
"T-Mobile": {
"brand_tier": "TOP"
},
"US Cellular": {
"tpm": 4500
},
"Verizon Wireless": {
"tpm": 4500
}
},
"sample1": "Your one-time passcode is {{6 DIGIT CODE}}. Please do not reply to this message.",
"sample2": "Your one-time passcode is {{6 DIGIT CODE}}.",
"description": "We use this campaign to send multi factor authentication 6 digit codes to end users and customers.",
"campaign_attributes": {
"embedded_link": false,
"embedded_phone": false,
"age_gated": false,
"direct_lending": false,
"subscriber_optin": true,
"subscriber_optout": true,
"subscriber_help": true,
"affiliate_marketing": false
},
"message_flow": "Agents and customers using our service daily. Agents login required to validate the MFA code. Customers login required to validate the MFA code. ",
"help_message": "Please call {800 number} if you're having issues with login.",
"optout_message": "You are not going to receive MFA codes by SMS moving forward.",
"created_at": "2023-09-25T20:36:00.83971Z",
"vertical": "ENTERNTAINMENT"
"campaign_source": "plivo"
}
]
}
This API lets you fetch all the campaigns associated with an account.
API Endpoint
https://api.plivo.com/v1/Account/{auth_id}/10dlc/Campaign/
Arguments
limit integer | Denotes the number of results per page. The maximum number of results that can be fetched is 20. Defaults to 20. |
offset integer | Denotes the number of value items by which the results should be offset. Defaults to 0. Read more about offset-based pagination. |
usecase string | Filter by use case. Allowed values: |
brand_id string | Filters results by a brand_id |
registration_status string | Filter by registration status of a campaign. Allowed values: |
campaign_source string | Filters results by campaign source. Allowed values: |
Returns
api_id and a dictionary with an objects property that contains up to 20 campaigns. Each tuple in the list is a separate Campaign object.
import sys
sys.path.append("../plivo-python")
import plivo
client = plivo.RestClient("<auth_id>", "<auth_token>")
response = client.campaign.get_number(
campaign_id="<campaign_id>", number="14845197139"
)
print(response)
{
"api_id": "f5013b11-8d0e-4156-b7a2-feeea076b6fb",
"meta": {
"limit": 1,
"offset": 0,
"next": "/v1/Account/<auth_id>/10dlc/Campaign/?limit=1&offset=1",
"previous": null,
"total_count": 16
},
"campaigns": [
{
"campaign_id": "CY2UXXX",
"registration_status": "FAILED",
"reseller_id": "",
"brand_id": "BANGXXX",
"usecase": "2FA",
"campaign_alias": "campaign name",
"mno_metadata": {
"AT&T": {
"tpm": 4500
},
"T-Mobile": {
"brand_tier": "TOP"
},
"US Cellular": {
"tpm": 4500
},
"Verizon Wireless": {
"tpm": 4500
}
},
"sample1": "Your one-time passcode is {{6 DIGIT CODE}}. Please do not reply to this message.",
"sample2": "Your one-time passcode is {{6 DIGIT CODE}}.",
"description": "We use this campaign to send multi factor authentication 6 digit codes to end users and customers.",
"campaign_attributes": {
"embedded_link": false,
"embedded_phone": false,
"age_gated": false,
"direct_lending": false,
"subscriber_optin": true,
"subscriber_optout": true,
"subscriber_help": true,
"affiliate_marketing": false
},
"message_flow": "Agents and customers using our service daily. Agents login required to validate the MFA code. Customers login required to validate the MFA code. ",
"help_message": "Please call {800 number} if you're having issues with login.",
"optout_message": "You are not going to receive MFA codes by SMS moving forward.",
"created_at": "2023-09-25T20:36:00.83971Z",
"vertical": "ENTERNTAINMENT"
"campaign_source": "plivo"
}
]
}
import sys
sys.path.append("../plivo-python")
import plivo
client = plivo.RestClient("<auth_id>", "<auth_token>")
response = client.campaign.get_number(
campaign_id="<campaign_id>", number="14845197139"
)
print(response)
{
"api_id": "f5013b11-8d0e-4156-b7a2-feeea076b6fb",
"meta": {
"limit": 1,
"offset": 0,
"next": "/v1/Account/<auth_id>/10dlc/Campaign/?limit=1&offset=1",
"previous": null,
"total_count": 16
},
"campaigns": [
{
"campaign_id": "CY2UXXX",
"registration_status": "FAILED",
"reseller_id": "",
"brand_id": "BANGXXX",
"usecase": "2FA",
"campaign_alias": "campaign name",
"mno_metadata": {
"AT&T": {
"tpm": 4500
},
"T-Mobile": {
"brand_tier": "TOP"
},
"US Cellular": {
"tpm": 4500
},
"Verizon Wireless": {
"tpm": 4500
}
},
"sample1": "Your one-time passcode is {{6 DIGIT CODE}}. Please do not reply to this message.",
"sample2": "Your one-time passcode is {{6 DIGIT CODE}}.",
"description": "We use this campaign to send multi factor authentication 6 digit codes to end users and customers.",
"campaign_attributes": {
"embedded_link": false,
"embedded_phone": false,
"age_gated": false,
"direct_lending": false,
"subscriber_optin": true,
"subscriber_optout": true,
"subscriber_help": true,
"affiliate_marketing": false
},
"message_flow": "Agents and customers using our service daily. Agents login required to validate the MFA code. Customers login required to validate the MFA code. ",
"help_message": "Please call {800 number} if you're having issues with login.",
"optout_message": "You are not going to receive MFA codes by SMS moving forward.",
"created_at": "2023-09-25T20:36:00.83971Z",
"vertical": "ENTERNTAINMENT"
"campaign_source": "plivo"
}
]
}