Skip to content

Modify Inbound Number

An inbound number instance resource represents a long number or short code purchased from TWILIO or NEXMO or CLICKATELL. The Modify Inbound Number API enables you to modify a new long number or a new short code in Engagement Services. Assume that a customers sends SMS like BAL to 53535, where 53535 is an inbound number and BAL is the inbound command. You can configure multiple commands for an inbound number.

URL

The HTTP URL for Modify Inbound Number API is:

http://<host>>:<<port>>/api/v1/twowaysms/number/<number-id>/modify

This service implements ‘Gateway Filter for Authentication’ to authenticate access of the service by a user.

Note: : Here, number ID refers to an ID that is used to map inbound number with internal data record.

Method

POST

The payload's request header includes Content-Type as application/json;charset=UTF-8.

Input Parameters

The following fields are input parameters:

Input Parameter Required Type Description
name Yes string A unique name assigned to the number such as Customer Banking Number
code Yes long Short code/ Long Number
description Optional string Description of the inbound number
replyForInvalidReq Optional string SMS to be sent for invalid requests that are sent to this number. If this field is left blank, then no reply SMS will be sent for invalid requests

Sample Request

{
   "name": "Balance Inquiry",
   "code": "57676",
   "description": "Balance inquiry portal",
   "replyForInvalidReq": "Invalid message, Please type BAL for balance enquiry"
}

Sample Response

{
"id" : "1",
"message" : "Details updated successfully"
}

Response Status

Code Description
Status 200 Details updated successfully
Status 400 An inbound number already exists with this name or code
Status 401 Unauthorized request
Status 500 Server failure to process request