Send a message to a UserChat

Send a new message to a chat via bot

Parameter

Accessible via URL https://api.channel.io/open/v5/user-chats/{userChatId}/messages and HTTP POST

📘

Present message parameters in POST body. This method does currently accept application/json only.

Parameter

Example

Required

Description

Parameter type

userChatId

5e65fa8bc2409f0c1fd3

Required

ID of UserChat

Path

botName

Channel-bot

Optional

Name of Bot

Query

Example

POST https://api.channel.io/open/v5/user-chats/5e65fa8bc2409f0c1fd3/messages?botName=channelBot

Request

Your POST body should look like below

{
    "blocks":[
        {
            "type": "text",
            "value": "This is <b>bold</b>, <i>italic</i>, and <b><i>bold+italic</i></b>"
        },
        {
            "type": "text",
            "value": "<link type="manager" value="managerId_goes_here">@username</link>"
        },
        {
            "type": "text",
            "value": "This is a url <link type="url" value="https://channel.io">https://channel.io</link>"
        },
        {
            "type": "text",
            "value": "This is a link <link type="url" value="https://channel.io">Channel</link>"
        },
        {
            "type": "code",
            "value": "<script>ChannelIO('boot')</script>"
        },
        {
            "type": "bullets",
            "blocks":[
                {
                    "type": "text"
                    "value": "Bulleted text goes here"
                },
                {
                    "type": "text"
                    "value": "Next bulleted text goes here"
                }
            ]
        }
    ],
    "options": [
        "actAsManager", "doNotPost", "doNotSearch", "doNotSendApp", "immutable", "private", "silent"
        ],
    }
}

Response

Return a newly created message object.

{
  "message": {
    "chatKey": "string",
    "id": "string",
    "mainKey": "string",
    "threadKey": "string",
    "root": true,
    "channelId": "string",
    "chatType": "string",
    "chatId": "string",
    "personType": "string",
    "personId": "string",
    "requestId": "string",
    "language": "string",
    "createdAt": 1656032152433,
    "version": 0,
    "blocks": [
      {
        "type": "bullets",
        "language": "string",
        "value": "string",
        "blocks": [
          null
        ]
      }
    ],
    "plainText": "string",
    "updatedAt": 1656032152427,
    "buttons": [
      {
        "title": "string",
        "colorVariant": "cobalt",
        "url": "string"
      }
    ],
    "files": [
      {
        "id": "string",
        "type": "string",
        "name": "string",
        "size": 0,
        "contentType": "string",
        "duration": 0,
        "width": 0,
        "height": 0,
        "orientation": 0,
        "animated": true,
        "bucket": "string",
        "key": "string",
        "previewKey": "string",
        "channelId": "string",
        "chatType": "string",
        "chatId": "string"
      }
    ],
    "webPage": {
      "id": "string",
      "url": "string",
      "title": "string",
      "description": "string",
      "imageUrl": "string",
      "videoUrl": "string",
      "publisher": "string",
      "author": "string",
      "width": 0,
      "height": 0,
      "bucket": "string",
      "previewKey": "string",
      "logo": "string",
      "name": "string"
    },
    "log": {
      "action": "changeName",
      "values": [
        "string"
      ],
      "triggerType": "string",
      "triggerId": "string"
    },
    "reactions": [
      {
        "emojiName": "string",
        "personKeys": [
          "string"
        ]
      }
    ],
    "form": {
      "inputs": [
        {
          "value": {},
          "readOnly": true,
          "type": "text",
          "label": "string",
          "dataType": "string",
          "bindingKey": "string"
        }
      ],
      "submittedAt": 1656032153409,
      "type": "string"
    },
    "state": "sending",
    "options": [
      "actAsManager"
    ],
    "marketing": {
      "type": "string",
      "id": "string",
      "advertising": true,
      "sendToOfflineXms": true,
      "sendToOfflineEmail": true,
      "exposureType": "fullScreen"
    },
    "supportBot": {
      "id": "string",
      "revisionId": "string",
      "sectionId": "string",
      "stepIndex": 0,
      "buttons": [
        {
          "text": "string",
          "nextSectionId": "string"
        }
      ],
      "submitButtonIndex": 0
    },
    "action": {
      "type": "select",
      "buttons": [
        {
          "key": "string",
          "text": "string"
        }
      ]
    },
    "submit": {
      "id": "string",
      "key": "string"
    },
    "threadMsg": true,
    "broadcastedMsg": true,
    "rootMessageId": "string"
  }
}