Api::V1::Entourages::ChatMessagesController API

Chat messages

Create chat_message

POST /api/v1/entourages/:entourage_id/chat_messages

Parameters

Name Description
token token
entourage_id entourage
chat_message[content] Chat message content
chat_message[message_type] text, status_update, share
chat_message[metadata][status] (status_update)
chat_message[metadata][outcome_success] (status_update)
chat_message[metadata][type] entourage, poi (share)
chat_message[metadata][uuid] (share)

Request

Headers

Content-Type: application/json
Host: example.org
Cookie:

Route

POST /api/v1/entourages/3/chat_messages

Body

{"token":"foobar18","chat_message":{"content":"foo"}}

Response

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET,POST,PUT,PATCH,DELETE
Access-Control-Allow-Headers: Origin,Accept,Content-Type,X-Requested-With,X-CSRF-Token,X-API-KEY
Content-Type: application/json; charset=utf-8
ETag: W/"4fa0353078123341d26f9f1f0f2e0f41"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: e0a23562-5602-4c4c-b50a-cd24ec72b6cb
X-Runtime: 0.025735
Content-Length: 183

Status

201 Created

Body

{
  "chat_message": {
    "id": 3,
    "content": "foo",
    "user": {
      "id": 18,
      "avatar_url": null,
      "display_name": "John D.",
      "partner": null
    },
    "created_at": "2022-06-02T17:16:42.338+02:00",
    "message_type": "text"
  }
}