CRM 360 - Api Notificaciones SMS




Documentación del método POST /api/v1/notification/delivery

Este método se utiliza para enviar SMS a través de una API de notificaciones. Debes realizar una solicitud POST a la ruta /api/v1/notification/delivery y proporcionar los siguientes parámetros en el cuerpo de la solicitud:

URL: /api/v1/notification/delivery

Método: POST

Parámetros en el cuerpo de la solicitud:

  1. company (string, requerido): El código de la compañía para la cual se enviará el SMS.

  2. message (JSON, requerido): El mensaje a enviar, con diferentes formatos según el tipo de mensaje.

    • destination (objeto, requerido): Contiene los detalles del destinatario del SMS.

      • name (string, requerido): Nombre del destinatario.
      • phone (string, requerido): Número de teléfono del destinatario al que se enviará el SMS.

    • body (string, requerido): Contiene el contenido del mensaje de texto a enviar.

  3. typeCode (string, requerido): El tipo de mensaje que se enviará. En este caso, el valor debe ser "sms", ya que este método se utiliza para enviar SMS.


 import axios, { AxiosResponse } from 'axios';

interface Message {
  destination: {
    name: string;
    phone: string;
  };
  body: string;
}

interface ApiResponse {
  status: string;
  message: string;
}

const apiUrl = 'https://api.example.com/api/v1/notification/delivery';

const sendSMS = async () => {
  const requestBody: {
    company: string;
    message: Message;
    typeCode: string;
  } = {
    company: 'company_code',
    message: {
      destination: {
        name: 'John Doe',
        phone: '+1234567890',
      },
      body: 'Contenido del mensaje de texto a enviar',
    },
    typeCode: 'sms',
  };

  try {
    const response: AxiosResponse<ApiResponse> = await axios.post(apiUrl, requestBody);
    console.log('SMS enviado:', response.data.message);
  } catch (error) {
    console.error('Error al enviar el SMS:', error);
  }
};

sendSMS();
 
curl -X POST "https://api.example.com/api/v1/notification/delivery" \
-H "Content-Type: application/json" \
-d '{
  "company": "company_code",
  "message": {
    "destination": {
      "name": "John Doe",
      "phone": "+1234567890"
    },
    "body": "Contenido del mensaje de texto a enviar"
  },
  "typeCode": "sms"
}'
  
  • Sem rótulos