Path parameters

• ServiceSid string Required

  The SID of the parent Service resource.

  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^KS[0-9a-fA-F]{32}$.

Responses

• 201 application/json

  Created

  Hide headers attributes Show headers attributes

  • Access-Control-Allow-Origin string

    Specify the origin(s) allowed to access the resource

  • Access-Control-Allow-Methods string

    Specify the HTTP methods allowed when accessing the resource

  • Access-Control-Allow-Headers string

    Specify the headers allowed when accessing the resource

  • Access-Control-Allow-Credentials boolean

    Indicates whether the browser should include credentials

  • Access-Control-Expose-Headers string

    Headers exposed to the client

  Hide response attributes Show response attributes object

  • sid string | null

    The unique string that we created to identify the Session resource.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^KC[0-9a-fA-F]{32}$.

  • service_sid string | null

    The SID of the Service the session is associated with.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^KS[0-9a-fA-F]{32}$.

  • account_sid string | null

    The SID of the Account that created the Session resource.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

  • date_started string(date-time) | null

    The ISO 8601 date when the Session started.

  • date_ended string(date-time) | null

    The ISO 8601 date when the Session ended.

  • date_last_interaction string(date-time) | null

    The ISO 8601 date when the Session last had an interaction.

  • date_expiry string(date-time) | null

    The ISO 8601 date when the Session should expire. If this is value is present, it overrides the ttl value.

  • unique_name string | null

    An application-defined string that uniquely identifies the resource. This value must be 191 characters or fewer in length and be unique. Supports UTF-8 characters. This value should not have PII.

  • status string

    The status of the Session. Can be: open, in-progress, closed, failed, or unknown.

    Values are open, in-progress, closed, failed, or unknown.

  • closed_reason string | null

    The reason the Session ended.

  • ttl integer

    The time, in seconds, when the session will expire. The time is measured from the last Session create or the Session's last Interaction.

    Default value is 0.

  • mode string

    The Mode of the Session. Can be: message-only, voice-only, or voice-and-message.

    Values are message-only, voice-only, or voice-and-message.

  • date_created string(date-time) | null

    The ISO 8601 date and time in GMT when the resource was created.

  • date_updated string(date-time) | null

    The ISO 8601 date and time in GMT when the resource was last updated.

  • url string(uri) | null

    The absolute URL of the Session resource.

  • links object(uri-map) | null

    The URLs of resources related to the Session.