Get Social Messages

GET

/api/v1/social_messages/

Get inbox messages for a specific agent. Returns the inbox list with all conversations.

Parameters

Query Parameters

agent_id

required

Agent Id

Agent ID to fetch messages for

string

Agent ID to fetch messages for

Responses

200

Successful Response

SocialMessageResponse

Response containing inbox list with all conversations.

object

data

Data

Array<object>

InboxItem

Item in the inbox list representing a conversation. Synced with TiktokInboxMessage + UserMessagesResult.

object

friend_nickname

Any of:

string

string

null

null

friend_username

Any of:

string

string

null

null

friend_avatar_url

Any of:

string

string

null

null

messages

Messages

List of messages

Array<object>

MessageItem

Individual message in a conversation. Synced with TiktokUserMessage.

object

type

required

Type

Type of message

string

Allowed values: sticker text time

text

required

Text

string

username

Any of:

string

string

null

null

image_url

Any of:

string

string

null

null

key

additional properties

any

last_message

Any of:

string

string

null

null

last_message_time

Any of:

string

string

null

null

key

additional properties

any

pending_messages

Pending Messages

Array<object>

PendingMessage

Pending message details waiting for processing.

object

text

required

Text

string

nickname

required

Nickname

string

username

Any of:

string

string

null

null

status

Status

string

default: init

Allowed values: init processing retry fail sent

trace_id

Any of:

string

string

null

null

created_at

Any of:

string

string

null

null

updated_at

Any of:

string

string

null

null

agent_id

Any of:

string

string

null

null

id

Any of:

string

string

null

null

agent_id

required

Agent Id

string

updated_at

Any of:

string

string format: date-time

null

null

400

Bad Request

ErrorResponse

object

detail

Any of:

string

string

null

null

error

Any of:

string

string

null

null

error_code

Any of:

string

string

null

null

404

Not Found

ErrorResponse

object

detail

Any of:

string

string

null

null

error

Any of:

string

string

null

null

error_code

Any of:

string

string

null

null

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

500

Internal Server Error

ErrorResponse

object

detail

Any of:

string

string

null

null

error

Any of:

string

string

null

null

error_code

Any of:

string

string

null

null