Sign in

v1

latestOpenAPI 3.0.12026-07-2471135326.0 KB
Processes

List Origin Forward Processes

get/i1/processes/{origin}

Path parameters

{"stackTrail":"paths:/i1/processes/{origin}:get:parameters:0:schema","oasType":"schema","type":"unknown"}
<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>

Query parameters

{"stackTrail":"paths:/i1/processes/{origin}:get:parameters:1:schema","oasType":"schema","type":"unknown"}

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

{"stackTrail":"paths:/i1/processes/{origin}:get:parameters:2:schema","oasType":"schema","type":"unknown"}

List of processes.

Response

Successful Operation

Example response

{
  "meta": {
    "timestamp": 1597166699457,
    "transactionId": "70169d77-c165-4795-9932-35b8a3af96fb",
    "explain": "a descriptive text"
  },
  "items": [
    {
      "id": 10,
      "name": "Process name",
      "externalId": "123456789",
      "type": "FORWARD",
      "owner": "root",
      "response": "You were unsubscribed successfully",
      "keywords": [
        "keyword"
      ],
      "operation": "REMOVE",
      "list": 300
    }
  ]
}