Enviar Mensajes

Enviar mensajes al canal API

Para enviar mensajes al canal API, debe tener una comprensión básica de los modelos y la nomenclatura utilizados. Tratemos de entender esto primero.

1. Canal: El canal define el tipo de fuente de conversaciones. Por ejemplo: Facebook, Twitter, API, etc.

2. Bandeja de entrada: Puede crear múltiples fuentes de conversaciones que sean del mismo tipo de canal. Por ejemplo: puede tener más de una página de Facebook conectada a una cuenta. Cada página se llama como la bandeja de entrada.

3. Conversación: Una conversación es una colección de mensajes.

4. Contacto: Cada conversación tiene una persona de la vida real asociada, esta persona se llama contacto.

5. Bandejas de entrada de contacto: Esta es la sesión para cada contacto en una bandeja de entrada. Un contacto puede tener múltiples sesiones y múltiples conversaciones en la misma bandeja de entrada.

¿Cómo enviar un mensaje en un canal API?

Para enviar un mensaje en un canal API, debe crear un contacto, luego crear una conversación y luego enviar un mensaje.

Las API requieren api_access_token en el encabezado de la solicitud. Puede obtener este token visitando la configuración de su perfil > Token de acceso

1). Crear un contacto

Documentación API: (https://api-rest.ooctopus.com/#api-Contact-contactInboxCreation)

Pase la identificación de la bandeja de entrada del canal API junto con otros parámetros especificados. Esto crearía una sesión para usted automáticamente. Una respuesta de muestra se parecería a la siguiente.

{
  "email": "string",
  "name": "string",
  "phone_number": "string",
  "thumbnail": "string",
  "additional_attributes": {},
  "contact_inboxes": [
    {
      "source_id": "string",
      "inbox": {
        "id": 0,
        "name": "string",
        "website_url": "string",
        "channel_type": "string",
        "avatar_url": "string",
        "widget_color": "string",
        "website_token": "string",
        "enable_auto_assignment": true,
        "web_widget_script": "string",
        "welcome_title": "string",
        "welcome_tagline": "string",
        "greeting_enabled": true,
        "greeting_message": "string"
      }
    }
  ],
  "id": 0,
  "availability_status": "string"
}

Como puede ver en la carga útil, podrá ver el contact_inboxes y cada contact_inbox tendrá un source_id. La ID de origen se puede ver como el identificador de sesión. Utilizará este source_id para crear una nueva conversación como se define a continuación.

2). Crear una conversación

Documentación API: (https://api-rest.ooctopus.com/#api-Conversations-newConversation)

Usa el source_id recibido en la llamada API anterior.

Recibirá una identificación de conversación que se puede usar para crear un mensaje.

{
  "id": 0
}

3). Crea un nuevo mensaje

Documentación API: (https://api-rest.ooctopus.com/#api-Messages-createANewMessageInAConversation)

Hay 2 tipos de mensajes.

1. Entrante: Los mensajes enviados por el usuario final se clasifican como un mensaje entrante.

2. Saliente: Los mensajes enviados por el agente se clasifican como un mensaje saliente.

Si llama a la API con el contenido correcto, recibirá una carga útil similar a la siguiente.

{
    "id": 0,
    "content": "This is a incoming message from API Channel",
    "inbox_id": 0,
    "conversation_id": 0,
    "message_type": 0,
    "content_type": null,
    "content_attributes": {},
    "created_at": 0,
    "private": false,
    "sender": {
        "id": 0,
        "name": "Pranav",
        "type": "contact"
    }
}

Si todo es exitoso, verá la conversación en el tablero de la siguiente manera.

Se le notificará cuando se cree un nuevo mensaje en la URL especificada al crear el canal API. Puedes leer sobre el mensaje de carga útil aquí.