POST/desk/api/v2/conversations.json
Create a new conversation via the pusher API. This authorizes the current
3rd party user to join a room. Because we only allow joinging rooms on authentication we can return a token that will be used as the room name and will allow a lookup in the conversations table to find history.
Body Params
Conversation represents a Conversation.
- Name
contact
- Type
- object
- Description
- CustomerContact is a customer contact detail
- Name
contactId
- Type
- integer
- Name
createdAt
- Type
- string
- Description
- CreatedAt is a read-only date marking the creation time.
- Name
createdBy
- Type
- object
- Name
deletedAt
- Type
- string
- Description
- DeletedAt is a read-only date marking the time of deletion. Is only returned when the object is marked as deleted.
- Name
deletedBy
- Type
- object
- Name
filter_args
- Type
- object
- Description
- RequestCommons allows specifying paging and sorting options. All API endpoints should embed the RequestOrder for consistency.
- Name
id
- Type
- integer
- Name
messages
- Type
- array
- Name
socket_id
- Type
- string
- Name
state
- Type
- string
- Description
- State is the status of the object. Typically this will be either active or deleted. When deleted the `deletedAt` and `deletedBy` relationship will be returned.
- Name
ticket_id
- Type
- integer
- Name
token
- Type
- string
- Name
updatedAt
- Type
- string
- Description
- UpdatedAt is a read-only date marking the last updated time. This field is not updated when the object is deleted.
- Name
updatedBy
- Type
- object
- Name
users
- Type
- array
Responses
- Code
- 201
- Type
- object
- Schema
- Description
- 201 Created
ConversationAPIBody handles the get/create/update request/response for conversation.
- Code
- 400
- Type
- object
- Schema
- Description
- 400 Bad Request
Validator hold the validation errors. Typically you shouldn't create this directly but use the New() function.
201 Created
ConversationAPIBody
{ "conversation": { "contact": { "createdAt": "2024-09-06T11:47:28.789Z", "createdBy": { "delete": true, "id": 0, "meta": { "additionalProp": "Unknown Type: any" }, "type": 0 }, "deletedAt": "2024-09-06T11:47:28.789Z", "deletedBy": { "delete": true, "id": 0, "meta": { "additionalProp": "Unknown Type: any"