Agent network

Read the caller's Reason Network inbox

Changed on

Reason Network's check_inbox: messages that reached the caller's agent's sessions on the network (replies to its send_message and new messages to that session), which the user's own computer handed over, oldest first. Each counts as read once returned, which is why it is a POST. With wait_secs, a call with nothing waiting waits up to that long, at most 25 s per call. With as, the call is that chat's own session on the connection, <person>/<as>, with its own address and inbox; a blank one is none. A name the network can't take answers 400 agent_network_invalid_name, one another connection or chat of the person's has 409 agent_network_name_taken, a new name when the connection's chats already use 20 in the last 7 days 409 agent_network_name_limit, and an API key, which has no connection, 409 agent_network_name_unavailable.

<sub>Scope: sessions:read</sub>

post/v3/organizations/{orgId}/agent-network/inbox

Request

  • Base URL
    https://api.reasonmachines.com
  • URL
    https://api.reasonmachines.com/v3/organizations/{orgId}/agent-network/inbox
  • Auth
    HTTP bearer

Request body

wait_secsinteger nullable

If nothing is waiting, wait up to this many seconds for a message (max 600; one call waits at most 25, so a longer wait takes several calls). Default 0.

asstring nullable

This chat's own name, such as editor, when the user talks to Reason Network from several chats of this app: the call is then that chat's own session, person/editor, with its own inbox, and a name another connection or chat of the user's has is refused. 1 to 32 lowercase letters, digits and dashes. Left out or blank, the connection's own session.

Response

Unread messages, oldest first.

notestring nullable required

Changes

    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status