Accueil » API SMS Octopush » API Paramètres par défaut » Modifier la configuration

Modifier la configuration

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

Encodage : UTF-8

Authentification

Vos identifiants « api-key » et « api-login » doivent être ajoutés dans les headers.

Définition

Permet de modifier votre configuration par défaut pour les campagnes de SMS.

Paramètres particuliers

NomTypeDescription
sms_campaign_alert_parametersarrayTableau contenant les paramètres d’alerte.
alert_typestringType de SMS pour décider du seuil d’alerte.
alert_boundintegerSeuil d’alerte.
alert_email_tostringAdresse e-mail à laquelle envoyer les alertes.
alert_phone_number_tostringNuméro de téléphone mobile auquel envoyer les alertes.
campaign_parametersarrayTableau contenant les paramètres de campagne.
sender_for_sms_premiumstringSender par défaut de vos campagnes SMS. 3 à 11 caractères alphanumériques.
sender_for_vocal_smsstringSender par défaut de vos campagnes Vocale. 3 à 11 caractères numériques.
phone_number_for_test_smsstringNuméro de téléphone par défaut présenté lors de la création de campagne sur votre interface en ligne.
callbacksarrayTableau contenant les URLs de callbacks.
callback_url_for_sms_deliveriesstringURL à laquelle vous souhaiteriez recevoir les callbacks de AR SMS.
callback_url_for_blacklisted_numbersstringURL à laquelle vous souhaiteriez recevoir les demandes de désinscription (stops).
callback_url_for_vocal_sms_deliveriesstringURL à laquelle vous souhaiteriez recevoir les callbacks de AR SMS Vocal.
callback_url_for_inboundsstringURL à laquelle vous souhaiteriez recevoir les callbacks de SMS entrants.
email_for_inboundsstringAdresse email à laquelle vous souhaiteriez qu’on vous transfère les SMS entrants.

Exemple Curl

curl -X PATCH \ 
'https://api.octopush.com/v1/public/user/campaign-parameters/edit' \ 
-H 'Content-Type: application/json' \ 
-H 'api-login: ******@email.org' \ 
-H 'api-key: ************' \ 
-H 'cache-control: no-cache' \ 
-d '{
  "sms_campaign_alert_parameters": {
    "alert_type": "sms_low_cost",
    "alert_bound": 150,
    "alert_email_to": "[email protected]",
    "alert_phone_number_to": "+336971433333"
  },
  "campaign_parameters": {
    "sender_for_sms_premium": "12345",
    "sender_for_vocal_sms": "12345",
    "phone_number_for_test_sms": "+3356478465456"
  },
  "callbacks": {
    "callback_url_for_inbounds": "https://mywebhook.dns/webhook-1",
    "callback_url_for_sms_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": "[email protected]"
  }
}'

Code à copier-coller

curl -X PATCH 'https://api.octopush.com/v1/public/user/campaign-parameters/edit' -H 'Content-Type: application/json' -H 'api-login: ******@email.org' -H 'api-key: ************' -H 'cache-control: no-cache' -d '{"sms_campaign_alert_parameters": {"alert_type": "sms_low_cost", "alert_bound": 150, "alert_email_to": "[email protected]", "alert_phone_number_to": "+336971433333"}, "campaign_parameters": {"sender_for_sms_premium": "12345", "sender_for_vocal_sms": "12345", "phone_number_for_test_sms": "+3356478465456"}, "callbacks": {"callback_url_for_inbounds": "https://mywebhook.dns/webhook-1", "callback_url_for_sms_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": "[email protected]"}}'

Retour Server en json

Succès : 200 OK