Desarrolladores

DELETE/tcr/v2/campaign/{campaignId}

Desactivar una campaña de mensajería

Dé de baja una campaña, concilie sus asignaciones de números y comprenda la respuesta vacía que indica éxito.

En esta página
  1. Desactivar una campaña de mensajería existente
  2. Elimine primero las asignaciones de los números afectados
  3. Envíe la solicitud de desactivación prevista
  4. Verifique tanto el registro como las asignaciones
  5. La baja es independiente de la liquidación de la cuenta

Desactivar una campaña de mensajería existente

Utilice esta ruta para dar de baja una campaña perteneciente a la cuenta. Conserve el identificador de la campaña para la conciliación y el historial. Para corregir el contenido o actualizar el texto de consentimiento, utilice Actualizar una campaña de mensajería en su lugar.

Autentíquese con una cuenta de API habilitada mediante HTTPS desde una dirección IP de origen permitida. Consulte primero la campaña y compruebe la marca asociada y los números de envío. La desactivación modifica el registro; no crea una campaña de reemplazo ni traslada números a otra campaña.

curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"

Elimine primero las asignaciones de los números afectados

La operación pública DELETE de campañas no desvincula los números de teléfono del operador de mensajería ni elimina su asignación local. Utilice el flujo para eliminar la asignación de un número a una campaña para cada número afectado perteneciente a la cuenta y, después, verifique su asignación. Eliminar una asignación no libera el número de teléfono.

El flujo más amplio del portal, Eliminar marca, realiza la limpieza de sus campañas y números antes de eliminar esa marca. No utilice esa acción si desea conservar la marca y sus demás campañas. El editor habitual de campañas no ofrece actualmente un botón independiente para eliminar campañas equivalente a esta ruta directa de la API.

Envíe la solicitud de desactivación prevista

Tras revisar el identificador de la campaña y la configuración de envío afectada, envíe DELETE sin cuerpo JSON:

curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
  --request DELETE \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  "https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"

La respuesta de éxito documentada es HTTP 204 con el cuerpo vacío. Examine el estado HTTP en lugar de esperar una estructura envolvente JSON de tipo status/response. Cuando se acepta la eliminación, el servicio actual marca localmente el recurso de la campaña como eliminado y caducado, y marca su registro de campaña heredado como caducado. No elimina la marca en cascada.

Utilice una única clave de idempotencia para esta solicitud prevista y conserve exactamente el método, la ruta, la consulta y los bytes del cuerpo para repetirla. Una solicitud duplicada cuya original se esté procesando puede devolver 409 con Retry-After; las solicitudes completadas pueden reproducir el resultado almacenado. Un error almacenado en caché o una conexión interrumpida no permite determinar si el registro ya ha actuado. Conserve el identificador de la campaña y requestId cuando esté presente.

Verifique tanto el registro como las asignaciones

Compruebe el estado actual de la campaña y los números afectados en el portal después de la solicitud. La API puede conservar metadatos locales de titularidad tras la baja, de modo que aún se pueda consultar un identificador perteneciente a la cuenta; no deduzca que el mismo identificador deba devolver siempre un 404 local. El registro determina el estado devuelto o la disponibilidad del registro dado de baja.

Si un número sigue asignado, concilie esa asignación existente. No cree otra campaña simplemente para reintentar la desactivación ni suponga que un HTTP 204 demuestra que se realizó la limpieza en el operador. Si la sincronización local falla después de que el registro acepte la solicitud, la API puede devolver 500 aunque la desactivación externa ya se haya realizado.

Resultados de la desactivación
ResultadoSiguiente paso
204No se espera ningún cuerpo de respuesta. Verifique el estado de la campaña y las asignaciones de números, que se gestionan de forma independiente.
400Lea el error de validación o de estado del registro proporcionado. Compruebe el identificador exacto de la campaña y su estado existente.
401, 403, 404Compruebe las credenciales de la API, la IP de origen permitida y la titularidad de la cuenta. No utilice en su lugar un identificador de otro cliente.
409, 429Distinga una solicitud idempotente en curso o en conflicto de una limitación de la frecuencia de solicitudes; respete Retry-After cuando se proporcione.
500, 502 o tiempo de espera agotadoConserve los detalles de la solicitud, consulte la campaña existente y concilie su estado antes de enviar otra solicitud.

La baja es independiente de la liquidación de la cuenta

El servicio DELETE actual no genera un cargo inmediato por el registro de la campaña. Esto no garantiza un reembolso, no anula un compromiso existente ni libera los números alquilados. Consulte en el portal las condiciones de las campañas de la cuenta y las facturas pendientes. El alquiler de números y el consumo de mensajes son independientes del registro de la campaña.

Si va a dar de baja todo el registro de la empresa una vez conciliadas sus campañas y asignaciones, continúe con la baja de la marca.