NAnatural
Voice

List voice sessions

Changed on

List voice sessions

get/voice/sessions

Request

  • Base URL
    https://api.natural.com
  • URL
    https://api.natural.com/voice/sessions
  • Auth
    HTTP bearer

Query parameters

customerPartyIdstring

Customer party to act for (pty_*). Omit for your account's call log, including delegated activity. Requires authorization from that customer.

paymentIntentIdstring

Only sessions associated with this payment intent.

status'awaitingCall' | 'inProgress' | 'ended' | 'canceled' | 'expired'

Filter by call-session status.

createdAfterstring

Only sessions created after this RFC 3339 timestamp (exclusive).

createdBeforestring

Only sessions created before this RFC 3339 timestamp (exclusive).

limitinteger

Maximum results per page.

cursorstring

Cursor from the previous page with the same customer and filters.

Headers

X-Instance-IDstring nullable

Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.

Response

Successful Response

Changes

  • a63c15c71a0cRevision changes
    • breaking

      removed the enum value failed from the query request parameter status

    • info

      removed the failed enum value from the //// response property for the response status

  • 6663cdab7a7cRevision changes
    • breaking

      the // response's property type changed from object to no type for status

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • info

      added subschema #1: PaymentVoiceSessionAttributes to the // response property anyOf list for the response status