platform
resources
resource-management

Get inbound configurations

Get all configurations using a filter.<br/> If you want configuration for a specific number or resource, then one of the following parameters is required: <code>number, numberKey, resource</code> or <code>resourceKey</code>.<br/> If you are using <code>configurationKey</code> none of previously mentioned parameters are needed.

get/resource-management/1/inbound-message-configurations

Request

  • Base URL
    https://api.infobip.com (the document declares no server; this is the origin it was published from)
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://api.infobip.com/auth/1/oauth2/token
    • or API key in header Authorization
    • or API key in header Authorization
    • or HTTP basic

Query parameters

configurationKeystring

Unique ID of configuration.

Example:58BC6DB7966CB9F69A91EB956DF73239
numberstring
Example:41793026727
numberKeystring

Unique ID of a number.

Example:58BC6DB7966CB9F69A91EB956DF73239
resourcestring
Example:41793026727
resourceKeystring

Unique ID of a resource.

Example:58BC6DB7966CB9F69A91EB956DF73239
keywordstring

Configuration keyword.

Example:STARTKW
channel'SMS' | 'MMS' | 'WHATSAPP' | 'RCS' | 'VIBER_BM' | 'APPLE_MB' | 'LINE_OA' | 'KAKAO_SANGDAM' | 'MESSENGER' | 'INSTAGRAM_DM' | 'ZALO_ZNS' | 'TELEGRAM' | 'VIBER_BOT' | 'EMAIL' | 'ZALO_FOLLOWER' | 'OPEN_CHANNEL' | 'TIKTOK_BM' required

Channel type.

Example:SMS

Required if <code>number, numberKey, resource</code> or <code>resourceKey</code> present.

countryCodestring

Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).

Example:GB

Response

OK

configurationKeystring required

The key of a stored configuration.

channel'SMS' | 'MMS' | 'WHATSAPP' | 'RCS' | 'VIBER_BM' | 'APPLE_MB' | 'LINE_OA' | 'KAKAO_SANGDAM' | 'MESSENGER' | 'INSTAGRAM_DM' | 'ZALO_ZNS' | 'TELEGRAM' | 'VIBER_BOT' | 'EMAIL' | 'ZALO_FOLLOWER' | 'OPEN_CHANNEL' | 'TIKTOK_BM'

Channel type.

keywordstring

Configuration keyword.

usernamestring

Configuration username.

Example response

[
  {
    "configurationKey": "E9FCDCA496035F08EEA5933702EDF745",
    "channel": "SMS",
    "keyword": "STARTKW",
    "username": "myusername",
    "platform": {
      "applicationId": "myApplicationId",
      "entityId": "myEntityId"
    },
    "conversations": {
      "enabled": true
    },
    "answers": {
      "enabled": true
    },
    "autoResponse": {
      "message": "Thank you for your message.",
      "sender": "MyAutoResponseSender",
      "deliveryTimeWindow": {
        "from": "08:35",
        "to": "16:35",
        "days": [
          "MONDAY",
          "TUESDAY",
          "WEDNESDAY",
          "THURSDAY",
          "FRIDAY"
        ],
        "deliveryTimeZone": "USER_TIME_ZONE"
      }
    },
    "blockListConfiguration": {
      "type": "UNBLOCK"
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.