Director de Campaña SMS

Visión General

Esta página describe los recursos que conforman la API REST v1 de Campaign Manager para cargar listas, y está dirigida a desarrolladores que desean integrar una fuente de datos directamente en la aplicación Campaign Manager.

La API REST de Mobile Gateway proporciona acceso a recursos (entidades de datos) a través de rutas URI. Para usar esta API, su aplicación realizará una solicitud HTTP y analizará la respuesta. El formato de respuesta es JSON.

Autenticación

El sistema básico de autenticación HTTP se utiliza para todas las solicitudes. Si accede a la API sin tener las credenciales correctas O el permiso para acceder a la API, obtendrá una respuesta HTTP 401.

Sus credenciales de la API de Campaign Manager son las mismas que se utilizan para iniciar sesión en Omni.  

También necesitará el nombre de la aplicación para su Campaign Manager.

El conjunto de credenciales será visible cuando inicie sesión en Modica, vaya a la pestaña de la aplicación Campaign Manager y haga clic en la pestaña ‘Info de API’.

Si no tiene estos detalles, comuníquese con support@modicagroup.com .

URI Base

Todo el acceso a la API es a través de HTTPS, y se accede desde https://api.modicagroup.com/rest/campaign_manager/v1/application_name/lists

Versiones

La versión de la API de Campaign Manager es actualmente v1.

Cargando una lista

Con exito:

HTTP/1.1 201 List Created
 
Location: https://api.modicagroup.com/rest/campaign_manager/v1/application_name/lists/list_id

Nota: La identificación de la lista que se devuelve se debe almacenar en su base de datos para eliminar la lista en el futuro. Envíe una solicitud POST utilizando los siguientes atributos para cargar una lista:

CAMPO DESCRIPCIÓN TIPO SUB TIPO REQUERIDO
name Nombre de la lista cadena Si
Batch Referencia de texto libre cadena No
email Enviar respuestas a esta dirección de correo electrónico cadena correo electrónico No
members Lista de miembros (destinos) para enviar el contenido a lista miembro Si
remove_opt_outs Eliminar opciones de exclusión de campañas anteriores - Valores predeterminados en True booleano No
strict_validation Si este indicador se establece en falso todas las líneas no válidas en la solicitud , se ignorarán y la lista  se cargará. Si hay líneas ignoradas, la respuesta informará sobre los números móviles ignorados. ejemplo, {“mensaje de error”: “Error de validación para +235456456445445, ignorado. Validación fallida para  +11, ignorada. “,“id”:126002} Si se establece en verdadero, la solicitud no se cargará. Verdadero es el valor predeterminado si este campo no está incluido. booleano No
info

El formato del número de móvil debe ser internacional, por ejemplo, +61421234567.

Actualmente se admite un máximo de 1 millón de miembros.

Solo para fines demostrativos:

{
    "name" : "List Name",
    "members" : [
        { "destination" : "+614123123123" },
        { "destination" : "+614123123122" },
        { "destination" : "+614123123121" },
        { "destination" : "+614123123120" }
    ]
}

Para generar una solicitud POST que incluya parámetros, el campo “miembros” (superior) deberá contener los parámetros que desea en el contenido:

CAMPO DESCRIPCIÓN TIPO SUB TIPO REQUERIDO
destinación El numero móvil para enviar el contenido a cadena si
param1 Parámetro de sustitución a incluir dentro del contenido. cadena no
param2 Parámetro de sustitución a incluir dentro del contenido. cadena no
param3 Parámetro de sustitución a incluir dentro del contenido. cadena no
param4 Parámetro de sustitución a incluir dentro del contenido. cadena no
param5 Parámetro de sustitución a incluir dentro del contenido. cadena no
param6 Parámetro de sustitución a incluir dentro del contenido. cadena no

Para propósitos demostrativos solamente:

{
    "name" : "List Name",
    "members" : [
        { "destination" : "+614123123123", "param1" : "Bob" },
        { "destination" : "+614123123122", "param1" : "Sarah" },
        { "destination" : "+614123123121", "param1" : "Tyler" },
        { "destination" : "+614123123120", "param1" : "Paul" }
    ]
}

Para Eliminar una Lista

Envíe una solicitud HTTP ELIMINAR utilizando el siguiente formulario para eliminar una lista:

https://api.modicagroup.com/rest/campaign_manager/v1/application_name/lists/{list_id}

Con éxito:

HTTP/1.1 204 List Deleted

Códigos de Error

Pueden ocurrir los siguientes errores:

Código Descripción
401 – Unauthorised Nombre de usuario y / o contraseña incorrectos
403 – Forbidden No se permite el acceso a la aplicación o, no se permite el acceso al administrador de campañas
404 Not Found URL es incorrecta o La lista ya ha sido eliminada
422 – Unprocessable Entry Errores de validación dentro de los datos.
4xx - Algo incorrecto con la solicitud.
5xx - Algo incorrecto con el servicio.

Error de muestra:

{
    "code" : 401,
    "message" : "unauthenticated for invalid credentials"
}

Para generar sus propias librerías de clientes. haga clic aqui here .