List Auto-Response Settings

GET 
/messaging_profiles/:profile_id/autoresp_configs

List Auto-Response Settings

Request

Path Parameters

profile_id uuidrequired

Query Parameters

country_code Country Code
created_at[gte] Created At[Gte]
created_at[lte] Created At[Lte]
updated_at[gte] Updated At[Gte]
updated_at[lte] Updated At[Lte]

Responses

200: Successful Response

application/json

• Schema
• Example (from schema)
• Example

Schema

data

object[]

required

Array [

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

]

meta

object

required

total_pages integer

total_results integer

page_number integer

page_size integer

{
  "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-04-26T12:28:37.154Z",
      "updated_at": "2024-04-26T12:28:37.154Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

{
  "data": [
    {
      "op": "start",
      "keywords": [
        "START",
        "BEGIN"
      ],
      "resp_text": "Thank you for subscribing US customer.",
      "country_code": "US",
      "id": "677ec1cb-949e-4aeb-a1c3-6d9ddffc1409",
      "created_at": "2023-03-21T23:37:45.858535+00:00",
      "updated_at": "2023-03-21T23:37:45.858535+00:00"
    },
    {
      "op": "stop",
      "keywords": [
        "END",
        "STOP"
      ],
      "resp_text": "You have unsubscribed.",
      "country_code": "US",
      "id": "54b7e19f-98a8-416f-81d1-a2782eade48b",
      "created_at": "2023-03-10T21:54:46.293380+00:00",
      "updated_at": "2023-03-10T21:54:46.293380+00:00"
    },
    {
      "op": "start",
      "keywords": [
        "START"
      ],
      "resp_text": "Thank you for subscribing.",
      "country_code": "*",
      "id": "cfe07be1-2369-433f-be00-eb176008e834",
      "created_at": "2023-03-14T14:46:21.097735+00:00",
      "updated_at": "2023-03-14T14:46:21.097735+00:00"
    }
  ],
  "meta": {
    "page_number": 1,
    "page_size": 5,
    "total_pages": 1,
    "total_results": 3
  }
}

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": {}
    }
  ]
}

Loading...