List sample

GET /v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples

TODO: Resource-level docs

Path parameters

  • AssistantSid string Required

    The SID of the Assistant that is the parent of the Task associated with the resources to read.

  • TaskSid string Required

    The SID of the Task associated with the Sample resources to read.

Query parameters

  • Language string

    The ISO language-country string that specifies the language used for the sample. For example: en-US.

  • PageSize integer

    How many resources to return in each list page. The default is 50, and the maximum is 1000.

    Minimum value is 1, maximum value is 1000.

Responses

  • • 200

    OK

    Hide response attributes Show response attributes object
    • meta object
      Hide meta attributes Show meta attributes
    • samples array[object]
      Hide samples attributes Show samples attributes
      • account_sid string | null

        The SID of the Account that created the resource

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

      • assistant_sid string | null

        The SID of the Assistant that is the parent of the Task associated with the resource

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

      • date_created string(date-time) | null

        The RFC 2822 date and time in GMT when the resource was created

      • date_updated string(date-time) | null

        The RFC 2822 date and time in GMT when the resource was last updated

      • language string | null

        An ISO language-country string that specifies the language used for the sample

      • sid string | null

        The unique string that identifies the resource

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

      • source_channel string | null

        The communication channel from which the sample was captured

      • tagged_text string | null

        The text example of how end users might express the task

      • task_sid string | null

        The SID of the Task associated with the resource

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

      • url string(uri) | null

        The absolute URL of the Sample resource
GET /v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples 
curl \
 -X GET https://autopilot.twilio.com/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples \
 --user "username:password"
Response examples (200) 
{
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  },
  "samples": [
    {
      "account_sid": "string",
      "assistant_sid": "string",
      "date_created": "2023-05-04T09:42:00+00:00",
      "date_updated": "2023-05-04T09:42:00+00:00",
      "language": "string",
      "sid": "string",
      "source_channel": "string",
      "tagged_text": "string",
      "task_sid": "string",
      "url": "https://example.com"
    }
  ]
}