Inicio » API SMS Octopush » API Parámetros por defecto » Editar configuración

Editar configuración

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

Codificación : UTF-8

Autentificación

Su “api-key” y “api-login” deben ser añadidos en las cabeceras.

Definición

Permite cambiar la configuración por defecto de las campañas de SMS.

Parámetros especiales

NombreTipoDescripción
sms_campaign_alert_parametersarrayTabla con los parámetros de la alerta.
alert_typestringTipo de SMS para decidir el umbral de alerta.
alert_boundintegerUmbral de advertencia.
alert_email_tostringDirección de correo electrónico a la que enviar las alertas.
alert_phone_number_tostringNúmero de teléfono móvil al que enviar las alertas.
campaign_parametersarrayTabla con los parámetros de la campaña.
sender_for_sms_premiumstringRemitente por defecto para sus campañas de SMS. De 3 a 11 caracteres alfanuméricos.
sender_for_vocal_smsstringRemitente por defecto para sus campañas de voz. De 3 a 11 caracteres numéricos.
phone_number_for_test_smsstringNúmero de teléfono por defecto que se presenta al crear una campaña en su interfaz en línea.
callbacksarrayTabla que contiene las URL de devolución de llamada.
callback_url_for_sms_deliveriesstringURL donde desea recibir las llamadas de AR SMS.
callback_url_for_blacklisted_numbersstringURL donde desea recibir las solicitudes de baja (stops).
callback_url_for_vocal_sms_deliveriesstringURL donde desea recibir las llamadas de AR SMS Voice.
callback_url_for_inboundsstringURL a la que desea recibir las llamadas entrantes de los SMS.
email_for_inboundsstringDirección de correo electrónico a la que desea recibir los mensajes SMS entrantes.

Ejemplo Curl

curl -X PATCH \ 
'https://api.octopush.com/v1/public/user/campaign-parameters/edit' \ 
-H 'Content-Type: application/json' \ 
-H 'api-key: ************' \ 
-H 'api-login: ******@email.org' \ 
-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]"
  }
}'

Respuesta Servidor en JSON

Éxito: 200 OK