Create Auto-Reponse Setting

POST 
/messaging_profiles/:profile_id/autoresp_configs

Create Auto-Reponse Setting

Request

Path Parameters

profile_id Profile Idrequired

application/json

Body

required

op Op (string)required

Possible values: [start, stop, info]

keywords string[]required
resp_text Resp Text (string)
country_code Country Code (string)required

Responses

200: Successful Response

application/json

• Schema
• Example (from schema)
• Example

Schema

data

object

required

op Op (string)required

Possible values: [start, stop, info]

keywords string[]required

resp_text Resp Text (string)

country_code Country Code (string)required

id Id (string)required

created_at date-timerequired

updated_at date-timerequired

{
  "data": {
    "op": "start",
    "keywords": [
      "START",
      "BEGIN"
    ],
    "resp_text": "Thank you for subscribing to our service.",
    "country_code": "*",
    "id": "b8f9c1c0-5b5a-4b1e-8c1c-0b5a4b1e8c1c",
    "created_at": "2024-07-26T07:42:15.508Z",
    "updated_at": "2024-07-26T07:42:15.508Z"
  }
}

{
  "data": {
    "op": "start",
    "keywords": [
      "START"
    ],
    "resp_text": "Hello there!",
    "country_code": "US",
    "id": "c2298f86-a4dc-4cac-b6b6-4a3d01c290fa",
    "created_at": "2023-03-22T00:06:49.068817+00:00",
    "updated_at": "2023-03-22T00:06:49.068817+00:00"
  }
}

default: Unexpected error

application/json

• Schema
• Example (from schema)

Schema

errors

Error[]

Array [

code integerrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta object

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/messaging_profiles/:profile_id/autoresp_configs' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "op": "start",
  "keywords": [
    "keyword1",
    "keyword2"
  ],
  "resp_text": "Thank you for your message",
  "country_code": "US"
}'

Response samples

• 200
• default

---

{
  "data": {
    "op": "start",
    "keywords": [
      "START"
    ],
    "resp_text": "Hello there!",
    "country_code": "US",
    "id": "c2298f86-a4dc-4cac-b6b6-4a3d01c290fa",
    "created_at": "2023-03-22T00:06:49.068817+00:00",
    "updated_at": "2023-03-22T00:06:49.068817+00:00"
  }
}

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}