Retrieve configuration

GET
https://api.octopush.com/v1/public/user/campaign-parameters

Encoding : UTF-8

Authentication

Your “api-key” and “api-login” must be added in the headers.

Definition

Allows you to recover your default configuration for your SMS campaigns.

Special parameters

NameTypeDescription

Curl Example

curl -X GET \ 
'https://api.octopush.com/v1/public/user/campaign-parameters' \ 
-H 'Content-Type: application/json' \ 
-H 'api-key: ************' \ 
-H 'api-login: ******@email.org' \ 
-H 'cache-control: no-cache' \ 

JSON Response

Success : 200 OK

{
  "sms_campaign_alert_parameters": {
    "alert_type": "sms_premium",
    "alert_bound": 150,
    "alert_email_to": "my_email@email.com",
    "alert_phone_number_to": "+33611121314"
  },
  "campaign_parameters": {
    "sender_for_sms_premium": "12345",
    "sender_for_vocal_sms": "12345",
    "phone_number_for_test_sms": "+33611121314"
  },
  "callbacks": {
    "callback_url_for_inbounds": "https://mywebhook.dns/webhook-1",
    "callback_url_for_deliveries": "https://mywebhook.dns/webhook-2",
    "callback_url_for_blacklisted_numbers": "https://mywebhook.dns/webhook-3",
    "callback_url_for_vocal_sms_deliveries": "https://mywebhook.dns/webhook-4",
    "email_for_inbounds": "my_email@email.com"
  }
}