Manage inbound configuration

Create/Update configuration details. Parameters used vary depending on the action type.

Authorizations:

API Key Header

Basic

IBSSO Token Header

OAuth 2

Scopes:

numbers:manage

Request Body schema:

application/json

collapse all -

keyword

string [ 0 .. 50 ] characters

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

username

string [ 0 .. 255 ] characters ^(?!\s*$).+

Sets username that will be applied in appropriate actions.

unset

Array of strings

Items Enum: "USERNAME" "PLATFORM" "FORWARDING" "CONVERSATIONS" "AUTORESPONSE" "BLOCKLISTCONFIGURATION"

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

channel

required

string

Channel type.

numberKey

string

Required if number not present.

number

string

Required if numberKey not present.

countryCode

string ^[A-Z]{2}$

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

forwarding

object

Forwarding MO action.

type required	string Defines action type. It is not possible to create new action type. HTTP_FORWARD
url required	string Specifies URL where message will be pushed.
format	string Default: "MO_JSON_2" Specifies pushed content format.

conversations

object

Used for forwarding messages to Conversations service.

Find out more about Conversations

enabled

required

boolean

Flag which indicates if this action should be enabled. If set to false, the effect will be the same as adding the conversations to unset which will remove the object.

platform

object

Platform applicationId and entityId to apply to inbound messages that pair to this configuration. If not provided, or if set to default values (applicationId = default and entityId = null), values from the associated number/resource will be used.

Find out more about Application and Entity Management

applicationId	string [ 0 .. 255 ] characters Platform applicationId.
entityId	string [ 0 .. 255 ] characters Platform entityId.

autoResponse

object

Auto-response action configuration.

message

required

string [ 0 .. 1080 ] characters

Text that will be sent as a response message.

sender

string

If set, it will override the sender of the message in autoresponse sent to the user.

deliveryTimeWindow

object

Used to specify a time-window in which a response message is allowed to be sent. If not defined there is no limitation when message will be sent.

from required	string Exact time of day in which the sending can start. Consists of hour and minute properties, both mandatory. Time is expressed in the UTC time zone. Formatted as `HH:mm`.
to required	string Exact time of day in which the sending will end. Consists of an hour and minute properties, both mandatory. Time is expressed in the UTC time zone. Formatted as `HH:mm`.
days required	Array of strings [ 1 .. 7 ] items Items Enum: "MONDAY" "TUESDAY" "WEDNESDAY" "THURSDAY" "FRIDAY" "SATURDAY" "SUNDAY" Days which are included in the delivery time window.
deliveryTimeZone	string Enum: "USER_TIME_ZONE" "DESTINATION_TIME_ZONE" Sending time zone. If `null` is sent, `User time zone` will be set.

blockListConfiguration

object

Whitelist or blacklist the traffic of MT messages.

type required	string Enum: "BLOCK" "UNBLOCK" The type of block configuration. Defines whether you are configuring blocking (blacklisting) or unblocking (whitelisting) configuration.
level required	string Enum: "FROM_SENDER" "FROM_ANY_SENDER" The level of block configuration.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

429

Too Many Requests

500

Internal Server Error

Request samples

Content type

application/json

Example

Copy

Collapse all


{"keyword": "STARTKW",
"username": "myusername",
"unset": "FORWARDING",
"channel": "SMS",
"numberKey": "58BC6DB7966CB9F69A91EB956DF73239",
"number": "41793026727",
"countryCode": "GB",
"forwarding": 
{"type": "PULL"
},
"conversations": 
{"enabled": true
},
"platform": 
{"applicationId": "myApplicationId",
"entityId": "myEntityId"
},
"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",
"level": "FROM_SENDER"
}
}

Response samples

Content type

application/json

Copy

Collapse all


{"channel": "SMS",
"keyword": "STARTKW",
"username": "myusername",
"platform": 
{"applicationId": "myApplicationId",
"entityId": "myEntityId"
},
"forwarding": 
{"type": "PULL"
},
"conversations": 
{"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",
"level": "FROM_SENDER"
},
"configurationKey": "E9FCDCA496035F08EEA5933702EDF745"
}

Need assistance

Explore Infobip Tutorials

Encountering issues

Contact our support

What's new? Check out

Release Notes

Unsure about a term? See

Glossary

Research panel

Help shape the future of our products

Learn more

Service status

Privacy documents Terms of use