Conversation sessions

Enqueue a conversation session

Enqueues the open conversation session for a contact into a queue and persists the observation as transfer_observation.

post/conversation-sessions/enqueue

Request body

waIdstring required

Contact WhatsApp ID

phoneNumberWaIdstring required

Business phone WhatsApp ID

queueIdstring uuid required

Queue id

observationstring required

Observation persisted on the session as transfer_observation

Response

Session enqueued successfully

idstring uuid required
conversationIdstring uuid required
statusstring required
currentQueueIdstring uuid nullable required
enqueueDatestring date-time nullable required
ticketIdinteger nullable required
transferObservationstring nullable required

Changes

Changed in 2 of the 9 revisions of this API.810

  • 8ccfb9a461e289See the full diff
    • the observation request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • the phoneNumberWaId request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • the waId request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • added the pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ to the request property queueId

      request-property-pattern-added

    • response property currentQueueId list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property enqueueDate list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property ticketId list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property transferObservation list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • the response property conversationId became required for the status 200

      response-property-became-required

    • the response property currentQueueId became required for the status 200

      response-property-became-required

    • the response property enqueueDate became required for the status 200

      response-property-became-required

    • the response property id became required for the status 200

      response-property-became-required

    • the response property status became required for the status 200

      response-property-became-required

    • the response property ticketId became required for the status 200

      response-property-became-required

    • the response property transferObservation became required for the status 200

      response-property-became-required

    • the conversationId response's property pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ was added for the status 200

      response-property-pattern-added

    • the id response's property pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ was added for the status 200

      response-property-pattern-added

    • endpoint added

      endpoint-added