Rivier/ Reference/ inbox

Open a conversation for a customer

post/contact-centre/conversations

Open a conversation for a customer. It is matched to a contact by number or email, given service targets from its queue, and routed by skills and load (or to the queue's AI agent first).

Before you call

Credential
Authorization: Bearer $KEY
Scope
inbox:write
Mcp
rivier_cc_open
Graphql
Mutation.inboxContactCentreConversationCreate
Sdk
desk.conversations.open
Cli
desk open

Request bodyapplication/json, required

  • channelstringrequired
    One of: email, sms, whatsapp, voice, chat.
  • queueIdstring (uuid)
  • customerobjectrequired
    • namestring
      At most 120 characters.
    • phonestring
      At most 40 characters.
    • emailstring
      At most 320 characters.
    • contactIdstring (uuid)
  • subjectstring
    At most 200 characters.
  • prioritynumber
    One of: 0, 1, 2, 3.
  • skillslist of string
  • tagslist of string
  • textstring
    What the customer said first At most 4000 characters.

Responses

  • 201application/json
    Success
    • 400application/json
      The request was malformed
      • errorstringrequired
      • messagestring
    • 401application/json
      No valid credential
      • errorstringrequired
      • messagestring
    • 403application/json
      The credential lacks the scope, origin or address
      • errorstringrequired
      • messagestring
    • 429application/json
      Over the key's rate limit; see Retry-After
      • errorstringrequired
      • messagestring

    This page as Markdown