API de Mensajes

Se requiere token de canal para acceder a este recurso de API.

Los tokens se pueden generar usando el ícono de llave, al lado del canal deseado en Configuración.

Solicitudes

La API de mensajes se compone de varios tipos de solicitudes:

• Enviar texto

• Enviar archivo adjunto

• Enviar texto con respuestas rápidas

Enviar Solicitud de Texto

Esta solicitud envía un mensaje de texto directamente al contacto según lo definido en el punto final.

POST /v1/message/sendContent/{contactId}

Ejemplo de solicitud de texto POST

curl -X POST \
      https://app.telenet/api/v1/message/sendContent/{contactId} \
      -H 'Authorization: Bearer {channel_token}' \
      -H 'Content-Type: application/json' \
      -d '{
  "body": [
  	{
  		"type" : "text",
  		"text" : "Hi there"
  	}
  ]
}'

Respuesta - Éxito (HTTP Status → 200)

  {
      "status": "Success",
      "message": "Message Sent",
      "data": []
  }

Tenga en cuenta que en el caso de Viber Channel, debido a una cierta limitación, la ID de contacto debe proporcionarse en un formato codificado Base64.

Enviar Solicitud de Archivo Adjunto

Esta solicitud envía un archivo adjunto en forma de URL directamente al contacto según lo definido en el punto final. El archivo puede ser imagen, video, audio o archivo.

POST /v1/message/sendContent/{contactId}

Solicitud de Imagen de Envío POST de Muestra

curl -X POST \
      https://app.telenet/api/v1/message/sendContent/{contactId} \
      -H 'Authorization: Bearer {channel_token}' \
      -H 'Content-Type: application/json' \
      -d '{
  "body": [
  	{
  		"type" : "image",
  		"url" : "http://abc.com"
  	}
  ]
}'

Respuesta - Éxito (HTTP Status → 200)

  {
      "status": "Success",
      "message": "Message Sent",
      "data": []
  }

Ejemplo de solicitud de envío de video POST

curl -X POST \
      https://app.telenet/api/v1/message/sendContent/{contactId} \
      -H 'Authorization: Bearer {channel_token}' \
      -H 'Content-Type: application/json' \
      -d '{
  "body": [
  	{
  		"type" : "video",
  		"url" : "http://abc.com"
  	}
  ]
}'

Respuesta - Éxito (HTTP Status → 200)

  {
      "status": "Success",
      "message": "Message Sent",
      "data": []
  }

Ejemplo de solicitud de audio de envío POST

curl -X POST \
      https://app.telenet/api/v1/message/sendContent/{contactId} \
      -H 'Authorization: Bearer {channel_token}' \
      -H 'Content-Type: application/json' \
      -d '{
  "body": [
  	{
  		"type" : "audio",
  		"url" : "http://abc.com"
  	}
  ]
}'

Respuesta - Éxito (HTTP Status → 200)

  {
      "status": "Success",
      "message": "Message Sent",
      "data": []
  }

Solicitud de Envío de Archivo POST de Muestra

curl -X POST \
      https://app.telenet/api/v1/message/sendContent/{contactId} \
      -H 'Authorization: Bearer {channel_token}' \
      -H 'Content-Type: application/json' \
      -d '{
  "body": [
  	{
  		"type" : "file",
  		"url" : "http://abc.com"
  	}
  ]
}'

Respuesta - Éxito (HTTP Status → 200)

  {
      "status": "Success",
      "message": "Message Sent",
      "data": []
  }

Enviar Texto con Solicitud de Respuestas Rápidas

Esta solicitud envía un mensaje de texto con respuestas rápidas para los destinatarios.

curl -X POST \
      https://app.telenet/api/v1/message/sendContent/{contactId} \
      -H 'Authorization: Bearer {channel_token}' \
      -H 'Content-Type: application/json' \
      -d '{
  "body": [
    {
      "type":"quick_reply",
    	"title" : "What is you favorite color?",
    	"replies" : ["Black","Blue","Grey","Red"]
    }
  ]
}'

Respuesta - Éxito (HTTP Status → 200)

  {
      "status": "Success",
      "message": "Message Sent",
      "data": []
  }

Códigos de Error

No autorizado (HTTP Status → 401)

  {
        "status": "error",
        "message": "API Token is invalid.",
        "data": []
  }

Demasiadas solicitudes (HTTP Status → 429)

  {
      "status": "error",
      "message": "Too many requests",
      "data": []
  }

Método no Permitido (HTTP Status → 405)

  {
      "status": "error",
      "message": "405 Method Not Allowed.",
      "data": []
  }

General (HTTP Status → 403)

  {
      "status": "error",
      "message": "Message String",
      "data": []
  }

Tipo de Archivo no coincidente (HTTP Status → 403)

  {
      "status": "error",
      "message": "Sorry, Url provided is not an image/audio/video file",
      "data": []
  }

Limitaciones

• Solo se puede enviar un mensaje en 1 llamada API.API has rate limit of 25 RPS.

• La API tiene un límite de velocidad de 25 RPS.

• La encuesta no se cancela de forma predeterminada. forceCancelSurvey: true debe enviarse explícitamente en la carga útil.

• El estado del contacto no se cambiará en la llamada a la API.