Create Forward Process

post

https://elastic.messangi.me/jacaerys/v1/forwards

Creates a Forward process that routes inbound keyword messages to an external URL or queue. Returns the process id used by the forward's get, update, pause, resume, and delete endpoints.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

description

string

required

Description of the forward process.

active

boolean

Optional. true: Active the forward process to receive the MO messages.

false: Disable the forward process to avoid receiving MO messages.

By default the forward process is activated.

response

string

Optional. Type the message reply once the end user sends the MO message.

name

string

required

Name of the forward process.

keywords

array of strings, unique

required

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

keywords*

externalId

string

Optional. 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.

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.

channel

string

enum

Required. Select SMS as the Delivery channel where the MO message will be sent.

Allowed:

origins

array of strings, unique

Required. 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.

If you don't have one assigned yet please contact our support team to request one.

origins

connections

array of strings, unique

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

connections

priority

int64

Optional. Priority of the process over others for the same user.

Priority set for the external web service within its group, the lower the value, the higher the priority.

Default value is 500.

url

string

Required. 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.

Your endpoint must have a HTTP POST access method and receive a JSON body.

The URL is the external callback where the events of the forward process will be registered and published. To know the parameters sent to your callback URL once the end users begin to participate in your SMS Broadcast (MO) goes to the Callback URL (MO) section.

prefix

string

Optional. Set the desired prefixes to associate with the same keyword.

queue

object

extraInfo

object

Optional. This parameter can be used by the customer to enter and store additional information about the broadcast.

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.

NOTE: The additional information the customer sends through the API request will be reflected in the URL callback.

Responses

201New FORWARD created

400Bad Request

403Forbidden

409Conflict

500Internal Server Error