Opt-Out Management

List Auto-Response Settings

Changed on

Returns the auto-response rules configured for the specified messaging profile.

get/messaging_profiles/{profile_id}/autoresp_configs

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/messaging_profiles/{profile_id}/autoresp_configs
  • Auth: HTTP bearer

Path parameters

profile_idstring uuid required

Unique identifier of the profile.

Query parameters

country_codestring

Filter results by country code.

gtestring
ltestring

Consolidated created_at parameter (deepObject style). Originally: created_at[gte], created_at[lte]

gtestring
ltestring

Consolidated updated_at parameter (deepObject style). Originally: updated_at[gte], updated_at[lte]

Response

Successful Response

Example response

{
  "data": [
    {
      "op": "start",
      "keywords": [
        "START",
        "BEGIN"
      ],
      "resp_text": "Thank you for subscribing to our service.",
      "country_code": "*",
      "id": "b8f9c1c0-5b5a-4b1e-8c1c-0b5a4b1e8c1c"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

Changes

  • 1571b0380bd7Revision changes
    • breaking

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

    • breaking

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

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

  • 8f5f4e537994Revision changes
    • breaking

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

    • breaking

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

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the /// response's property format changed from json-pointer to no format for status