KUkudosity
Numbers

Edit Number Options

Edit inbound options for a dedicated virtual number.

These options adjust behaviour for messages that are sent to this number.

post/edit-number-options.json

Request

  • Base URL
    https://api.transmitsms.com
  • Auth
    HTTP basic

Request body application/x-www-form-urlencoded

numberinteger required

Dedicated virtual number assigned to your account. A list of numbers on your account can be retrieved using get-numbers.

forward_emailstring

Forward incoming SMS to a set of email addresses. Emails can be comma separated.

forward_smsinteger

Forward incoming SMS to a set of mobile numbers. Numbers must be in international format. Can be comma separated.

forward_urlstring

Forward incoming messages to a callback URL.

list_idinteger

Add senders of incoming messages to this list.

welcome_messagestring

Auto responder for all messages received.

members_messagestring

Auto-response if the number is already on the list. Must be adding the number to a list.

Example request

{
  "number": 1234567890,
  "forward_email": "example1@example.com, example2@example.com",
  "forward_url": "http://example.com/callback",
  "list_id": 1234,
  "welcome_message": "Welcome to our service! Thank you for contacting us."
}

Response

OK

Example response

{
  "error": {
    "code": "SUCCESS",
    "description": "OK"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.