Conversations

Conversations are an essential part of Oblic — they are the containers for the messages between you, your contacts, and groups. On this page, we’ll dive into the different conversation endpoints you can use to manage conversations programmatically. We'll look at how to query, create, update, and delete conversations.

The conversation model

The conversation model contains all the information about the conversations between you and your contacts. In addition, conversations can also be group-based with more than one contact, they can have a pinned message, and they can be muted.

Properties

Имя
id
Тип
string
Описание
Unique identifier for the conversation.
Имя
contact_id
Тип
string
Описание
Unique identifier for the other contact in the conversation.
Имя
group_id
Тип
string
Описание
Unique identifier for the group that the conversation belongs to.
Имя
pinned_message_id
Тип
string
Описание
Unique identifier for the pinned message.
Имя
is_pinned
Тип
boolean
Описание
Whether or not the conversation has been pinned.
Имя
is_muted
Тип
boolean
Описание
Whether or not the conversation has been muted.
Имя
last_active_at
Тип
timestamp
Описание
Timestamp of when the conversation was last active.
Имя
last_opened_at
Тип
timestamp
Описание
Timestamp of when the conversation was last opened by the authenticated user.
Имя
created_at
Тип
timestamp
Описание
Timestamp of when the conversation was created.
Имя
archived_at
Тип
timestamp
Описание
Timestamp of when the conversation was archived.

GET/v1/conversations

List all conversations

This endpoint allows you to retrieve a paginated list of all your conversations. By default, a maximum of ten conversations are shown per page.

Optional attributes

Имя
limit
Тип
integer
Описание
Limit the number of conversations returned.
Имя
muted
Тип
boolean
Описание
Only show conversations that are muted when set to true.
Имя
archived
Тип
boolean
Описание
Only show conversations that are archived when set to true.
Имя
pinned
Тип
boolean
Описание
Only show conversations that are pinned when set to true.
Имя
group_id
Тип
string
Описание
Only show conversations for the specified group.

Request

GET

/v1/conversations

curl -G https://api.oblic.app/external/conversations \
  -H "Authorization: Bearer {token}" \
  -d limit=10

Response

{
  "has_more": false,
  "data": [
    {
      "id": "xgQQXg3hrtjh7AvZ",
      "contact_id": "WAz8eIbvDR60rouK",
      "group_id": null,
      "pinned_message_id": null,
      "is_pinned": false,
      "is_muted": false,
      "last_active_at": 705103200,
      "last_opened_at": 705103200,
      "created_at": 692233200,
      "archived_at": null
    },
    {
      "id": "hSIhXBhNe8X1d8Et"
      // ...
    }
  ]
}

POST/v1/conversations

Create a conversation

This endpoint allows you to add a new conversation between you and a contact or group. A contact or group id is required to create a conversation.

Required attributes

Имя
contact_id
Тип
string
Описание
Unique identifier for the other contact in the conversation.
Имя
group_id
Тип
string
Описание
Unique identifier for the group that the conversation belongs to.

Request

POST

/v1/conversations

curl https://api.oblic.app/external/conversations \
  -H "Authorization: Bearer {token}" \
  -d 'contact_id'="WAz8eIbvDR60rouK"

Response

{
  "id": "xgQQXg3hrtjh7AvZ",
  "contact_id": "WAz8eIbvDR60rouK",
  "group_id": null,
  "pinned_message_id": null,
  "is_pinned": false,
  "is_muted": false,
  "last_active_at": null,
  "last_opened_at": null,
  "created_at": 692233200,
  "archived_at": null
}

GET/v1/conversations/:id

Retrieve a conversation

This endpoint allows you to retrieve a conversation by providing the conversation id. Refer to the list at the top of this page to see which properties are included with conversation objects.

Request

GET

/v1/conversations/xgQQXg3hrtjh7AvZ

curl https://api.oblic.app/external/conversations/xgQQXg3hrtjh7AvZ \
  -H "Authorization: Bearer {token}"

Response

{
  "id": "xgQQXg3hrtjh7AvZ",
  "contact_id": "WAz8eIbvDR60rouK",
  "group_id": null,
  "pinned_message_id": null,
  "is_pinned": false,
  "is_muted": false,
  "last_active_at": 705103200,
  "last_opened_at": 705103200,
  "created_at": 692233200,
  "archived_at": null
}

PUT/v1/conversations/:id

Update a conversation

This endpoint allows you to perform an update on a conversation. Examples of updates are pinning a message, muting or archiving the conversation, or pinning the conversation itself.

Optional attributes

Имя
pinned_message_id
Тип
string
Описание
Unique identifier for the pinned message.
Имя
is_pinned
Тип
boolean
Описание
Whether or not the conversation has been pinned.
Имя
is_muted
Тип
boolean
Описание
Whether or not the conversation has been muted.
Имя
archived_at
Тип
timestamp
Описание
Timestamp of when the conversation was archived.

Request

PUT

/v1/conversations/xgQQXg3hrtjh7AvZ

curl -X PUT https://api.oblic.app/external/conversations/xgQQXg3hrtjh7AvZ \
  -H "Authorization: Bearer {token}" \
  -d 'is_muted'=true

Response

{
  "id": "xgQQXg3hrtjh7AvZ",
  "contact_id": "WAz8eIbvDR60rouK",
  "group_id": null,
  "pinned_message_id": null,
  "is_pinned": false,
  "is_muted": true,
  "last_active_at": 705103200,
  "last_opened_at": 705103200,
  "created_at": 692233200,
  "archived_at": null
}

DELETE/v1/conversations/:id

Delete a conversation

This endpoint allows you to delete your conversations in Oblic. Note: This will permanently delete the conversation and all its messages — archive it instead if you want to be able to restore it later.

Request

DELETE

/v1/conversations/xgQQXg3hrtjh7AvZ

curl -X DELETE https://api.oblic.app/external/conversations/xgQQXg3hrtjh7AvZ \
  -H "Authorization: Bearer {token}"