Opt-Out Management

Create auto-response setting

Changed on

Creates an auto-response rule on the specified messaging profile. Matching inbound messages trigger the configured response.

post/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 required

Unique identifier of the profile.

Request body

op'start' | 'stop' | 'info' required
keywordsstring[] required
resp_textstring
country_codestring required

Example request

{
  "keywords": [
    "keyword1",
    "keyword2"
  ],
  "resp_text": "Thank you for your message",
  "country_code": "US"
}

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"
  }
}

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