Categorías

3
Aplicaciones
 1
Consultas de Facturación
 9
Correo
 1
Dominios
 2
Glosario
 2
GSUITE
 10
Maxmailer 2.0
 16
Soporte Técnico Cpanel (Linux)
 8
Soporte Técnico General
 13
Soporte Técnico Windows (Plesk)
3
Streaming y Otros Servicios
 2
Zona de programación

  Categorías

  Soporte

  Mis Tickets de Soporte   Anuncios   Preguntas Frecuentes - FAQ   Descargas   Estado de la Red   Abrir Ticket

API - Funciones disponibles Imprimir

  • 1
ListUsers - Lista los usuarios creados en el sistema. Si la consulta es ejecutada por el administrador, la lista de usuarios incluirá sus usuarios individuales, los resellers (o user-manager) y los sub usuarios de cada reseller.
GetUser - Obtiene los datos específicos de un usuario, así como también sus limites y estadísticas de uso.
CreateUser - Permite la creación de usuarios.
AddCredit - Agrega credito para envio de emails a un usuario. Esta funcion solo es valida para usuarios con asignacion de envios "Unica vez".
DeleteUser - Elimina un usuario.
ChangePassword - Cambia la contraseña de acceso de un usuario.
SuspendUser - Suspende un usuario inhabilitándolo para acceder al sistema.
UunsuspendUser - Quita la suspensión de un usuario.
ListCaps - Obtiene la lista de campañas/mensajes activas y finalizadas.
GetCamp - Obtiene los detalles de una determinada campaña/mensajes y sus reportes.


ListUser

Available for: admin and user-manager
Admin o User-manager login ID is required.
No inputs required
Return values: Array with user data:
uname username
name name
lastname lastname
email email
max_sends maximun number of send allowed
max_list maximun number of lists allowed
max_suscribers maximun number of subscribers allowed
allow_attach [0|1] File attachments allowed
attach_max_size maximun number of Kbytes allowed for the files attached
max_message_size maximun number of Kbytes allowed for the message size
allow_bounce [0|1] allow bounced utilization
allow_forms [0|1] allow forms creation
allow_api [0|1] allow api access
max_users [number] maximun number of users allowed to created. Only for user-managers
smtp [0|1] use custom SMTP server
smtp_host Custom SMTP server hostname
smtp_user Custom SMTP server username
smtp_pass Custom SMTP server password
parent_id ID of the parrent user creator
lastLogin [UnixTime] Date of the last login in UNIX format
dateCreated [UnixTime] Date of the user creation in UNIX format
susp_date [UnixTime] suspended user date in UNIX format. 0=Not suspended.
trial [Number] Day of the trial period
allow_embedded [0|1]
status [active|suspended] account status
usertType [user|admin|reseller|demo] account type
max_sends_period [one_time|daily|weekly|monthly] send type

 

Error codes:

9001 You are not allowed to get users information

GetUser

 

Available for: admin and user-manager
Admin o User-manager login ID is required.
Parameters:
id [number] ID of the username
Return values:
uname username
name name
lastname lastname
email email
max_sends maximun number of send allowed
max_list maximun number of lists allowed
max_suscribers maximun number of subscribers allowed
allow_attach [0|1] File attachments allowed
attach_max_size maximun number of Kbytes allowed for the files attached
max_message_size maximun number of Kbytes allowed for the message size
allow_bounce [0|1] allow bounced utilization
allow_forms [0|1] allow forms creation
allow_api [0|1] allow api access
max_users [number] maximun number of users allowed to created. Only for user-managers
smtp [0|1] use custom SMTP server
smtp_host Custom SMTP server hostname
smtp_user Custom SMTP server username
smtp_pass Custom SMTP server password
parent_id ID of the parrent user creator
lastLogin [UnixTime] Date of the last login in UNIX format
dateCreated [UnixTime] Date of the user creation in UNIX format
susp_date [UnixTime] suspended user date in UNIX format. 0=Not suspended.
trial [Number] Day of the trial period
allow_embedded [0|1]
status [active|suspended] account status
usertType [user|admin|reseller|demo] account type
max_sends_period [on_time|daily|weekly|monthly] send type
available_sends [number] number of send available in the current period
email_sent_in_period [number] number of emails sent in the current period
current_subscribers [number] current number of subscribers in all lists
limit_reset [date] date of the sending count reset dd/mm/yyyy

Error codes:

4001 You are not allowed to get user information
4002 Unknow user ID.

CreateUser

 

Available for: admin and user-manager
Admin o User-manager login ID is required.
Parameters:
username 3 to 15 chars
password password 5 to 15 chars (1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-_$@)
name 0 to 40 chars, name of the user
lastname 0 to 40 chars, lastname of the user
email email address of the user (syntax is checked)
max_sends [number] maximun number of send allowed. 0=unlimited
max_sends_type [0|1|2|3] send type 0=one time, 1=daily, 2= weekly, 3=monthly (Only for admins)
max_list [number] maximun number of list allowed. 0=unlimited
max_suscribers [number] maximun number of subscribers allowed. 0=unlimited
allow_attach [0|1] allow attachments
attach_max_size [number] maximun number of Kbytes allowed for the files attached to the message.
max_message_size [number] maximun number of Kbytes allowed for the message size. 0=unlimited
allow_bounce [0|1] allow bounced utilization
allow_forms [0|1] allow forms creation
allow_api [0|1] allow api access
allow_embedded [0|1] allow images embedded in email body
trial [number] number of days the account life. 0=disabled
is_demo [0|1] Account type. 0 or blank=normal user, 1=demo user
Return values:
status "User created"
user_ID New user ID

Error codes:
2001 You don't have permissions to create users.
2002 Username contain invalid charactes.
2003 Password contain invalid charactes.
2004 max_sends must be a number.
2005 max_message_size must be a number.
2006 max_list must be a number.
2007 Invalid email address.
2008 This username is in use.
2009 Your license does not allow you to assign unlimited subscribers.
2010 Can not allocate more subscribers than your license allow.
2011 You can not asign more subscribers than license allows you to.
2012 Your license does not allow you to assign X subscribers.
2013 You do not have enough lists to assign.
2014 Can not allocate more than X lists.
2015 Can not allocate more than X lists.
2016 You do not have enough sends to assign.
2016 Can not allocate more than X sends
2017 Can not allocate more than X sends
2019 Your account will not allows you to assign unlimited subscribers.
2020 Your license does not allow you to assign X subscribers.
2021 Your license does not allow you to assign X subscribers.
2022 Your account allows you to assign no more than X subscribers.
2023 The system can not allocate X subscribers. Please contact the administrator.
2024 Messages can not allocate more than X kB
2025 Your are not allowed to create more users.

DeleteUser

 

Available for: admin and user-manager
Admin o User-manager login ID is required.
Parameters:
id [number] ID of the username
Return values:
status "User deleted"
Error codes:
8001 You don't have permissions to delete users
8002 Unknow user ID.

ChangePassword

 

Available for: admin and user-manager
Admin o User-manager login ID is required.
Parameters:
id [number] ID of the username
password New password 5 to 15 chars (1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-_$@)
Return values:
status "Password changed"
Error codes:
7001 You don't have permissions to change users password.
7002 Unknow user ID.
7004 Password is too short.
7005 Password is too long.
7006 Password contain invalid chars.

SuspendUser

 

Available for: admin and user-manager
Admin o User-manager login ID is required.
Parameters:
id [number] ID of the username
Return values:
status "User suspended"
Error codes:
5001 You don't have permissions to get user data.
5002 Unknow user ID.

UnsuspendUser

 

Available for: admin and user-manager
Admin o User-manager login ID is required.
Parameters:
id [number] ID of the username
Return values:
status "User unsuspended"
Error codes:
6001 You don't have permissions to get user data.
6002 Unknow user ID.

ListCamps

 

Available for: Any active users
Login ID is required.
Parameters:
None
Return values: Array with user data:
MessageID [Number] The campaign ID
Subject The campaign email subject
DateStart [UnixTime] Date of the sending starts (In unix format '1234567890')
DateEnd [UnixTime] Date of the sending completed (In unix format '1234567890')
Error codes:
None

GetCamp

 

Available for: Any active users
Login ID is required.
Parameters:
MessageID [Number] The campaign ID
Return values:
Status [completed|scheduled|stopped|saved|sending|restarting] the message status
Subject The email sunbect
From Email from
DateStart Date of the sending starts
DateEnd Date of the sending completed
Subscribers [number] Number of subscribers
Sent [number] of emails sent
Left [number] of email left, pending to send
Failed [number] of failed emails (not sent)
Bounced [number] Number of email bounced
ReadsUnique [number] Number of unique reads by subscribers
ReadsTotal [number] Number of total reads by subscribers
Unsubscribed [number] Number of unsubscriptions
Refered [number] Number of people refered
ReferReads [number] Number of refered reads
TotalReads [number] Number of total reads (refered + subscribers
NewSubscribers [number] Number of new subscribers
Error codes:
1201 Wrong message ID

 

¿Fue útil la respuesta?

Artículos Relacionados

API - General API (Application Program Interface o Programa de Aplicación de Interfaz) es un sistema que le... API Principio Básico RECUERDE: Debe solicitar a mediante ticket el ácceso a API de Maxmailer. Como se provee... Api - Suscripcion Subscription and unsubscription API This API will allow you to direct subscribe, unsubscribe...
« Atrás

  Soporte

  Mis Tickets de Soporte   Anuncios   Preguntas Frecuentes - FAQ   Descargas   Estado de la Red   Abrir Ticket