Skip to main content
GET
/
conversations
/
{conversation_id}
Conversation information
curl --request GET \
  --url https://api.partoo.co/v2/conversations/{conversation_id} \
  --header 'x-APIKey: <api-key>'
{
  "id": 123,
  "consumer_img": "https://www.example.com/profile-picture.jpg",
  "consumer_name": "John Doe",
  "consumer_phone_number": "+33612345678",
  "last_message": null,
  "is_read": true,
  "status": "Open",
  "created_at": "2023-01-31 16:22:17.327878+00:00",
  "has_one_user_message": true,
  "business": {
    "id": "<string>",
    "name": "<string>",
    "city": "<string>",
    "zipcode": "<string>",
    "country": "<string>",
    "formatted_address": "<string>"
  },
  "messaging_partner": "Facebook",
  "issues": [
    "facebook_no_page_linked"
  ],
  "first_message_date": "<string>",
  "is_expired": false,
  "is_solved": false,
  "assigned_user_id": "62d80fae74e8b11d700302b8",
  "custom_channel": null
}

Authorizations

​
x-APIKey
string
header
required

The authentication system on Partoo API is using API Key that should be put in the header of the request (the name of the header is x-APIKey). An api_key is linked to a user. This user's role will give you different access level to the API features.

Path Parameters

​
conversation_id
integer
required

The id of the conversation to fetch

Response

OK

The detail of a conversation.

​
id
integer
​
consumer_img
string<url> | null

The url of the consumer's profile picture

Example:

"https://www.example.com/profile-picture.jpg"

​
consumer_name
string | null

The name of the consumer, can be empty. The format may differ depending on the platform of contact (ex: "John Doe", "John Doe (@johndoe)", "@johndoe", "", ...).

Example:

"John Doe"

​
consumer_phone_number
string | null

The phone number of the consumer, formatted in E.164 international format (ex: "+33612345678").

Example:

"+33612345678"

​
last_message
object | null

The last message exchanged in the conversation.

​
is_read
boolean

If the last message received was read.
This property is scoped to the user who performs the request. Multiple partoo users can have a different is_read value for the same conversation.

​
status
enum<string>

If Open, it is possible to send a message in the conversation, else not. A conversation can be Closed if it is expired.

Available options:
Open,
Closed
​
created_at
string

The date of creation of the conversation, in the ISO 8601 format (ex: "2023-01-31 16:22:17.327878+00:00").

Example:

"2023-01-31 16:22:17.327878+00:00"

​
has_one_user_message
boolean

If the conversation has at least one message sent by a Partoo user.

​
business
object

Some basic information about the business that the conversation is associated with.

​
messaging_partner
enum<string>

The channel that the message is being sent to/from.

⚠️ New values may be added to this enum without prior notice and without following the classic depreciation cycle.
It is up to you to gracefully handle the case where new values are added.

Available options:
Google,
Facebook,
Instagram,
SMS,
Whatsapp
Example:

"Facebook"

​
issues
enum<string>[]

The list of issues that affect the conversation. The issues represent setup problem that the business may have with a messaging channel. It is not possible to send messages on a conversation that has issues.

⚠️ New values may be added to this enum without prior notice and without following the classic depreciation cycle.
It is up to you to gracefully handle the case where new values are added.

Example:
["facebook_no_page_linked"]
​
first_message_date
string

The date at which the first message of the conversation was received, in the ISO 8601 format (ex: "2023-01-31 16:22:17.327878+00:00").

​
is_expired
boolean

If the conversation has expired. A conversation expires if the consumer has not contacted the business for a certain amount of time.
You cannot send messages to an expired conversation.

Example:

false

​
is_solved
boolean

If the conversation has been solved.
Conversations can be solved from our app or by updating conversation status to "closed".

Example:

false

​
assigned_user_id
string

The "user_id" of the user assigned to the conversation.

Example:

"62d80fae74e8b11d700302b8"

​
custom_channel
object | null

Data about the custom channel, this object is filled only if the messaging partner is Custom.