NAnatural
Voice

Get voice session

Changed on

Get a voice session

get/voice/sessions/{voiceSessionId}

Request

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

Path parameters

voiceSessionIdstring required

Voice session ID (vos_*).

Query parameters

customerPartyIdstring

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

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
    • 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