Send SMS

Page describing the API for sending SMS messages.

GET https://api.jelou.ai/v1/bots/BOT_ID/sms_templates

Get the available SMS templates

Path Parameters

Name	Type	Description
BOT_ID*	String	Bot ID

Query Parameters

Name	Type	Description
query	String	Search by name

200: OK

An array of objects, each object has the information of a SMS template

{
  "message": [
    "Get Templates successfully."
  ],
  "statusMessage": "success",
  "status": 1,
  "data": {
    "pagination": {
      "limit": 50,
      "total": 1,
      "offset": 0,
      "totalPages": 1
    },
    "_metadata": {},
    "results": [
      {
        "id": 5,
        "template": "Jelou: Hola (X) tu codigo para acceder a nuestra plataforma es (X), este codigo tiene una duracion de 24 Horas.",
        "displayName": "Prueba params",
        "elementName": "prueba_params",
        "companyId": 135,
        "botId": "+123-sms",
        "paramsNumber": 2,
        "params": [
          {
            "label": "Nombre",
            "param": "1"
          },
          {
            "label": "Código",
            "param": "2"
          }
        ],
        "createdAt": "2023-04-25T16:35:58.000Z",
        "updatedAt": "2023-04-25T16:35:58.000Z",
        "state": true,
        "isVisible": true,
        "type": "SMS",
        "providerId": "34687",
        "status": "APPROVED",
        "category": "MARKETING",
        "language": "es"
      }
    ]
  }
}

404: Not Found

The botId used to send the template does not exist.

{
  "message": [
    "The Bot could not be found at the moment."
  ],
  "statusMessage": "failed",
  "status": 0,
  "error": {
    "code": "E1019",
    "key": "BOT_NOT_FOUND",
    "description": "Error to be thrown when trying to get a Bot.",
    "developerMessages": {
      "es": "El botId no se encuentra en la base de datos o ha sido eliminado.",
      "en": "The botId is not found in the database or has been deleted.",
      "pt": "A botId não é encontrada no banco de dados ou foi apagada."
    },
    "clientMessages": {
      "es": "El Bot no se pudo encontrar por el momento.",
      "en": "The Bot could not be found at the moment.",
      "pt": "A Bot não pôde ser encontrada no momento."
    }
  }
}

500: Internal Server Error

Server error trying to process template submission request.

{
  "message": [
    "We are having trouble processing your request. Please try again later."
  ],
  "statusMessage": "failed",
  "status": 0,
  "error": {
    "code": "E0000",
    "key": "UNKNOWN_ERROR",
    "description": "Error to be thrown when it couldn't be determined the reason of failure",
    "developerMessages": {
      "es": "Error inesperado occurido, revisar logs.",
      "en": "Unexpected error occurred, check logs."
    },
    "clientMessages": {
      "es": "Estamos teniendo problemas procesando la solicitud. Por favor intenta mas tarde.",
      "en": "We are having trouble processing your request. Please try again later."
    }
  }
}

Send

POST https://api.jelou.ai/v1/sms/BOT_ID/template

Send SMS message to users.

Path Parameters

Name	Type	Description
BOT_ID*	String	Bot ID

Request Body

Name	Type	Description
destinations*	Array	Array of strings representing the numbers of the clients to send the SMS
elementName*	String	Template name.
parameters	Array	Array of strings containing the values to replace in the SMS template. Required if the template has parameters

200: OK

An array of objects, each object has the information of the id of the message and the destination

[
  {
    "id": "09d0fc2b-59d9-4149-9543-adfa92586615",
    "destination": "593999999999"
  }
]

404: Not Found

The botId used to send the template does not exist.

{
  "message": [
    "The Bot could not be found at the moment."
  ],
  "statusMessage": "failed",
  "status": 0,
  "error": {
    "code": "E1019",
    "key": "BOT_NOT_FOUND",
    "description": "Error to be thrown when trying to get a Bot.",
    "developerMessages": {
      "es": "El botId no se encuentra en la base de datos o ha sido eliminado.",
      "en": "The botId is not found in the database or has been deleted.",
      "pt": "A botId não é encontrada no banco de dados ou foi apagada."
    },
    "clientMessages": {
      "es": "El Bot no se pudo encontrar por el momento.",
      "en": "The Bot could not be found at the moment.",
      "pt": "A Bot não pôde ser encontrada no momento."
    }
  }
}

422: Unprocessable Entity

Validation error, occurs when the sent payload does not follow the format validations for each field of the payload.

{
  "message": [
    "Los valores ingresados no son correctos."
  ],
  "statusMessage": "failed",
  "status": 0,
  "error": {
    "code": "E0422",
    "key": "VALIDATOR_ERROR",
    "description": "Error to be thrown when cannot process request because of incoming values",
    "developerMessages": {
      "es": "Los valores del request no son correctos para ser procesados.",
      "en": "The request values are not correct for processing."
    },
    "clientMessages": {
      "es": "Los valores ingresados no son correctos.",
      "en": "The values entered are not correct."
    }
  },
  "validationError": {
    "parameters": [
      {
        "en": "The number of parameters is incorrect.",
        "es": "El número de parámetros es incorrecto.",
        "pt": "O número de parâmetros está incorreto."
      }
    ]
  }
}

500: Internal Server Error

Server error trying to process template submission request.

{
  "message": [
    "We are having trouble processing your request. Please try again later."
  ],
  "statusMessage": "failed",
  "status": 0,
  "error": {
    "code": "E0000",
    "key": "UNKNOWN_ERROR",
    "description": "Error to be thrown when it couldn't be determined the reason of failure",
    "developerMessages": {
      "es": "Error inesperado occurido, revisar logs.",
      "en": "Unexpected error occurred, check logs."
    },
    "clientMessages": {
      "es": "Estamos teniendo problemas procesando la solicitud. Por favor intenta mas tarde.",
      "en": "We are having trouble processing your request. Please try again later."
    }
  }
}