Skip to main content

Fetch multiple call resources

GET 

/texml/Accounts/:account_sid/Calls

Returns multiple call resouces for an account. This endpoint is eventually consistent.

Request

Path Parameters

    account_sid stringrequired

    The id of the account the resource belongs to.

Query Parameters

    Page integer

    The number of the page to be displayed, zero-indexed, should be used in conjuction with PageToken.

    Example: 1
    PageSize integer

    The number of records to be displayed on a page

    Example: 10
    PageToken string

    Used to request the next page of results.

    To string

    Filters calls by the to number.

    Example: +1312345678
    From string

    Filters calls by the from number.

    Example: +1312345678
    Status string

    Possible values: [canceled, completed, failed, busy, no-answer]

    Filters calls by status.

    Example: no-answer
    StartTime string

    Filters calls by the start date. Expected format is YYYY-MM-DD. Also accepts inequality operators, e.g. StartTime>=2023-05-22.

    Example: >=2023-05-22
    EndTime string

    Filters calls by their end date. Expected format is YYYY-MM-DD. Also accepts inequality operators, e.g. EndTime>=2023-05-22.

    Example: >=2023-05-22

Responses

200: Multiple call resources.

Schema

    data

    object

    calls

    object[]

  • Array [

  • account_sid string

    The id of the account the resource belongs to.

    answered_by string

    Possible values: [human, machine, not_sure]

    The value of the answering machine detection result, if this feature was enabled for the call.

    caller_name string

    Caller ID, if present.

    date_created string

    The timestamp of when the resource was created.

    date_updated string

    The timestamp of when the resource was last updated.

    direction string

    Possible values: [inbound, outbound]

    The direction of this call.

    duration string

    The duration of this call, given in seconds.

    end_time string

    The end time of this call.

    from string

    The phone number or SIP address that made this call.

    from_formatted string

    The from number formatted for display.

    price string

    The price of this call, the currency is specified in the price_unit field. Only populated when the call cost feature is enabled for the account.

    price_unit string

    The unit in which the price is given.

    sid string

    The identifier of this call.

    start_time string

    The start time of this call.

    status string

    Possible values: [ringing, in-progress, canceled, completed, failed, busy, no-answer]

    The status of this call.

    to string

    The phone number or SIP address that received this call.

    to_formatted string

    The to number formatted for display.

    uri string

    The relative URI for this call.

  • ]

  • end integer

    The number of the last element on the page, zero-indexed.

    first_page_uri string

    /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=0&PageSize=1

    next_page_uri string

    /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=1&PageSize=1&PageToken=MTY4AjgyNDkwNzIxMQ

    page integer

    Current page number, zero-indexed.

    page_size integer

    The number of items on the page

    start integer

    The number of the first element on the page, zero-indexed.

    uri string

    The URI of the current page.

404: Resource not found

Schema

    data

    object

    errors

    object[]

  • Array [

  • detail string
  • ]

Loading...