Langsung ke konten
↑↓ navigasi↵ bukaEsc tutup
Bahasa IndonesiaEnglish

Referensi API

Chat

Percakapan dengan pembeli, balasan, catatan internal, dan label.

List chat conversations

GET/v1/chat/conversations

Inbox, most recent activity first.

Scope:chat:read

Query parameter

  • storeIdstringopsional

    format: uuid

  • filterstringopsional

    Salah satu dari:allunreadneeds_humanopenresolvedlate

  • assigneestringopsional

    me, unassigned, or a user id.

    panjang maks 40

  • labelstringopsional

    panjang maks 40

  • qstringopsional

    panjang maks 100

  • beforestringopsional

    format: date-time

  • limitintegeropsional

    min 1 · maks 100

Response200 · application/json

OK

  • itemsarray<ChatConversation>wajib
    Tampilkan 22 atribut turunan
    • contactIdstringwajibnullable

      format: uuid

    • assignedUserIdstringwajibnullable

      format: uuid

    • labelsarray<string>wajib
    • waitingSincestringwajibnullable

      Oldest unanswered buyer message; null when the shop spoke last.

      format: date-time

    • latebooleanwajib

      Waiting longer than the tenant's response target.

    • idstringwajib

      format: uuid

    • storeIdstringwajib

      format: uuid

    • storeNamestringwajib
    • marketplacestringwajib

      Salah satu dari:tiktokshopeelazadatokopedia

    • externalConversationIdstringwajib
    • buyerNamestringwajibnullable
    • buyerAvatarstringwajibnullable
    • canSendbooleanwajib

      False when the marketplace does not allow the shop to message this buyer.

    • unreadCountintegerwajib
    • lastMessageAtstringwajibnullable

      format: date-time

    • lastMessagePreviewstringwajibnullable
    • lastMessageRolestringwajibnullable

      Salah satu dari:buyershopagentsystemrobot

    • statusstringwajib

      Salah satu dari:openresolved

    • needsHumanbooleanwajib
    • handoffReasonstringwajibnullable
    • agentPausedbooleanwajib
    • hasDraftbooleanwajib
Contoh request · curl
curl "https://api.comnethub.app/v1/chat/conversations?limit=20" \
  -H "Authorization: Bearer $THECOMNET_API_KEY"

Get chat conversation

GET/v1/chat/conversations/{conversationId}

Conversation with messages, agent draft, and buyer orders.

Scope:chat:read

Path parameter

  • conversationIdstringwajib

    format: uuid

Response200 · application/json

OK

  • contactIdstringwajibnullable

    format: uuid

  • assignedUserIdstringwajibnullable

    format: uuid

  • labelsarray<string>wajib
  • waitingSincestringwajibnullable

    Oldest unanswered buyer message; null when the shop spoke last.

    format: date-time

  • latebooleanwajib

    Waiting longer than the tenant's response target.

  • idstringwajib

    format: uuid

  • storeIdstringwajib

    format: uuid

  • storeNamestringwajib
  • marketplacestringwajib

    Salah satu dari:tiktokshopeelazadatokopedia

  • externalConversationIdstringwajib
  • buyerNamestringwajibnullable
  • buyerAvatarstringwajibnullable
  • canSendbooleanwajib

    False when the marketplace does not allow the shop to message this buyer.

  • unreadCountintegerwajib
  • lastMessageAtstringwajibnullable

    format: date-time

  • lastMessagePreviewstringwajibnullable
  • lastMessageRolestringwajibnullable

    Salah satu dari:buyershopagentsystemrobot

  • statusstringwajib

    Salah satu dari:openresolved

  • needsHumanbooleanwajib
  • handoffReasonstringwajibnullable
  • agentPausedbooleanwajib
  • hasDraftbooleanwajib
  • notesarray<ChatNote>wajib
    Tampilkan 5 atribut turunan
    • idstringwajib

      format: uuid

    • userIdstringwajibnullable

      format: uuid

    • userNamestringwajibnullable
    • bodystringwajib
    • createdAtstringwajib

      format: date-time

  • messagesarray<ChatMessage>wajib

    Oldest first, at most the latest 200.

    Tampilkan 9 atribut turunan
    • idstringwajib

      format: uuid

    • rolestringwajib

      Salah satu dari:buyershopagentsystemrobot

    • senderNamestringwajibnullable
    • typestringwajib

      Marketplace message type, e.g. TEXT, IMAGE, ORDER_CARD, PRODUCT_CARD.

    • textstringwajibnullable
    • contentobject (map)wajib

      Parsed marketplace content (url for images, order_id for order cards, ...).

    • sentByUserIdstringwajibnullable

      format: uuid

    • sentByAgentbooleanwajib
    • createdAtstringwajib

      format: date-time

  • draftReplystringwajibnullable
  • draftRunIdstringwajibnullable

    format: uuid

  • lastRunChatAgentRunwajibnullable
    Tampilkan 12 atribut turunan
    • idstringwajib

      format: uuid

    • conversationIdstringwajib

      format: uuid

    • modestringwajib

      Salah satu dari:offsuggestauto

    • outcomestringwajib

      Salah satu dari:repliedsuggestedhandoffskippederror

    • replystringwajibnullable
    • reasonstringwajibnullable
    • toolsarray<ChatAgentToolCall>wajib
      Tampilkan 3 atribut turunan
      • namestringwajib
      • inputobject (map)wajib
      • okbooleanwajib
    • modelstringwajibnullable
    • inputTokensintegerwajibnullable
    • outputTokensintegerwajibnullable
    • cacheReadTokensintegerwajibnullable
    • createdAtstringwajib

      format: date-time

  • buyerOrdersarray<ChatBuyerOrder>wajib
    Tampilkan 7 atribut turunan
    • orderIdstringwajib

      format: uuid

    • externalOrderIdstringwajib
    • statusstringwajib
    • marketplaceStatusstringwajibnullable
    • totalstring (decimal)wajib

      Decimal string with two fraction digits.

    • currencystringwajib
    • placedAtstringwajib

      format: date-time

Contoh request · curl
curl "https://api.comnethub.app/v1/chat/conversations/$CONVERSATION_ID" \
  -H "Authorization: Bearer $THECOMNET_API_KEY"

Update chat conversation

PATCH/v1/chat/conversations/{conversationId}

Resolve or reopen, clear the handoff flag, pause the agent.

Scope:chat:write

Path parameter

  • conversationIdstringwajib

    format: uuid

Request bodyapplication/json

  • assignedUserIdstringopsionalnullable

    format: uuid

  • labelsarray<string>opsional

    item maks 20

  • statusstringopsional

    Salah satu dari:openresolved

  • needsHumanbooleanopsional

    Clears the handoff flag.

    Salah satu dari:false

  • agentPausedbooleanopsional

Response200 · application/json

OK

  • contactIdstringwajibnullable

    format: uuid

  • assignedUserIdstringwajibnullable

    format: uuid

  • labelsarray<string>wajib
  • waitingSincestringwajibnullable

    Oldest unanswered buyer message; null when the shop spoke last.

    format: date-time

  • latebooleanwajib

    Waiting longer than the tenant's response target.

  • idstringwajib

    format: uuid

  • storeIdstringwajib

    format: uuid

  • storeNamestringwajib
  • marketplacestringwajib

    Salah satu dari:tiktokshopeelazadatokopedia

  • externalConversationIdstringwajib
  • buyerNamestringwajibnullable
  • buyerAvatarstringwajibnullable
  • canSendbooleanwajib

    False when the marketplace does not allow the shop to message this buyer.

  • unreadCountintegerwajib
  • lastMessageAtstringwajibnullable

    format: date-time

  • lastMessagePreviewstringwajibnullable
  • lastMessageRolestringwajibnullable

    Salah satu dari:buyershopagentsystemrobot

  • statusstringwajib

    Salah satu dari:openresolved

  • needsHumanbooleanwajib
  • handoffReasonstringwajibnullable
  • agentPausedbooleanwajib
  • hasDraftbooleanwajib
Contoh request · curl
curl -X PATCH "https://api.comnethub.app/v1/chat/conversations/$CONVERSATION_ID" \
  -H "Authorization: Bearer $THECOMNET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "assignedUserId": "0192f0c4-8d1e-7a4b-9c3e-5f6a7b8c9d0e",
  "labels": [
    "string"
  ],
  "status": "open",
  "needsHuman": false,
  "agentPaused": true
}'

Send chat message

POST/v1/chat/conversations/{conversationId}/messages

Send a text reply through the marketplace.

Scope:chat:write

Path parameter

  • conversationIdstringwajib

    format: uuid

Request bodyapplication/json

  • textstringwajib

    panjang min 1 · panjang maks 2000

  • fromDraftbooleanopsional

    Clears the agent draft after sending.

Response201 · application/json

OK

  • idstringwajib

    format: uuid

  • rolestringwajib

    Salah satu dari:buyershopagentsystemrobot

  • senderNamestringwajibnullable
  • typestringwajib

    Marketplace message type, e.g. TEXT, IMAGE, ORDER_CARD, PRODUCT_CARD.

  • textstringwajibnullable
  • contentobject (map)wajib

    Parsed marketplace content (url for images, order_id for order cards, ...).

  • sentByUserIdstringwajibnullable

    format: uuid

  • sentByAgentbooleanwajib
  • createdAtstringwajib

    format: date-time

Contoh request · curl
curl -X POST "https://api.comnethub.app/v1/chat/conversations/$CONVERSATION_ID/messages" \
  -H "Authorization: Bearer $THECOMNET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "text": "string"
}'

Add chat note

POST/v1/chat/conversations/{conversationId}/notes

Add an internal note (never sent to the buyer).

Scope:chat:write

Path parameter

  • conversationIdstringwajib

    format: uuid

Request bodyapplication/json

  • bodystringwajib

    panjang min 1 · panjang maks 2000

Response201 · application/json

OK

  • idstringwajib

    format: uuid

  • userIdstringwajibnullable

    format: uuid

  • userNamestringwajibnullable
  • bodystringwajib
  • createdAtstringwajib

    format: date-time

Contoh request · curl
curl -X POST "https://api.comnethub.app/v1/chat/conversations/$CONVERSATION_ID/notes" \
  -H "Authorization: Bearer $THECOMNET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "body": "string"
}'

List chat labels

GET/v1/chat/labels

Labels in use on conversations.

Scope:chat:read

Response200 · application/json

OK

  • itemsarray<string>wajib
Contoh request · curl
curl "https://api.comnethub.app/v1/chat/labels" \
  -H "Authorization: Bearer $THECOMNET_API_KEY"

Mark chat read

POST/v1/chat/conversations/{conversationId}/read

Mark buyer messages read at the marketplace.

Scope:chat:write

Path parameter

  • conversationIdstringwajib

    format: uuid

Response204

OK

Tidak ada response body.

Contoh request · curl
curl -X POST "https://api.comnethub.app/v1/chat/conversations/$CONVERSATION_ID/read" \
  -H "Authorization: Bearer $THECOMNET_API_KEY"

List chat quick replies

GET/v1/chat/quick-replies

Saved replies.

Scope:chat:read

Response200 · application/json

OK

  • itemsarray<ChatQuickReply>wajib
    Tampilkan 3 atribut turunan
    • idstringwajib

      format: uuid

    • shortcutstringwajib
    • bodystringwajib
Contoh request · curl
curl "https://api.comnethub.app/v1/chat/quick-replies" \
  -H "Authorization: Bearer $THECOMNET_API_KEY"