Sign in

v1

latestOpenAPI 3.0.12026-07-2471135326.0 KB
Forwards

Update Forward Process

put/v1/forwards/{id}

Path parameters

idinteger required

Unique identifier of the forward process.

Request body

descriptionstring required

Description of the forward process.

activeboolean

<i>Optional.</i> <code>true</code>: Active the forward process to receive the MO messages. <p><code>false</code>: Disable the forward process to avoid receiving MO messages.</p> <p>By default the forward process is activated.</p>

responsestring

<i>Optional.</i> Type the message reply once the end user sends the MO message.

namestring required

Name of the forward process.

keywordsstring[] required

Word that people text to an SMS short or long code using their mobile phone.

externalIdstring
<p><i>Optional.</i> Alphanumeric identifier that can be used for reporting purposes. For instance, you could set the name or ID of the action that originated this SMS message so you can then identify where this API call is coming from.</p> <p>This is an identifier you can use to identify your messages uniquely. Typical applications are to assign a different identifier per message or per group of messages.</p>
channel' ' | 'SMS' | 'EMAIL'

<b><i>Required.</i></b> Select <code>SMS</code> as the Delivery channel where the MO message will be sent.

originsstring[]
<p><b><i>Required.</i></b> Specifies the Shortcode (from 1 to 6 digits), Longcode (from 7 digits on), an alphanumeric shortcode (ex. COMPANY) or a virtual number that will be used to originate and send the MO message.</p> <p><i>If you don't have one assigned yet please contact our support team to request one.</i></p>
connectionsstring[]

<i>Optional.</i> Name of the connection used by the end user when sending the MO message. All origin is related to a connection.

priorityinteger
<p><i>Optional.</i> Priority of the process over others for the same user.</p> <p>Priority set for the external web service within its group, the lower the value, the higher the priority.</p> <p>Default value is <code>500</code>.</p>
urlstring
<p><b><i>Required.</i></b> Indicate the webhook URL (Callback URL service) to receive the MO messages. That is, if you want to receive SMS messages from your contacts, you need to specify your endpoint and we will send inbound messages to you as soon as they are delivered to us by a mobile network operator.</p> <p>Your endpoint must have a <b>HTTP POST</b> access method and receive a JSON body.</p> <p>The URL is the external callback where the events of the forward process will be registered and published. To know the <b>parameters</b> sent to your callback URL once the end users begin to participate in your <b>SMS Broadcast (MO)</b> goes to the <a href='https://docs.messangi.com/docs/callback-url-mo'>Callback URL (MO)</a> section.</p>
prefixstring

<i>Optional.</i> Set the desired prefixes to associate with the same keyword.

extraInfoobject

<i>Optional.</i> This parameter can be used by the customer to enter and store additional information about the broadcast.<p>The extra info is additional information that customers can use, which will be sent in the transaction information to the customer's callback URL and the customer can use it as required. This additional information must be set in JSON format at key/value level.</p> <p><b>NOTE</b>: The additional information the customer sends through the API request will be reflected in the URL callback.</p>

Example request

{
  "description": "Process description",
  "active": true,
  "response": "You were unsubscribed successfully",
  "name": "Process name",
  "keywords": [
    "keyword"
  ],
  "externalId": "123456789",
  "channel": "SMS",
  "origins": [
    "CODE"
  ],
  "connections": [
    "CONNECTION_CODE"
  ],
  "priority": 500,
  "url": "http://www.mycallback.com",
  "prefix": "ABC",
  "queue": {
    "name": "queue",
    "exchange": "exchange"
  }
}

Response

Successful Operation

Example response

{
  "meta": {
    "timestamp": 1597166699457,
    "transactionId": "70169d77-c165-4795-9932-35b8a3af96fb",
    "explain": "a descriptive text"
  },
  "data": {
    "id": 10,
    "description": "Process description",
    "active": true,
    "response": "You were unsubscribed successfully",
    "name": "Process name",
    "keywords": [
      "keyword"
    ],
    "externalId": "123456789",
    "channel": "SMS",
    "origins": [
      "CODE"
    ],
    "connections": [
      "CONNECTION_CODE"
    ],
    "priority": 500,
    "url": "http://www.mycallback.com",
    "prefix": "ABC",
    "queue": {
      "name": "queue",
      "exchange": "exchange"
    },
    "owner": "root",
    "operator": "root"
  }
}