API Lista de
Contactos

Con Nuestra Completa Email API, Maneja Fácilmente Tus Suscriptores

Email Marketing Contacts Api

AddBulkContact()

Usa este método para añadir un grupo de contactos a tu lista de contactos.

  • apiKey (Requerido)

La clave de autentificación de tu aplicación. Para conseguir la tuya, haz clic aquí .

  • list_id (Requerido)

El número ID de la lista a la que debe ser añadido el contacto.  Puedes obtener un listado de tus listas de contacto usando el método GetLists().

  • list (of shortContactItem) (Requerido)

Un conjunto de direcciones de correo electrónico, nombres y apellidos de los contactos que agregará. Debe ser una dirección de correo electrónico válida.

En caso de éxito, este método devuelve una respuesta de «éxito» (código 0). En caso de fallo, se devolverá un código de error con la descripción.

El método comprueba si la dirección de correo electrónico existe en las listas de contactos especificadas y no te permitirá agregar correos electrónicos duplicados.

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddContact xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
      <email>string</email>
      <firstname>string</firstname>
      <lastname>string</lastname>
      <list_id>int</list_id>
    </AddContact>
  </soap:Body>
</soap:Envelope>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddContactResponse xmlns="http://api.directiq.com/">
      <AddContactResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
      </AddContactResult>
    </AddContactResponse>
  </soap:Body>
</soap:Envelope>

AddContact()

Usa este método para añadir un contacto a tu lista de contactos.

  • apiKey (Requerido)

La clave de autentificación de tu aplicación. Para conseguir la tuya, haz clic aquí.

  • list_id (Requerido)

El número de ID de la lista a la cual debe ser añadido el contacto.  Puedes obtener un listado de las listas de contacto usando el método GetLists().

  • email (Requerido)

La dirección de correo electrónico del contacto que vas a añadir. Debe ser una dirección de correo válida.

  • firstname

Nombre del contacto que vas a añadir.  Este campo es opcional.

  • lastname

Apellido del contacto que vas a añadir. Este campo es opcional.

En caso de éxito, este método devuelve una respuesta de «éxito» (código 0). En caso de fallo, se devolverá un código de error con la descripción.

El método comprueba si la dirección de correo electrónico existe en las listas de contactos especificadas y no te permitirá agregar correos electrónicos duplicados.

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddContact xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
      <email>string</email>
      <firstname>string</firstname>
      <lastname>string</lastname>
      <list_id>int</list_id>
    </AddContact>
  </soap:Body>
</soap:Envelope>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddContactResponse xmlns="http://api.directiq.com/">
      <AddContactResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
      </AddContactResult>
    </AddContactResponse>
  </soap:Body>
</soap:Envelope>

AddContactToSupressionList()

Usa este método para añadir direcciones de correo electrónico a la Lista de Supresión.  Los contactos que se añadan a la Lista de Supresión no recibirán mensajes de tu parte.  Es una lista de no-envío.

  • apiKey (Requerido)

La clave de autentificación de tu aplicación. Para conseguir la tuya, haz clic aquí.

  • email (Requerido)

En caso de éxito, este método devuelve una respuesta de «éxito» (código 0). En caso de fallo, se devolverá un código de error con la descripción.

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddContactToSupressionList xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
      <email>string</email>
    </AddContactToSupressionList>
  </soap:Body>
</soap:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddContactToSupressionListResponse xmlns="http://api.directiq.com/">
      <AddContactToSupressionListResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
      </AddContactToSupressionListResult>
    </AddContactToSupressionListResponse>
  </soap:Body>
</soap:Envelope>

CreateList()

Usa este método para crear una nueva lista de contactos.

  • apiKey (Requerido)

La clave de autentificación de tu aplicación. Para conseguir la tuya, haz clic aquí.

  • list_name (Requerido)

Nombre de la lista de contactos que se va a crear.

En caso de éxito, este método devuelve una respuesta de «éxito» (código 0). También se proporcionará el ID único de la lista recién creada en el campo list_id. En caso de fallo, se devolverá un código de error con la descripción.

El método fallará si ya existe una lista de contactos con el nombre especificado.

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CreateList xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
      <list_name>string</list_name>
    </CreateList>
  </soap:Body>
</soap:Envelope>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CreateListResponse xmlns="http://api.directiq.com/">
      <CreateListResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
        <list_id>int</list_id>
      </CreateListResult>
    </CreateListResponse>
  </soap:Body>
</soap:Envelope>

DeleteContact()

Usa este método para borrar un contacto de tu lista de contactos.

  • apiKey (Requerido)

La clave de autentificación de tu aplicación. Para conseguir la tuya, haz clic aquí.

  • list_id (Requerido)

El número de ID de la lista que contiene el contacto que se quiere borrar. Puedes conseguir un listado de tus listas de contactos usando el método GetLists().

  • email (Requerido)

La dirección de correo electrónico del contacto que borrarás Debe ser una dirección de correo electrónico válida y existir en la lista de contactos especificada.

En caso de éxito, este método devuelve una respuesta de «éxito» (código 0). En caso de fallo, se devolverá un código de error con la descripción.

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <DeleteContact xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
      <email>string</email>
      <list_id>int</listId>
    </DeleteContact>
  </soap:Body>
</soap:Envelope>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <DeleteContactResponse xmlns="http://api.directiq.com/">
      <DeleteContactResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
      </DeleteContactResult>
    </DeleteContactResponse>
  </soap:Body>
</soap:Envelope>

DeleteList()

Usa este método para borrar una lista de contactos.

  • apiKey (Requerido)

La clave de autentificación de tu aplicación. Para conseguir la tuya, haz clic aquí.

  • list_id (Requerido)

ID de la lista de contactos que se va a borrar.

En caso de éxito, este método devuelve una respuesta de «éxito» (código 0). En caso de fallo, se devolverá un código de error con la descripción.

El método fallará si no existe una lista de contactos con el ID especificado.

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <DeleteList xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
      <list_id>int</list_id>
    </DeleteList>
  </soap:Body>
</soap:Envelope>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <DeleteListResponse xmlns="http://api.directiq.com/">
      <DeleteListResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
      </DeleteListResult>
    </DeleteListResponse>
  </soap:Body>
</soap:Envelope>

GetActiveContacts()

Usa este método para obtener todos los contactos activos en la lista de contactos especificada.

  • apiKey (Requerido)

La clave de autentificación de tu aplicación. Para obtener la tuya,  haz clic aquí.

  • list_id (Requerido

El número ID de la lista a ser consultada. Puedes obtener un listado de tus listas de contacto usando el método GetLists().

En caso de éxito, este método devuelve una respuesta de «éxito» (código 0). En caso de fallo, se devolverá un código de error con la descripción.

El método fallará si no existe una lista de contactos con el ID especificado.

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetActiveContacts xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
      <list_id>int</list_id>
    </GetActiveContacts>
  </soap:Body>
</soap:Envelope>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetActiveContactsResponse xmlns="http://api.directiq.com/">
      <GetActiveContactsResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
        <returnedList>
          <contact>
            <user_id>int</user_id>
            <email>string</email>
            <firstname>string</firstname>
            <lastname>string</lastname>
            <status>unsignedByte</status>
            <info>string</info>
            <list_id>int</list_id>
          </contact>
          <contact>
            <user_id>int</user_id>
            <email>string</email>
            <firstname>string</firstname>
            <lastname>string</lastname>
            <status>unsignedByte</status>
            <info>string</info>
            <list_id>int</list_id>
          </contact>
        </returnedList>
      </GetActiveContactsResult>
    </GetActiveContactsResponse>
  </soap:Body>
</soap:Envelope>

GetAllContacts()

Usa este método para obtener todos los contactos en la lista de contactos especificada. Se obtendrán tanto los contactos pasivos como los activos.

  • apiKey (Requerido)

La clave de autentificación de tu aplicación.  Para conseguir la tuya, haz clic aquí.

  • list_id (Requerido)

El número ID de la lista que se va a procesar. Puedes obtener un listado de tus listas de contacto usando el método  GetLists().

En caso de éxito, este método devuelve una respuesta de «éxito» (código 0). El método también devuelve una lista de contacto objeto que contiene ids, correos electrónicos, nombre y apellidos de los contactos. El campo de estado contiene el estado de los contactos (0 pasivo, 1 activo). En caso de fallo, se recibirá un código de error con la descripción.

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetAllContacts xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
      <list_id>int</list_id>
    </GetAllContacts>
  </soap:Body>
</soap:Envelope>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetAllContactsResponse xmlns="http://api.directiq.com/">
      <GetAllContactsResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
        <returnedList>
          <contact>
            <user_id>int</user_id>
            <email>string</email>
            <firstname>string</firstname>
            <lastname>string</lastname>
            <status>unsignedByte</status>
            <info>string</info>
            <list_id>int</list_id>
          </contact>
          <contact>
            <user_id>int</user_id>
            <email>string</email>
            <firstname>string</firstname>
            <lastname>string</lastname>
            <status>unsignedByte</status>
            <info>string</info>
            <list_id>int</list_id>
          </contact>
        </returnedList>
      </GetAllContactsResult>
    </GetAllContactsResponse>
  </soap:Body>
</soap:Envelope>

GetContact()

Usa este método para obtener toda la información de un contacto.

  • apiKey (Requerido)

La clave de autentificación de tu aplicación. Para conseguir la tuya, haz clic aquí.

  • list_id (Requerido)

El número ID de la lista en la que cual está el contacto.  Puedes obtener un listado de tus listas de contacto usando el método GetLists().

  • email (Requerido)

La dirección de correo electrónico del contacto a buscar. Debe ser una dirección de correo electrónico válida.

En caso de éxito, este método devuelve una respuesta de “éxito” (código 0). El método también devuelve el ID de contacto, el correo electrónico, el nombre y apellido así como el estado del contacto. El campo de estado contiene el estado del contacto (0 pasivo, 1 activo). En caso de fallo, se devolverá un código de error con la descripción.

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetContact xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
      <list_id>int</list_id>
      <email>string</email>
    </GetContact>
  </soap:Body>
</soap:Envelope>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetContactResponse xmlns="http://api.directiq.com/">
      <GetContactResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
        <returnedContact>
          <user_id>int</user_id>
          <email>string</email>
          <firstname>string</firstname>
          <lastname>string</lastname>
          <status>unsignedByte</status>
          <info>string</info>
          <list_id>int</list_id>
        </returnedContact>
      </GetContactResult>
    </GetContactResponse>
  </soap:Body>
</soap:Envelope>

GetContactByID()

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetContactByID xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
      <contactID>int</contactID>
    </GetContactByID>
  </soap:Body>
</soap:Envelope>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetContactByIDResponse xmlns="http://api.directiq.com/">
      <GetContactByIDResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
        <returnedContact>
          <contactID>int</contactID>
          <email>string</email>
          <firstname>string</firstname>
          <lastname>string</lastname>
          <dateadded>dateTime</dateadded>
          <gender>string</gender>
          <city>string</city>
          <birthdate>string</birthdate>
          <extended1>string</extended1>
          <extended2>string</extended2>
          <extended3>string</extended3>
          <extended4>string</extended4>
          <extended5>string</extended5>
          <extended6>string</extended6>
          <extended7>string</extended7>
          <extended8>string</extended8>
          <extended9>string</extended9>
          <extended10>string</extended10>
          <extended11>string</extended11>
          <extended12>string</extended12>
          <extended13>string</extended13>
          <extended14>string</extended14>
          <extended15>string</extended15>
          <isActive>boolean</isActive>
          <isVisible>boolean</isVisible>
          <canBeReactivated>boolean</canBeReactivated>
        </returnedContact>
      </GetContactByIDResult>
    </GetContactByIDResponse>
  </soap:Body>
</soap:Envelope>

GetLists()

Usa este método para obtener un listado de todas las listas de contacto.

  • apiKey (Requerido)

La clave de autentificación de tu aplicación. Para obtener la tuya, haz clic aquí.

En caso de éxito, este método proporciona  la siguiente información: list_id: identificador único de la lista list_name: nombre de la lista list_count: número total de contactos en la lista active: número de contactos activos en la lista passive: número de contactos pasivos en la lista En caso de error, este método devuelve un código de error y una descripción.

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetLists xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
    </GetLists>
  </soap:Body>
</soap:Envelope>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetListsResponse xmlns="http://api.directiq.com/">
      <GetListsResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
        <returnedList>
          <contactList>
            <list_id>int</list_id>
            <list_name>string</list_name>
            <list_lastupdate>dateTime</list_lastupdate>
            <list_count>int</list_count>
            <active>int</active>
            <passive>int</passive>
          </contactList>
          <contactList>
            <list_id>int</list_id>
            <list_name>string</list_name>
            <list_lastupdate>dateTime</list_lastupdate>
            <list_count>int</list_count>
            <active>int</active>
            <passive>int</passive>
          </contactList>
        </returnedList>
      </GetListsResult>
    </GetListsResponse>
  </soap:Body>
</soap:Envelope>

GetPassiveContacts()

Usa este método para obtener todos los contactos pasivos en la lista especificada.

  • apiKey (Requerido)

La clave de autentificación de tu aplicación. Para conseguir la tuya, haz clic aquí.

  • list_id (Requerido)

El número ID de la lista a ser consultada. Puedes obtener un listado de tus listas de contacto usando el método GetLists().

En caso de éxito, este método devuelve una respuesta de «éxito» (código 0). El método también devuelve una lista de contacto objeto que contiene ids, correos electrónicos, nombre y apellidos de los contactos. El campo de estado contiene el estado de los contactos (0 pasivo, 1 activo). En caso de fallo, se devolverá un código de error con la descripción.

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetPassiveContacts xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
      <list_id>int</list_id>
    </GetPassiveContacts>
  </soap:Body>
</soap:Envelope>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetPassiveContactsResponse xmlns="http://api.directiq.com/">
      <GetPassiveContactsResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
        <returnedList>
          <contact>
            <user_id>int</user_id>
            <email>string</email>
            <firstname>string</firstname>
            <lastname>string</lastname>
            <status>unsignedByte</status>
            <info>string</info>
            <list_id>int</list_id>
          </contact>
          <contact>
            <user_id>int</user_id>
            <email>string</email>
            <firstname>string</firstname>
            <lastname>string</lastname>
            <status>unsignedByte</status>
            <info>string</info>
            <list_id>int</list_id>
          </contact>
        </returnedList>
      </GetPassiveContactsResult>
    </GetPassiveContactsResponse>
  </soap:Body>
</soap:Envelope>