INinfobip
platform
resources
resource-management

Manage inbound configuration

Create and update configuration details for incoming messages. Each action type and channel will require different parameters.

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

Request body

keywordstring

Omitting this value or sending <code>NULL</code> will set keyword to <code>NULL</code> because it is a valid keyword which will match all values.

usernamestring

Sets username that will be applied in appropriate actions.

unset7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553UnsetOption[]

Used for unsetting configuration options. <br /> <b>If a property appears both in unset, and in the body of the request, it will <u>FIRST</u> be removed, and then <u>UPDATED</u> with the value from the request body!</b>

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 request

{
  "keyword": "STARTKW",
  "username": "myusername",
  "unset": [
    "FORWARDING"
  ],
  "channel": "SMS"
}

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.