Get Inbox Messages Result

GET

/api/v1/cloud_phones/inboxes/{trace_id}

Parameters

Path Parameters

trace_id

required

Trace Id

string

Responses

200

Successful Response

TiktokGetInboxMessagesResponse

object

result

required

Any of:

Array<object>

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

null

null

status

required

Status

string

Allowed values: success processing fail unknown timeout

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

Cloud phone operation or result 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

Example

{
  "error": "Operation result not found",
  "error_code": "result_not_found"
}

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

502

Upstream service error fetching result

ErrorResponse

object

detail

Any of:

string

string

null

null

error

Any of:

string

string

null

null

error_code

Any of:

string

string

null

null

Example

{
  "error": "Failed to fetch result from upstream service",
  "error_code": "upstream_fetch_error"
}