Cuervo By CVR

Cuervo es una pequeña API creada para el envio de mensajes de texto (SMS) masivos. Cuervo está pensada para simplificar la integración a tu proyecto, haciendo simples peticiones HTTP a nuestro end-point podrás enviar mensajes a tus clientes y usuarios desde tu aplicación o sistema embebido como por ejemplo Arduino ESPxxxx; en realidad desde cuanlquier sistema que pueda realizar peticiones HTTP.

Cuervo, además te permitirá almacenar contactos de forma individual y crear listas de contactos de forma rápida. esto facilitará el envio de cualquier campaña o difusión con un solo llamado a la API. Para el uso de la API solo necesitarás un apiKey y un clientID como credenciales. estos puedes solicitarlos aquí. Una vez tengas tus credenciales de usuario podrás usar Cuervo en tu aplicación/sistema usando los siguientes end points:

Nota: Cuervo solo funciona para envios de mensajes de texto SMS a colombia, No se permite el envio de mensajes con fines extorsivos, estafa, suplantación o cualquier otro fin que atente contra las leyes del pais. los mensajes estarán sujetos a revisión. No respetar las normas establecidas llevará a la suspeción definitiva de la cuenta.

Sobre los créditos: Un credito corresponde al envio de un mensaje texto de 180 caracteres por usuario.

End points

Créditos

• GET https://cuervo.cvrelectronica.com/credits/

  Retorna los creditos disponibles para el elnvio de mensajes.
  Returns the credits available for sending messages.

                  
               
  // Retorna Los creditos disponibles para el usuario
  $.get("https://cuervo.cvrelectronica.com/credits/",{
      clientID : "***************",
      apiKey : "************************"
      },(data)=>{
          console.log(data);
  });    
                  
              

Contactos

• GET https://cuervo.cvrelectronica.com/contacts/

  Retorna los contactos almacenados.
  Returns stored contacts.

                  
               
  // Retorna contactos
  $.get("https://cuervo.cvrelectronica.com/contacts/",{
          clientID : "***************",
          apiKey : "************************"
          },(data)=>{
              console.log(data);
          }
  );     
                  
              

• PUT https://cuervo.cvrelectronica.com/contact/add/

  Agrega un contacto.
  add contact.

                      
   
  //Add contact
  let contact = {
                  name:"Nombre del contacto",
                  phone:"3xxxxxxxxx", 
                  email:"cuervo@xxxxx.com"
                }
  $.ajax({
      url: 'https://cuervo.cvrelectronica.com/contact/add/',
      type: 'PUT',
      data: {
             clientID : "***************",
             apiKey : "************************",
             contact: JSON.stringify(contact)
            },
          success: (result)=> {
              console.log(result);
          }
      });
                      
                  

• POST https://cuervo.cvrelectronica.com/contact/edit/

  Edita un contacto previamente almacenado.
  Edit a previously stored contact.

                      
   
  //Edit contact
  let contactEdit = {
                      id:"*******",
                      name:"New name",
                      phone:"3xxxxxxxxx", 
                      email:"newEmail@xxxxx.com"
                    }
  $.post("https://cuervo.cvrelectronica.com/contact/edit/",{
          clientID : "***************",
          apiKey : "************************",
          contact: JSON.stringify(contactEdit)
          },(data)=>{
              console.log(data);
          }
  );
                      
                  

• DELETE https://cuervo.cvrelectronica.com/contact/remove/

  Eliminar un contacto
  Remove a contact.

                      
   
  //Remove contact
  $.ajax({
      url: 'https://cuervo.cvrelectronica.com/contact/remove/',
      type: 'DELETE',
      data: {
              clientID : "***************",
              apiKey : "************************",
              contact: "id del contacto"
          },
      success: (result)=> {
              console.log(result);
          }
  });
                      
                  

Listas de contactos

• GET https://cuervo.cvrelectronica.com/contactsLists/

  Retorna las listas de contactos almacenadas.
  Return previously created lists of contacts.

                      
  
  // Retorna Listas de contactos
  $.get("https://cuervo.cvrelectronica.com/contactsLists/",{
      clientID : "***************",
      apiKey : "************************"
      },(data)=>{
          console.log(data);
      }
  );
                      
                  

• POSThttps://cuervo.cvrelectronica.com/list/create/

  Crea una nueva lista de contactos.
  Create a new contacts list.

                      
  
  //Create New Contacts List
  $.post("https://cuervo.cvrelectronica.com/list/create/",{
      clientID : "***************",
      apiKey : "************************",
      listName: "Mi nueva lista"
      },(data)=>{
      console.log(data);
  });
                      
                  

• PUT https://cuervo.cvrelectronica.com/list/contact/add/

  Agrega un contacto a la lista de contactos.
  Add a contact to list contact.

                      
  
  //Add contact to list
  let contact = {
                  name:"Nombre del contacto",
                  phone:"3xxxxxxxxx", 
                  email:"email@ccuervo.com"
                }
  $.ajax({
      url: 'https://cuervo.cvrelectronica.com/list/contact/add/',
      type: 'PUT',
      data: {
          clientID : "***************",
          apiKey : "************************",
          list: "xxxxxxxxxx",
          contact: JSON.stringify(contact)
          },
      success: (result)=> {
          console.log(result);
      }
  });
                      
                  

• GET https://cuervo.cvrelectronica.com/contactsOnLists/

  Retorna los contactos almacenados en la lista de contactos.
  Returns stored contacts on list.

                      
  
  // Retorna Los contactos dentro de una Listas de contactos
  $.get("https://cuervo.cvrelectronica.com/contactsOnLists/",{
      clientID : "***************",
      apiKey : "************************",
      list : "xxxxxxxxx"
      },(data)=>{
          console.log(data);
  });
                      
                  

• POST https://cuervo.cvrelectronica.com/list/contact/edit/

  Edita un contacto dentro de una lista.
  Edit a contact into list.

                      
  
  //Edit contact from list
  let contactEdit = {id:"xxxxxxxx",
                      name:"Nuevo nombre",
                      phone:"3xxxxxxxxxx", 
                      email:"email@cuervo.com"
                  }
  $.post("https://cuervo.cvrelectronica.com/list/contact/edit/",{
      clientID : "***************",
      apiKey : "************************",
      list: "xxxxxxxxx",
      contact: JSON.stringify(contactEdit)
      },(data)=>{
      console.log(data);
  });
                      
                  

• DELETEhttps://cuervo.cvrelectronica.com/list/contact/remove

  Elimina un contacto dentro de la lista.
  Remove a contact into the list.

                      
  
  //Remove contact from list
  $.ajax({
      url: 'https://cuervo.cvrelectronica.com/list/contact/remove',
      type: 'DELETE',
      data: {
          clientID : "***************",
          apiKey : "************************",
          list: "xxxxxxxx",
          contact: "xxxxxxxx (id del contacto)"
          },
      success: (result)=> {
          console.log(result);
      }
  });
                      
                  

Enviar mensajes SMS

• POST https://cuervo.cvrelectronica.com/sendSms/toContact/

  Enviar mensaje de texto a contacto (numero de telefono).
  Send text message to contact (phone number).

                      
  
  //Send SMS to number
  $.post("https://cuervo.cvrelectronica.com/sendSms/toContact/",{
      clientID : "***************",
      apiKey : "************************",
      contact: "3xxxxxxxxx",
      message: "Hola API"
      },(data)=>{
      console.log(data);
  });
                      
                  

• POST https://cuervo.cvrelectronica.com/sendSms/toContactList/

  Enviar mensaje de texto a lista de contactos.
  Send text message to contact list.

                      
  
  //Send SMS to contactList
  $.post("https://cuervo.cvrelectronica.com/sendSms/toContactList/",{
      clientID : "***************",
      apiKey : "************************",
      contactList: "xxxxxxxxx",
      message: "Hola API"
      },(data)=>{
      console.log(data);
  });