API – Mensajes

Te permite enviar mensajes que contengan texto, imagen, audio, vídeo o archivo a Contactos en la plataforma.

El token de canal es necesario para tener acceso a este recurso.
Los tokens se pueden generar haciendo clic en el icono de API con la llave, dentro de cada canal deseado en Settings, Channels.

Solicitudes #

La API de contactos 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 Endpoint.

POST /v1/message/sendContent/{contactId}

Solicitud de Texto – POST de Ejemplo #

curl -X POST \
      https://chatcentral.orade.com/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": []
}

IMPORTANTE: Ten en cuenta que en el caso del Canal Viber – debido a una cierta limitación – el ID de contacto debe proporcionarse en un formato codificado en Base64.

Enviar Solicitud de Archivo Adjunto #

Esta solicitud envía datos adjuntos en forma de dirección URL directamente al contacto según lo definido en el Endpoint. El archivo puede ser imagen, vídeo, audio o archivo.

POST /v1/message/sendContent/{contactId}

Enviar Solicitud de Imagen – POST de Ejemplo #

curl -X POST \
      https://chatcentral.orade.com/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": []
}

Enviar Solicitud de Video – POST de Ejemplo #

curl -X POST \
      https://chatcentral.orade.com/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": []
}

Enviar Solicitud de Audio – POST de Ejemplo #

curl -X POST \
      https://chatcentral.orade.com/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": []
}

Enviar Solicitud de Archivo – POST de Ejemplo #

curl -X POST \
      https://chatcentral.orade.com/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 receptores.

curl -X POST \
      https://chatcentral.orade.com/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 #

(Sin Autorización) – Unauthorized (HTTP Status → 401) #

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

(Demasiadas Solicitudes) – Too Many Requests (HTTP Status → 429) #

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

(Método No Permitido) Method Not Allowed (HTTP Status → 405) #

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

General (HTTP Status → 403) #

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

Unmatched File Type (HTTP Status → 403) #

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

Limitantes #

• Solo se puede enviar un mensaje en 1 llamada a la API.
• API tiene un límite de velocidad de 25 RPS.
• Se permiten 10 respuestas rápidas con 20 caracteres cada una.
• La encuesta no se cancela de forma predeterminada. forceCancelSurvey : true debe enviarse explícitamente en la carga.
• El estado del contacto no se cambiará en la llamada a la API.