Sign in

v1

latestOpenAPI 3.0.12026-07-2471135326.0 KB
Processes

Check Keyword Availability

post/i1/processes/users-by-keyword

Request body

keywordstring required

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

originstring required
<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>
connectionstring

<i>Optional.</i> Name of the Connection associated with the keyword being validated. All origin is related to a connection.

Example request

{
  "keyword": "key1",
  "origin": "123456",
  "connection": "CONNECTION"
}

Response

Successful Operation

itemsstring[]

Array of items.

Example response

{
  "meta": {
    "timestamp": 1597166699457,
    "transactionId": "70169d77-c165-4795-9932-35b8a3af96fb",
    "explain": "a descriptive text"
  }
}